diff options
| author | Tom Faulhaber <git_net@infolace.com> | 2009-08-17 00:11:22 -0700 |
|---|---|---|
| committer | Tom Faulhaber <git_net@infolace.com> | 2009-08-17 00:11:22 -0700 |
| commit | 3ce40658ed003ba07d45f91e4e94a30d621274be (patch) | |
| tree | cbb1f3d063c792c2022321a31b6eb0132f0db431 | |
| parent | e69a3d7ade498c867d234949b22c885286b44fa6 (diff) | |
Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc9b9d
74 files changed, 838 insertions, 261 deletions
diff --git a/accumulators-api.html b/accumulators-api.html index 5251c035..06428623 100644 --- a/accumulators-api.html +++ b/accumulators-api.html @@ -1,6 +1,6 @@ <html> <head> - <title>clojure contrib - accumulators API reference</title> + <title>accumulators API reference (clojure.contrib)</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" /> @@ -108,6 +108,7 @@ accumulators.</pre> <br /> <h2>Public Variables and Functions</h2> <div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/add">add</h2> <span id="var-type">multimethod</span><br /> @@ -117,6 +118,7 @@ accumulators.</pre> an item depends on the type of the accumulator.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L30" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/add-items">add-items</h2> <span id="var-type">function</span><br /> @@ -125,6 +127,7 @@ an item depends on the type of the accumulator.</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/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L36" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/combine">combine</h2> <span id="var-type">multimethod</span><br /> @@ -134,6 +137,7 @@ an item depends on the type of the accumulator.</pre> single accumulator of the same type.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L41" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-counter">empty-counter</h2> <span id="var-type">var</span><br /> @@ -142,6 +146,7 @@ single accumulator of the same type.</pre> every item the number of times it was added.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L270" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-counter-with-total">empty-counter-with-total</h2> <span id="var-type">var</span><br /> @@ -151,6 +156,7 @@ 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/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L291" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-list">empty-list</h2> <span id="var-type">var</span><br /> @@ -158,6 +164,7 @@ value of the key :total.</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/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L87" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-map">empty-map</h2> <span id="var-type">var</span><br /> @@ -165,6 +172,7 @@ value of the key :total.</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/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L144" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-maximum">empty-maximum</h2> <span id="var-type">var</span><br /> @@ -172,6 +180,7 @@ value of the key :total.</pre> <pre id="var-docstr">An empty maximum accumulator. Only numbers can be added.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L184" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-mean-variance">empty-mean-variance</h2> <span id="var-type">var</span><br /> @@ -180,6 +189,7 @@ value of the key :total.</pre> sample variance. Only numbers can be added.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L231" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-min-max">empty-min-max</h2> <span id="var-type">var</span><br /> @@ -188,6 +198,7 @@ sample variance. Only numbers can be added.</pre> Only numbers can be added.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L206" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-minimum">empty-minimum</h2> <span id="var-type">var</span><br /> @@ -195,6 +206,7 @@ Only numbers can be added.</pre> <pre id="var-docstr">An empty minimum accumulator. Only numbers can be added.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L190" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-product">empty-product</h2> <span id="var-type">var</span><br /> @@ -202,6 +214,7 @@ Only numbers can be added.</pre> <pre id="var-docstr">An empty sum accumulator. Only numbers can be added.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L176" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-queue">empty-queue</h2> <span id="var-type">var</span><br /> @@ -209,6 +222,7 @@ Only numbers can be added.</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/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L101" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-set">empty-set</h2> <span id="var-type">var</span><br /> @@ -216,6 +230,7 @@ Only numbers can be added.</pre> <pre id="var-docstr">An empty set accumulator.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L115" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-string">empty-string</h2> <span id="var-type">var</span><br /> @@ -224,6 +239,7 @@ Only numbers can be added.</pre> appends it at the end.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L129" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-sum">empty-sum</h2> <span id="var-type">var</span><br /> @@ -231,6 +247,7 @@ appends it at the end.</pre> <pre id="var-docstr">An empty sum accumulator. Only numbers can be added.</pre> <a href="http://github.com/richhickey/clojure-contrib/blob/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L173" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-tuple">empty-tuple</h2> <span id="var-type">function</span><br /> @@ -242,6 +259,7 @@ 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/074963a22d9d8547ff5bb408191850e1760e364d/src/clojure/contrib/accumulators.clj#L309" id="var-source">Source</a> </div><div id="var-entry"> + <br /> <hr /> <h2 id="accumulators/empty-vector">empty-vector</h2> <span id="var-type">var</span><br /> diff --git a/agent-utils-api.html b/agent-utils-api.html index ec5538ab..b3b7422b 100644 --- a/agent-utils-api.html +++ b/agent-utils-api.html @@ -1,6 +1,6 @@ <html> <head> - <title>clojure contrib - agent-utils API reference</title> + <title>agent-utils API reference (clojure.contrib)</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" /> @@ -74,6 +74,7 @@ by <span id="author">Christophe Grande</span><br /> <br /> <h2>Public Variables and Functions</h2> <div id="var-entry"> + <br /> <hr /> <h2 id="agent-utils/capture-and-send">capture-and-send</h2> <span id="var-type">macro</span><br /> diff --git a/api-index.html b/api-index.html index 3dfdd9f2..e59e35e6 100644 --- a/api-index.html +++ b/api-index.html @@ -80,7 +80,7 @@ Shortcuts:<br /> <div id="index-body"> <h2><span id="section-head">A</span></h2> <pre> -<span id="section-content"> <a href="logging-api.html#*allow-direct-logging*">*allow-direct-logging*</a><span id="line-content"> var logging A boolean atom indicating whether direct logging (... +<span id="section-content"> <a href="logging-api.html#*allow-direct-logging*">*allow-direct-logging*</a><span id="line-content"> var logging A boolean indicating whether direct logging (as op... </span></span><span id="section-content"> <a href="duck-streams-api.html#*append-to-writer*">*append-to-writer*</a><span id="line-content"> var duck-streams If true, writer and spit will open files in append... </span></span><span id="section-content"> <a href="generic.math-functions-api.html#abs">abs</a><span id="line-content"> multimethod generic.math-functions Return the abs of x.. </span></span><span id="section-content"> <a href="math-api.html#abs">abs</a><span id="line-content"> function math (abs n) is the absolute value of n. @@ -97,6 +97,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="graph-api.html#add-loops">add-loops</a><span id="line-content"> function graph For each node n, add the edge n->n if not already ... </span></span><span id="section-content"> <a href="swing-utils-api.html#add-menu-item">add-menu-item</a><span id="line-content"> multimethod swing-utils Adds a menu item to the parent according to the it... </span></span><span id="section-content"> <a href="repl-utils-api.html#add-remote-javadoc">add-remote-javadoc</a><span id="line-content"> function repl-utils Adds to the list of remote Javadoc URLs. package-... +</span></span><span id="section-content"> <a href="logging-api.html#agent-write!">agent-write!</a><span id="line-content"> function logging Writes the message immediately, and ignores the fi... </span></span><span id="section-content"> <a href="greatest-least-api.html#all-greatest">all-greatest</a><span id="line-content"> function greatest-least Returns all the greatest elements.. </span></span><span id="section-content"> <a href="greatest-least-api.html#all-greatest-by">all-greatest-by</a><span id="line-content"> function greatest-least Return all the elements for which f yields the gre... </span></span><span id="section-content"> <a href="greatest-least-api.html#all-least">all-least</a><span id="line-content"> function greatest-least Returns all the least elements.. @@ -166,7 +167,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="combinatorics-api.html#combinations">combinations</a><span id="line-content"> function combinatorics All the unique ways of taking n different elements... </span></span><span id="section-content"> <a href="accumulators-api.html#combine">combine</a><span id="line-content"> multimethod accumulators Combine the values of the accumulators acc1 and ac... </span></span><span id="section-content"> <a href="find-namespaces-api.html#comment?">comment?</a><span id="line-content"> function find-namespaces Returns true if form is a (comment ...). -</span></span><span id="section-content"> <a href="logging-api.html#commons-logging">commons-logging</a><span id="line-content"> macro logging Creates a log-system struct using the Apache commo... +</span></span><span id="section-content"> <a href="logging-api.html#commons-logging">commons-logging</a><span id="line-content"> macro logging Defines the commons-logging-based implementations ... </span></span><span id="section-content"> <a href="pprint-api.html#compile-format">compile-format</a><span id="line-content"> function pprint Compiles format-str into a compiled format which c... </span></span><span id="section-content"> <a href="graph-api.html#component-graph">component-graph</a><span id="line-content"> function graph Given a graph, perhaps with cycles, return a reduc... </span></span><span id="section-content"> <a href="miglayout-api.html#components">components</a><span id="line-content"> function miglayout Returns a map from id (a keyword) to component for... @@ -224,7 +225,6 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="core-api.html#dissoc-in">dissoc-in</a><span id="line-content"> function core Dissociates an entry from a nested associative str... </span></span><span id="section-content"> <a href="probabilities.finite-distributions-api.html#dist-m">dist-m</a><span id="line-content"> var probabilities.finite-distributions Monad describing computations on f... </span></span><span id="section-content"> <a href="sql-api.html#do-commands">do-commands</a><span id="line-content"> function sql Executes SQL commands on the open database connect... -</span></span><span id="section-content"> <a href="logging-api.html#do-log">do-log</a><span id="line-content"> function logging Logs the message immediately if the specific loggi... </span></span><span id="section-content"> <a href="error-kit-api.html#do-not-handle">do-not-handle</a><span id="line-content"> macro error-kit Use in a tail position of a 'handle' form to indic... </span></span><span id="section-content"> <a href="sql-api.html#do-prepared">do-prepared</a><span id="line-content"> function sql Executes an (optionally parameterized) SQL prepare... </span></span><span id="section-content"> <a href="swing-utils-api.html#do-swing">do-swing</a><span id="line-content"> macro swing-utils Executes body in the Swing event thread asynchrono... @@ -342,7 +342,11 @@ Shortcuts:<br /> </div><div id="index-body"> <h2><span id="section-head">I</span></h2> <pre> -<span id="section-content"> <a href="monads-api.html#identity-m">identity-m</a><span id="line-content"> var monads Monad describing plain computations. This monad do... +<span id="section-content"> <a href="logging-api.html#*impl-name*">*impl-name*</a><span id="line-content"> var logging The name of the logging implementation used.. +</span></span><span id="section-content"> <a href="monads-api.html#identity-m">identity-m</a><span id="line-content"> var monads Monad describing plain computations. This monad do... +</span></span><span id="section-content"> <a href="logging-api.html#impl-enabled?">impl-enabled?</a><span id="line-content"> var logging Implementation-specific check if a particular leve... +</span></span><span id="section-content"> <a href="logging-api.html#impl-get-log">impl-get-log</a><span id="line-content"> var logging Returns an implementation-specific log by string n... +</span></span><span id="section-content"> <a href="logging-api.html#impl-write!">impl-write!</a><span id="line-content"> var logging Implementation-specific write of a log message. En... </span></span><span id="section-content"> <a href="import-static-api.html#import-static">import-static</a><span id="line-content"> macro import-static Imports the named static fields and/or static meth... </span></span><span id="section-content"> <a href="fcase-api.html#in-case">in-case</a><span id="line-content"> macro fcase Like case, but test expressions are sequences. Th... </span></span><span id="section-content"> <a href="seq-utils-api.html#includes?">includes?</a><span id="line-content"> function seq-utils Returns true if coll contains something equal (wit... @@ -360,7 +364,7 @@ Shortcuts:<br /> <pre> <span id="section-content"> <a href="json.read-api.html#*json-keyword-keys*">*json-keyword-keys*</a><span id="line-content"> var json.read If true, JSON object keys will be converted to key... </span></span><span id="section-content"> <a href="jar-api.html#jar-file?">jar-file?</a><span id="line-content"> function jar Returns true if file is a normal file with a .jar ... -</span></span><span id="section-content"> <a href="logging-api.html#java-logging">java-logging</a><span id="line-content"> macro logging Creates a log-system struct using the java.util.lo... +</span></span><span id="section-content"> <a href="logging-api.html#java-logging">java-logging</a><span id="line-content"> macro logging Defines the java-logging-based implementations of ... </span></span><span id="section-content"> <a href="repl-utils-api.html#javadoc">javadoc</a><span id="line-content"> function repl-utils Opens a browser window displaying the javadoc for ... </span></span><span id="section-content"> <a href="jmx-api.html#jmx->clj">jmx->clj</a><span id="line-content"> multimethod jmx Coerce JMX data structures into Clojure data. Hand... </span></span><span id="section-content"> <a href="jmx-api.html#jmx-url">jmx-url</a><span id="line-content"> function jmx Build a JMX URL from options.. @@ -376,8 +380,7 @@ Shortcuts:<br /> <h2><span id="section-head">L</span></h2> &l |