summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Heaps.html
diff options
context:
space:
mode:
Diffstat (limited to 'manuals/chickadee/Heaps.html')
-rw-r--r--manuals/chickadee/Heaps.html139
1 files changed, 139 insertions, 0 deletions
diff --git a/manuals/chickadee/Heaps.html b/manuals/chickadee/Heaps.html
new file mode 100644
index 0000000..8aea793
--- /dev/null
+++ b/manuals/chickadee/Heaps.html
@@ -0,0 +1,139 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- Copyright (C) 2017-2021 David Thompson davet@gnu.org
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+A copy of the license is included in the section entitled "GNU
+Free Documentation License".
+
+A copy of the license is also available from the Free Software
+Foundation Web site at http://www.gnu.org/licenses/fdl.html.
+
+
+* Chickadee: (chickadee). Game programming toolkit for Guile.
+
+The document was typeset with
+http://www.texinfo.org/ (GNU Texinfo).
+ -->
+<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Heaps (The Chickadee Game Toolkit)</title>
+
+<meta name="description" content="Heaps (The Chickadee Game Toolkit)">
+<meta name="keywords" content="Heaps (The Chickadee Game Toolkit)">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Data-Structures.html" rel="up" title="Data Structures">
+<link href="Quadtrees.html" rel="next" title="Quadtrees">
+<link href="Queues.html" rel="prev" title="Queues">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.indentedblock {margin-right: 0em}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+kbd {font-style: oblique}
+pre.display {font-family: inherit}
+pre.format {font-family: inherit}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+span.nolinebreak {white-space: nowrap}
+span.roman {font-family: initial; font-weight: normal}
+span.sansserif {font-family: sans-serif; font-weight: normal}
+ul.no-bullet {list-style: none}
+@media (min-width: 1140px) {
+ body {
+ margin-left: 14rem;
+ margin-right: 4rem;
+ max-width: 52rem;
+ }
+}
+
+@media (min-width: 800px) and (max-width: 1140px) {
+ body {
+ margin-left: 6rem;
+ margin-right: 4rem;
+ max-width: 52rem;
+ }
+}
+
+@media (max-width: 800px) {
+ body {
+ margin: 1rem;
+ }
+}
+
+-->
+</style>
+<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">
+
+
+</head>
+
+<body lang="en">
+<span id="Heaps"></span><div class="header">
+<p>
+Next: <a href="Quadtrees.html" accesskey="n" rel="next">Quadtrees</a>, Previous: <a href="Queues.html" accesskey="p" rel="prev">Queues</a>, Up: <a href="Data-Structures.html" accesskey="u" rel="up">Data Structures</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
+</div>
+<hr>
+<span id="Heaps-1"></span><h4 class="subsection">5.6.3 Heaps</h4>
+
+<p>The <code>(chickadee data heap)</code> module provides a binary heap data
+structure. The heap orders data from smallest to largest, according
+to a custom comparison predicate, making it a good choice for priority
+queues.
+</p>
+<dl>
+<dt id="index-make_002dheap">Procedure: <strong>make-heap</strong> <em>[#:&lt; &lt;]</em></dt>
+<dd><p>Return a new heap that uses the predicate <var>&lt;</var> to determine order.
+</p></dd></dl>
+
+<dl>
+<dt id="index-heap_003f">Procedure: <strong>heap?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is a heap.
+</p></dd></dl>
+
+<dl>
+<dt id="index-heap_002dempty_003f">Procedure: <strong>heap-empty?</strong> <em>heap</em></dt>
+<dd><p>Return <code>#t</code> if <var>heap</var> is empty.
+</p></dd></dl>
+
+<dl>
+<dt id="index-heap_002dsize">Procedure: <strong>heap-size</strong> <em>heap</em></dt>
+<dd><p>Return the current size of <var>heap</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-heap_002dmin">Procedure: <strong>heap-min</strong> <em>heap</em></dt>
+<dd><p>Return the minimum item in <var>heap</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-heap_002dinsert_0021">Procedure: <strong>heap-insert!</strong> <em>heap item</em></dt>
+<dd><p>Add <var>item</var> to <var>heap</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-heap_002dremove_0021">Procedure: <strong>heap-remove!</strong> <em>heap</em></dt>
+<dd><p>Remove the minimum item in <var>heap</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-heap_002dclear_0021">Procedure: <strong>heap-clear!</strong> <em>heap</em></dt>
+<dd><p>Remove all items from <var>heap</var>.
+</p></dd></dl>
+
+
+
+
+</body>
+</html>