diff options
author | Tom Faulhaber <git_net@infolace.com> | 2009-07-30 21:30:28 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2009-07-30 21:30:28 -0700 |
commit | 701e5d00a7053ed35825718b196dbfffb6d53825 (patch) | |
tree | e7afe8276fa280a65268b02f55e1d3fbe104a312 | |
parent | 8b80c49a4eae83d09003fcbfbe78c261398fb287 (diff) |
Updated documentation for commit acbd2097ddfbe5db48b486b6b706bdb59d412a69
70 files changed, 1404 insertions, 1379 deletions
diff --git a/accumulators-api.html b/accumulators-api.html index 946da228..04c1a76c 100644 --- a/accumulators-api.html +++ b/accumulators-api.html @@ -116,7 +116,7 @@ accumulators.</pre> </pre> <pre id="var-docstr">Add item to the accumulator acc. The exact meaning of adding an an item depends on the type of the accumulator.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L30" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L30" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/add-items">add-items</h2> @@ -124,7 +124,7 @@ an item depends on the type of the accumulator.</pre> <pre id="var-usage">Usage: (add-items acc items) </pre> <pre id="var-docstr">Add all elements of a collection coll to the accumulator acc.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L36" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L36" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/combine">combine</h2> @@ -133,7 +133,7 @@ an item depends on the type of the accumulator.</pre> </pre> <pre id="var-docstr">Combine the values of the accumulators acc1 and acc2 into a single accumulator of the same type.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L41" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L41" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-counter">empty-counter</h2> @@ -141,7 +141,7 @@ single accumulator of the same type.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">An empty counter accumulator. Its value is a map that stores for every item the number of times it was added.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L270" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L270" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-counter-with-total">empty-counter-with-total</h2> @@ -150,28 +150,28 @@ every item the number of times it was added.</pre> <pre id="var-docstr">An empty counter-with-total accumulator. It works like the counter accumulator, except that the total number of items added is stored as the value of the key :total.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L291" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L291" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-list">empty-list</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty list accumulator. Adding an item appends it at the beginning.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L87" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L87" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-map">empty-map</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty map accumulator. Items to be added must be [key value] pairs.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L144" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L144" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-maximum">empty-maximum</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty maximum accumulator. Only numbers can be added.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L184" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L184" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-mean-variance">empty-mean-variance</h2> @@ -179,7 +179,7 @@ value of the key :total.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">An empty mean-variance accumulator, combining sample mean and sample variance. Only numbers can be added.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L231" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L231" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-min-max">empty-min-max</h2> @@ -187,35 +187,35 @@ sample variance. Only numbers can be added.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">An empty min-max accumulator, combining minimum and maximum. Only numbers can be added.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L206" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L206" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-minimum">empty-minimum</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty minimum accumulator. Only numbers can be added.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L190" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L190" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-product">empty-product</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty sum accumulator. Only numbers can be added.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L176" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L176" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-queue">empty-queue</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty queue accumulator. Adding an item appends it at the end.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L101" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L101" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-set">empty-set</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty set accumulator.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L115" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L115" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-string">empty-string</h2> @@ -223,14 +223,14 @@ Only numbers can be added.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">An empty string accumulator. Adding an item (string or character) appends it at the end.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L129" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L129" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-sum">empty-sum</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty sum accumulator. Only numbers can be added.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L173" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L173" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-tuple">empty-tuple</h2> @@ -241,14 +241,14 @@ appends it at the end.</pre> as its value. Accumulator tuples consist of several accumulators that work in parallel. Added items must be sequences whose number of elements matches the number of sub-accumulators.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L309" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L309" id="var-source">Source</a> </div><div id="var-entry"> <hr /> <h2 id="accumulators/empty-vector">empty-vector</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">An empty vector accumulator. Adding an item appends it at the end.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj#L73" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj#L73" id="var-source">Source</a> </div> diff --git a/agent-utils-api.html b/agent-utils-api.html index 8cd142e9..da27a86e 100644 --- a/agent-utils-api.html +++ b/agent-utils-api.html @@ -85,7 +85,7 @@ them on the agent thread before executing the action. Example: (capture-and-send [*out*] a f b c)</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/agent_utils.clj#L22" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/agent_utils.clj#L22" id="var-source">Source</a> </div> diff --git a/api-index.html b/api-index.html index bd99bffd..9e806655 100644 --- a/api-index.html +++ b/api-index.html @@ -271,6 +271,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="java-utils-api.html#file">file</a><span id="line-content"> function java-utils Returns a java.io.File from string or file args.. </span></span><span id="section-content"> <a href="duck-streams-api.html#file-str">file-str</a><span id="line-content"> function duck-streams Concatenates args as strings and returns a java.io... </span></span><span id="section-content"> <a href="jar-api.html#filenames-in-jar">filenames-in-jar</a><span id="line-content"> function jar Returns a sequence of Strings naming the non-direc... +</span></span><span id="section-content"> <a href="seq-utils-api.html#fill-queue">fill-queue</a><span id="line-content"> function seq-utils filler-func will be called in another thread with ... </span></span><span id="section-content"> <a href="find-namespaces-api.html#find-clojure-sources-in-dir">find-clojure-sources-in-dir</a><span id="line-content"> function find-namespaces Searches recursively under dir for Clojure source ... </span></span><span id="section-content"> <a href="sql-api.html#find-connection">find-connection</a><span id="line-content"> function sql Returns the current database connection (or nil if... </span></span><span id="section-content"> <a href="seq-utils-api.html#find-first">find-first</a><span id="line-content"> function seq-utils Returns the first item of coll for which (pred ite... diff --git a/api-index.json b/api-index.json index a6f298e8..27c9bf5d 100644 --- a/api-index.json +++ b/api-index.json @@ -1,6 +1,6 @@ {"namespaces": [{"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/accumulators.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/accumulators.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/accumulators-api.html", "name":"clojure.contrib.accumulators", @@ -8,7 +8,7 @@ "doc": "A generic accumulator interface and implementations of various\naccumulators."}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/agent_utils.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/agent_utils.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/agent-utils-api.html", "name":"clojure.contrib.agent-utils", @@ -16,14 +16,14 @@ "doc": "Miscellaneous agent utilities\n(note to other contrib members: feel free to add to this lib)"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/classpath.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/classpath.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/classpath-api.html", "name":"clojure.contrib.classpath", "author":"Stuart Sierra", "doc":"Utilities for dealing with the JVM's classpath"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/combinatorics.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/combinatorics.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/combinatorics-api.html", "name":"clojure.contrib.combinatorics", @@ -31,7 +31,7 @@ "doc": "Efficient, functional algorithms for generating lazy\nsequences for common combinatorial functions. (See the source code \nfor a longer description.)"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/command_line.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/command_line.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/command-line-api.html", "name":"clojure.contrib.command-line", @@ -39,7 +39,7 @@ "doc": "Process command-line arguments according to a given cmdspec"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/complex_numbers.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/complex_numbers.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/complex-numbers-api.html", "name":"clojure.contrib.complex-numbers", @@ -47,14 +47,14 @@ "doc": "Complex numbers\nNOTE: This library is in evolution. Most math functions are\n not implemented yet."}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/cond.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/cond.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/cond-api.html", "name":"clojure.contrib.cond", "author":"Stephen C. Gilardi", "doc":"Extensions to the basic cond function."}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/condition.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/condition.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/condition-api.html", "name":"clojure.contrib.condition", @@ -62,7 +62,7 @@ "doc": "Flexible raising and handling of conditions:\n\nFunctions:\n\n raise: raises a condition\n handler-case: dispatches raised conditions to appropriate handlers\n print-stack-trace: prints abbreviated or full condition stack traces\n\nData:\n\n A condition is a map containing values for these keys:\n\n - :type, a condition type specifier, typically a keyword\n - :stack-trace, a stack trace to the site of the raise\n - :message, a human-readable message (optional)\n - :cause, a wrapped exception or condition (optional)\n - other keys given as arguments to raise (optional)\n\nNote: requires AOT compilation.\n\nBased on an idea from Chouser:\nhttp://groups.google.com/group/clojure/browse_frm/thread/da1285c538f22bb5"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/core.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/core.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/core-api.html", "name":"clojure.contrib.core", @@ -70,21 +70,21 @@ "doc": "Functions/macros variants of the ones that can be found in clojure.core \n(note to other contrib members: feel free to add to this lib)"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/dataflow.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/dataflow.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/dataflow-api.html", "name":"clojure.contrib.dataflow", "author":"Jeffrey Straszheim", "doc":"A library to support a dataflow model of state"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/datalog.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/datalog.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/datalog-api.html", "name":"clojure.contrib.datalog", "author":"Jeffrey Straszheim", "doc":"A Clojure implementation of Datalog"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/18c485c58f02e47b42e68f9e0d6ffec249b019ba/src/clojure/contrib/def.clj", + "http://github.com/richhickey/clojure-contrib/blob/acbd2097ddfbe5db48b486b6b706bdb59d412a69/src/clojure/contrib/def.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/def-api.html", "name":"clojure.contrib.def", @@ -92,7 +92,7 @@ "doc": "def.clj provides variants of def that make including doc strings and\nmaking private definitions more succinct."}, {"source-url": - "http://github.com/richhickey/clojure-contrib/ |