aboutsummaryrefslogtreecommitdiff
path: root/combinatorics-api.html
blob: 0e43dfeed23b538d11d734090ff8fd5474cde908 (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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<html>
  <head>
    <title>clojure contrib - combinatorics API reference</title>
    <link href="file/view/favicon.png" rel="icon" />
    <link href="file/view/favicon.png" rel="shortcut icon" />
    <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
    <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
    <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
    <!-- TODO: are we using these (from clojure.org)? If so, add the files -->
    <script src="file/view/code_highlighter.js" type="text/javascript"></script>
    <script src="file/view/clojure.js" type="text/javascript"></script>
    <style>.menuWrapper{height: 36px;}</style>
    <!--[if lte IE 6]>
    <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
    <![endif]-->
  </head>
<!--
This document was auto-generated from the clojure.contrib source by contrib-autodoc.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
  <body>
    <div id="AllContentContainer">
      <div id="Header">
	<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="file/view/clojure-icon.gif" /></a>
	<h1><a title="Clojure" href="index.html">Clojure</a></h1>
      </div>
      <div id="leftcolumn"><div><div style="text-align: center;"></div>
<div class="menu">
  <div class="WikiCustomNav WikiElement wiki">
    <a class="wiki_link" href="index.html">Overview</a><br />
    <a class="wiki_link" href="api-index.html">API Index</a><br />
    <a class="wiki_link" href="#">Namespaces:</a>
    <ul id="left-sidebar-list">
      <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
    </ul>
  </div>
</div>
</div></div>
      <div id="rightcolumn">
	<div id="Content">
	  <div class="contentBox"><div class="innerContentBox">
              <div style="" id="WikiAdMargin">
                <div id="content_view" class="wiki wikiPage">
                  <!-- Temporary disclaimer -->
                  <div style="background-color: #FF0000; font-weight: bold;">
                    NOTE: These autogen pages are still under development. 
                    Not all links work. Not all formatting is done.
                    Contact Tom Faulhaber (tomfaulhaber on github, gmail, etc.)
                    with any questions.
                  </div>
                  <div id="right-sidebar"><div><div id="toc">
  <h1 class="nopad">Table of Contents</h1>
  <div style="margin-left: 1em;" class="toc-section">
    <a href="#toc0">Overview</a>
    <div style="margin-left: 1em;" class="toc-entry">
      <a href="#combinatorics/cartesian-product">cartesian-product</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#combinatorics/combinations">combinations</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#combinatorics/lex-permutations">lex-permutations</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#combinatorics/permutations">permutations</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#combinatorics/selections">selections</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#combinatorics/subsets">subsets</a>
    </div>
    <br />
  </div>
</div>
</div></div>
                  <div id="content-tag"><div><h1 id="overview">API for <span id="namespace-name">combinatorics</span></h1>
by <span id="author">Mark Engelberg</span><br />
<br />Usage:
<pre>
(ns your-namespace
  (:require <span id="long-name">clojure.contrib.combinatorics</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Efficient, functional algorithms for generating lazy
sequences for common combinatorial functions. (See the source code 
for a longer description.)</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
  <hr />
  <h2 id="combinatorics/cartesian-product">cartesian-product</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (cartesian-product &amp; seqs)
</pre>
  <pre id="var-docstr">All the ways to take one item from each sequence</pre>
  <a href="http://github.com/richhickey/clojure-contrib/blob/47a2f69414f0c3ff90fb2fad4930d9af3d491d23/src/clojure/contrib/combinatorics.clj#L107" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="combinatorics/combinations">combinations</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (combinations items n)
</pre>
  <pre id="var-docstr">All the unique ways of taking n different elements from items</pre>
  <a href="http://github.com/richhickey/clojure-contrib/blob/47a2f69414f0c3ff90fb2fad4930d9af3d491d23/src/clojure/contrib/combinatorics.clj#L90" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="combinatorics/lex-permutations">lex-permutations</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (lex-permutations c)
</pre>
  <pre id="var-docstr">Fast lexicographic permutation generator for a sequence of numbers</pre>
  <a href="http://github.com/richhickey/clojure-contrib/blob/47a2f69414f0c3ff90fb2fad4930d9af3d491d23/src/clojure/contrib/combinatorics.clj#L151" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="combinatorics/permutations">permutations</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (permutations items)
</pre>
  <pre id="var-docstr">All the permutations of items, lexicographic by index</pre>
  <a href="http://github.com/richhickey/clojure-contrib/blob/47a2f69414f0c3ff90fb2fad4930d9af3d491d23/src/clojure/contrib/combinatorics.clj#L160" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="combinatorics/selections">selections</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (selections items n)
</pre>
  <pre id="var-docstr">All the ways of taking n (possibly the same) elements from the sequence of items</pre>
  <a href="http://github.com/richhickey/clojure-contrib/blob/47a2f69414f0c3ff90fb2fad4930d9af3d491d23/src/clojure/contrib/combinatorics.clj#L127" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="combinatorics/subsets">subsets</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (subsets items)
</pre>
  <pre id="var-docstr">All the subsets of items</pre>
  <a href="http://github.com/richhickey/clojure-contrib/blob/47a2f69414f0c3ff90fb2fad4930d9af3d491d23/src/clojure/contrib/combinatorics.clj#L101" id="var-source">Source</a>
</div>


</div></div>
                </div>
              </div>
            </div>
          </div>
	</div>
	<div id="foot">
	  <div style="text-align: center;">
            Copyright 2008-2009 Rich Hickey and the various contributors
          </div>
	</div>
      </div>
      <!-- /rightcolumn -->
      <div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.</div>
    </div>
    <!-- /AllContentContainer -->
  </body>

</html>