summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Heaps.html
blob: effdb8933e784df1dbb9f5b64f63388fd7ba2f10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!--  Copyright (C) 2017-2023  David Thompson dthompson2@worcester.edu

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">
&lt;!--
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;
    }
}

--&gt;
</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>