[clojure-contrib] r949 committed - Remove obsolete doc file, now moved too github pages.

[codesite...@google.com]

Revision: 949
Author: tomfaulhaber
Date: Wed Aug 12 10:14:14 2009
Log: Remove obsolete doc file, now moved too github pages.

http://code.google.com/p/clojure-contrib/source/detail?r=949

Deleted:
/wiki/AccumulatorsApiDoc.wiki
/wiki/AgentUtilsApiDoc.wiki
/wiki/ApiDocIndex.json
/wiki/ApiDocIndex.wiki
/wiki/ApiDocSidebar.wiki
/wiki/ClasspathApiDoc.wiki
/wiki/CombinatoricsApiDoc.wiki
/wiki/CommandLineApiDoc.wiki
/wiki/ComplexNumbersApiDoc.wiki
/wiki/CondApiDoc.wiki
/wiki/ConditionApiDoc.wiki
/wiki/CondtApiDoc.wiki
/wiki/CoreApiDoc.wiki
/wiki/DataflowApiDoc.wiki
/wiki/DatalogApiDoc.wiki
/wiki/DefApiDoc.wiki
/wiki/DuckStreamsApiDoc.wiki
/wiki/ErrorKitApiDoc.wiki
/wiki/ExceptApiDoc.wiki
/wiki/FcaseApiDoc.wiki
/wiki/FindNamespacesApiDoc.wiki
/wiki/FnmapApiDoc.wiki
/wiki/GenHtmlDocsApiDoc.wiki
/wiki/GenericArithmeticApiDoc.wiki
/wiki/GenericCollectionApiDoc.wiki
/wiki/GenericComparisonApiDoc.wiki
/wiki/GenericFunctorApiDoc.wiki
/wiki/GenericMathFunctionsApiDoc.wiki
/wiki/GraphApiDoc.wiki
/wiki/GreatestLeastApiDoc.wiki
/wiki/HttpAgentApiDoc.wiki
/wiki/HttpConnectionApiDoc.wiki
/wiki/ImportStaticApiDoc.wiki
/wiki/JarApiDoc.wiki
/wiki/JavaUtilsApiDoc.wiki
/wiki/JavadocBrowseApiDoc.wiki
/wiki/JsonReadApiDoc.wiki
/wiki/JsonWriteApiDoc.wiki
/wiki/LazySeqsApiDoc.wiki
/wiki/LazyXmlApiDoc.wiki
/wiki/MacroUtilsApiDoc.wiki
/wiki/MacrosApiDoc.wiki
/wiki/MapUtilsApiDoc.wiki
/wiki/MathApiDoc.wiki
/wiki/MiglayoutApiDoc.wiki
/wiki/MmapApiDoc.wiki
/wiki/MonadsApiDoc.wiki
/wiki/NsUtilsApiDoc.wiki
/wiki/PprintApiDoc.wiki
/wiki/ProbabilitiesFiniteDistributionsApiDoc.wiki
/wiki/ProbabilitiesMonteCarloApiDoc.wiki
/wiki/ProbabilitiesRandomNumbersApiDoc.wiki
/wiki/ProfileApiDoc.wiki
/wiki/PrxmlApiDoc.wiki
/wiki/ReplLnApiDoc.wiki
/wiki/ReplUtilsApiDoc.wiki
/wiki/SeqUtilsApiDoc.wiki
/wiki/ServerSocketApiDoc.wiki
/wiki/SetApiDoc.wiki
/wiki/ShellOutApiDoc.wiki
/wiki/SingletonApiDoc.wiki
/wiki/SqlApiDoc.wiki
/wiki/StacktraceApiDoc.wiki
/wiki/StrUtils2ApiDoc.wiki
/wiki/StrUtilsApiDoc.wiki
/wiki/StreamUtilsApiDoc.wiki
/wiki/SwingUtilsApiDoc.wiki
/wiki/TemplateApiDoc.wiki
/wiki/TestIsApiDoc.wiki
/wiki/TraceApiDoc.wiki
/wiki/TypesApiDoc.wiki
/wiki/WalkApiDoc.wiki
/wiki/WithNsApiDoc.wiki
/wiki/ZipFilterApiDoc.wiki

=======================================
--- /wiki/AccumulatorsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,158 +0,0 @@
-#summary accumulators API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for accumulators=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.accumulators))
-}}}
-==Overview==
-<pre> A generic accumulator interface and implementations of various
-accumulators.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#add add] [#add-items add-items] [#combine combine] [#empty-counter
empty-counter] [#empty-counter-with-total empty-counter-with-total]
[#empty-list empty-list] [#empty-map empty-map] [#empty-maximum
empty-maximum] [#empty-mean-variance empty-mean-variance] [#empty-min-max
empty-min-max] [#empty-minimum empty-minimum] [#empty-product
empty-product] [#empty-queue empty-queue] [#empty-set empty-set]
[#empty-string empty-string] [#empty-sum empty-sum] [#empty-tuple
empty-tuple] [#empty-vector empty-vector]
-
-----
-===add===
-====multimethod====
-<pre>
-Usage: *(_add_ acc item)*
-</pre>
-<pre> Add item to the accumulator acc. The exact meaning of adding an
-an item depends on the type of the accumulator.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#30
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===add-items===
-====function====
-<pre>
-Usage: *(_add-items_ acc items)*
-</pre>
-<pre> Add all elements of a collection coll to the accumulator acc.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#36
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-items+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===combine===
-====multimethod====
-<pre>
-Usage: *(_combine_ & accs)*
-</pre>
-<pre> Combine the values of the accumulators acc1 and acc2 into a
-single accumulator of the same type.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#41
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=combine+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-counter===
-====var====
-<pre> An empty counter accumulator. Its value is a map that stores for
-every item the number of times it was added.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#270
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-counter+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-counter-with-total===
-====var====
-<pre> 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>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#291
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-counter-with-total+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-list===
-====var====
-<pre> An empty list accumulator. Adding an item appends it at the
beginning.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#87
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-list+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-map===
-====var====
-<pre> An empty map accumulator. Items to be added must be `[`key value`]`
pairs.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#144
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-map+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-maximum===
-====var====
-<pre> An empty maximum accumulator. Only numbers can be added.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#184
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-maximum+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-mean-variance===
-====var====
-<pre> An empty mean-variance accumulator, combining sample mean and
-sample variance. Only numbers can be added.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#231
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-mean-variance+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-min-max===
-====var====
-<pre> An empty min-max accumulator, combining minimum and maximum.
-Only numbers can be added.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#206
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-min-max+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-minimum===
-====var====
-<pre> An empty minimum accumulator. Only numbers can be added.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#190
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-minimum+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-product===
-====var====
-<pre> An empty sum accumulator. Only numbers can be added.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#176
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-product+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-queue===
-====var====
-<pre> An empty queue accumulator. Adding an item appends it at the
end.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#101
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-queue+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-set===
-====var====
-<pre> An empty set accumulator.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#115
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-set+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-string===
-====var====
-<pre> An empty string accumulator. Adding an item (string or character)
-appends it at the end.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#129
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-string+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-sum===
-====var====
-<pre> An empty sum accumulator. Only numbers can be added.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#173
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-sum+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-tuple===
-====function====
-<pre>
-Usage: *(_empty-tuple_ empty-accumulators)*
-</pre>
-<pre> Returns an accumulator tuple with the supplied empty-accumulators
-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>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#309
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-tuple+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty-vector===
-====var====
-<pre> An empty vector accumulator. Adding an item appends it at the
end.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#73
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty-vector+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/AgentUtilsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,40 +0,0 @@
-#summary agent-utils API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for agent-utils=
-by Christophe Grande
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.agent-utils))
-}}}
-==Overview==
-<pre> Miscellaneous agent utilities
-(note to other contrib members: feel free to add to this lib)</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#capture-and-send capture-and-send]
-
-----
-===capture-and-send===
-====macro====
-<pre>
-Usage: *(_capture-and-send_ vars agent action & args)*
-</pre>
-<pre> Capture the current value of the specified vars and rebind
-them on the agent thread before executing the action.
-
-Example:
- (capture-and-send `[``*`out`*``]` a f b c)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/agent_utils.clj#22
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=capture-and-send+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/ApiDocIndex.json Mon Jun 15 22:12:56 2009
+++ /dev/null
@@ -1,6410 +0,0 @@
-{"namespaces":
- [{"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc",
- "name":"clojure.contrib.accumulators",
- "author":"Konrad Hinsen",
- "doc":
- "A generic accumulator interface and implementations of
various\n accumulators."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/agent_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAgentUtilsApiDoc",
- "name":"clojure.contrib.agent-utils",
- "author":"Christophe Grande",
- "doc":
- "Miscellaneous agent utilities\n (note to other contrib members: feel
free to add to this lib)"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/classpath.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribClasspathApiDoc",
- "name":"clojure.contrib.classpath",
- "author":"Stuart Sierra",
- "doc":"Utilities for dealing with the JVM's classpath"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCombinatoricsApiDoc",
- "name":"clojure.contrib.combinatorics",
- "author":"Mark Engelberg",
- "doc":
- "Efficient, functional algorithms for generating lazy\nsequences for
common combinatorial functions. (See the source code \nfor a longer
description.)"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/command_line.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCommandLineApiDoc",
- "name":"clojure.contrib.command-line",
- "author":"Chris Houser",
- "doc":
- "Process command-line arguments according to a given cmdspec"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/complex_numbers.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribComplexNumbersApiDoc",
- "name":"clojure.contrib.complex-numbers",
- "author":"Konrad Hinsen",
- "doc":
- "Complex numbers\n NOTE: This library is in evolution. Most
math functions are\n not implemented yet."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/cond.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCondApiDoc",
- "name":"clojure.contrib.cond",
- "author":"Stephen C. Gilardi",
- "doc":"Extensions to the basic cond function."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc",
- "name":"clojure.contrib.condition",
- "author":"Stephen C. Gilardi",
- "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://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition/Condition.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionConditionApiDoc",
- "name":"clojure.contrib.condition.Condition"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition/example.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionExampleApiDoc",
- "name":"clojure.contrib.condition.example"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condt.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCondtApiDoc",
- "name":"clojure.contrib.condt",
- "author":"Stuart Sierra",
- "doc":"Generic case-like macro using template expressions"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCoreApiDoc",
- "name":"clojure.contrib.core",
- "author":"Laurent Petit (and others)",
- "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://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core/tests.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCoreTestsApiDoc",
- "name":"clojure.contrib.core.tests"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDataflowApiDoc",
- "name":"clojure.contrib.dataflow",
- "author":"Jeffrey Straszheim",
- "doc":"A library to support a dataflow model of state"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDatalogApiDoc",
- "name":"clojure.contrib.datalog",
- "author":"Jeffrey Straszheim",
- "doc":"A Clojure implementation of Datalog"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDatalogDatabaseApiDoc",
- "name":"clojure.contrib.datalog.database"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDatalogLiteralsApiDoc",
- "name":"clojure.contrib.datalog.literals"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDatalogMagicApiDoc",
- "name":"clojure.contrib.datalog.magic"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDatalogRulesApiDoc",
- "name":"clojure.contrib.datalog.rules"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/softstrat.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDatalogSoftstratApiDoc",
- "name":"clojure.contrib.datalog.softstrat"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDatalogUtilApiDoc",
- "name":"clojure.contrib.datalog.util"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDefApiDoc",
- "name":"clojure.contrib.def",
- "author":"Stephen C. Gilardi",
- "doc":
- "def.clj provides variants of def that make including doc strings
and\nmaking private definitions more succinct."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribDuckStreamsApiDoc",
- "name":"clojure.contrib.duck-streams",
- "author":"Stuart Sierra",
- "doc":
- "This file defines \"duck-typed\" I/O utility functions for
Clojure.\n The 'reader' and 'writer' functions will open and
return an\n instance of java.io.BufferedReader and
java.io.PrintWriter,\n respectively, for a variety of argument
types -- filenames as\n strings, URLs, java.io.File's,
etc. 'reader' even works on http\n URLs.\n\n Note:
this is not really \"duck typing\" as implemented in languages\n
like Ruby. A better name would have been
\"do-what-I-mean-streams\"\n or \"just-give-me-a-stream\", but
ducks are funnier."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribErrorKitApiDoc",
- "name":"clojure.contrib.error-kit",
- "author":"Chris Houser",
- "doc":
- "EXPERIMENTAL\nSystem for defining and using custom errors\nPlease
contact Chouser if you have any suggestions for better names\nor API
adjustments."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/except.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribExceptApiDoc",
- "name":"clojure.contrib.except",
- "author":"Stephen C. Gilardi",
- "doc":
- "Provides functions that make it easy to specify the class, cause,
and\nmessage when throwing an Exception or Error. The optional message
is\nformatted using clojure.core/format."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fcase.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribFcaseApiDoc",
- "name":"clojure.contrib.fcase",
- "author":"Stuart Sierra",
- "doc":
- "This file defines a generic \"case\" macro called \"fcase\" which
takes\nthe equality-testing function as an argument. It also defines
a\ntraditional \"case\" macro that tests using \"=\" and variants
that\ntest for regular expressions and class membership.\n\n\nNote
(December 23, 2008): This library has been supplanted by the\ninclusion of
\"condp\" in clojure.core as of Clojure SVN rev. 1180."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribFindNamespacesApiDoc",
- "name":"clojure.contrib.find-namespaces",
- "author":"Stuart Sierra",
- "doc":"Search for ns declarations in dirs, JARs, or CLASSPATH"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fnmap.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribFnmapApiDoc",
- "name":"clojure.contrib.fnmap",
- "author":"Stuart Sierra",
- "doc":
- "Maps that dispatch get/assoc to user-defined functions.\n\n Note:
requires AOT-compilation"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fnmap/PersistentFnMap.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribFnmapPersistentFnMapApiDoc",
- "name":"clojure.contrib.fnmap.PersistentFnMap"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/gen_html_docs.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGenHtmlDocsApiDoc",
- "name":"clojure.contrib.gen-html-docs",
- "author":"Craig Andera",
- "doc":
- "Generates a single HTML page that contains the documentation for\none
or more Clojure libraries."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/arithmetic.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGenericArithmeticApiDoc",
- "name":"clojure.contrib.generic.arithmetic",
- "author":"Konrad Hinsen",
- "doc":
- "Generic arithmetic interface\n This library defines generic
versions of + - * / as multimethods\n that can be defined for any
type. The minimal required \n implementations for a type are
binary + and * plus unary - and /.\n Everything else is derived
from these automatically. Explicit\n binary definitions for - and
/ can be provided for\n efficiency reasons."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGenericCollectionApiDoc",
- "name":"clojure.contrib.generic.collection",
- "author":"Konrad Hinsen",
- "doc":
- "Generic arithmetic interface\n This library defines generic
versions of common\n collection-related functions as multimethods
that can be\n defined for any type."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/comparison.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGenericComparisonApiDoc",
- "name":"clojure.contrib.generic.comparison",
- "author":"Konrad Hinsen",
- "doc":
- "Generic comparison interface\n This library defines generic
versions of = < > <= >= zero?\n as multimethods that can be
defined for any type. Of the\n greater/less-than relations, types
must minimally implement >."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/functor.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGenericFunctorApiDoc",
- "name":"clojure.contrib.generic.functor",
- "author":"Konrad Hinsen",
- "doc":"Generic functor interface (fmap)"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGenericMathFunctionsApiDoc",
- "name":"clojure.contrib.generic.math-functions",
- "author":"Konrad Hinsen",
- "doc":
- "Generic math function interface\n This library defines
generic versions of common mathematical\n functions such as sqrt
or sin as multimethods that can be\n defined for any type."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGraphApiDoc",
- "name":"clojure.contrib.graph",
- "author":"Jeffrey Straszheim",
- "doc":"Basic graph theory algorithms"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribGreatestLeastApiDoc",
- "name":"clojure.contrib.greatest-least",
- "author":"Vincent Foley",
- "doc":
- "Various functions for finding greatest and least values in a
collection"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/agent.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribHttpAgentApiDoc",
- "name":"clojure.contrib.http.agent",
- "doc":"Agent-based asynchronous HTTP client."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/connection.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribHttpConnectionApiDoc",
- "name":"clojure.contrib.http.connection",
- "doc":"Low-level HTTP client API around HttpURLConnection"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/import_static.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribImportStaticApiDoc",
- "name":"clojure.contrib.import-static",
- "author":"Stuart Sierra",
- "doc":"Import static Java methods/fields into Clojure"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/jar.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribJarApiDoc",
- "name":"clojure.contrib.jar",
- "author":"Stuart Sierra",
- "doc":"Utilities for working with Java JAR files"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribJavaUtilsApiDoc",
- "name":"clojure.contrib.java-utils",
- "author":
- "Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard,
Stuart Sierra",
- "doc":
- "A set of utilties for dealing with Java stuff like files and
properties.\n\n Design goals:\n\n (1) Ease-of-use. These APIs should be
convenient. Performance is secondary.\n\n (2) Duck typing. I hate having
to think about the difference between\n a string that names a file,
and a File. Ditto for a ton of other \n wrapper classes in the Java
world (URL, InternetAddress). With these\n APIs you should be able to
think about domain equivalence, not type\n equivalence.\n\n (3) No
bossiness. I am not marking any of these functions as private\n the
docstrings will tell you the intended usage but do what works for you.
\t\t\t\t\t\n\n Feedback welcome!\n\n If something in this module
violates the principle of least surprise, please \n let me (Stu) and the
Clojure community know via the mailing list.\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/javadoc/browse.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribJavadocBrowseApiDoc",
- "name":"clojure.contrib.javadoc.browse",
- "author":"Christophe Grand",
- "doc":"Start a web browser from Clojure"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/json/read.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribJsonReadApiDoc",
- "name":"clojure.contrib.json.read",
- "author":"Stuart Sierra",
- "doc":
- "JavaScript Object Notation (JSON) parser\n\n For more
information on JSON, see http://www.json.org/\n\n This library
parses data in JSON format. This is a fairly strict\n
implementation of JSON as described at json.org, not a
full-fledged\n JavaScript parser. JavaScript functions and
object constructors\n are not supported. Object field names must
be quoted strings; they\n may not be bare symbols.\n\n
If you want to convert map keys from strings to keywords, use\n
clojure.contrib.walk/keywordize-keys\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/json/write.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribJsonWriteApiDoc",
- "name":"clojure.contrib.json.write",
- "author":"Stuart Sierra",
- "doc":
- "JavaScript Object Notation (JSON) generator.\n\nThis library will
generate JSON from the following types:\n * nil\n * all primitives
(Boolean, Byte, Short, Integer, Long, Float, Double)\n * String (actually
any CharSequence)\n * java.util.Map (including Clojure maps)\n *
java.util.Collection (including Clojure vectors, lists, and sets)\n * Java
arrays\n\nYou can extend this library to handle new types by adding methods
to\nprint-json.\n\nThis library does NOT attempt to preserve round-trip
equality between\nJSON and Clojure data types. That is, if you write a JSON
string with\nthis library, then read it back with
clojure.contrib.json.read, you\nwon't necessarily get the exact same data
structure. For example,\nClojure sets are written as JSON arrays, which
will be read back as\nClojure vectors.\n\nIf you want indented output, try
the clojure-json library
at\nhttp://github.com/danlarkin/clojure-json\n\nThis implementation
attempts to follow the description of JSON at\n<http://json.org/>. Maps
become JSON objects, all other collections\nbecome JSON arrays. JSON
object keys are always converted to strings.\nWithin strings, all non-ASCII
characters are hexadecimal escaped.\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_seqs.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribLazySeqsApiDoc",
- "name":"clojure.contrib.lazy-seqs",
- "author":"Stephen C. Gilardi",
- "doc":
- "\n==== Lazy sequences ====\n\n primes - based on the \"naive\"
implemention described in [1] plus a\n small \"wheel\" which
eliminates multiples of 2, 3, 5, and\n 7 from consideration by
incrementing past them. Also inspired\n by code from Christophe
Grand in [2].\n\n fibs - all the Fibonacci numbers\n\n powers-of-2 - all
the powers of 2\n\n ==== Lazy sequence functions ====\n\n (rotations,
partition-all, shuffle, rand-elt moved to seq_utils.clj)\n (permutations
and combinations moved to combinatorics.clj)\n\n [1]
http://www.cs.hmc.edu/~oneill/papers/Sieve-JFP.pdf\n [2]
http://clj-me.blogspot.com/2008/06/primes.html\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_xml.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribLazyXmlApiDoc",
- "name":"clojure.contrib.lazy-xml",
- "author":"Chris Houser",
- "doc":"Functions to parse xml lazily and emit back to text."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMacroUtilsApiDoc",
- "name":"clojure.contrib.macro-utils",
- "author":"Konrad Hinsen",
- "doc":
- "Local macros and symbol macros\n\n Local macros are defined
by a macrolet form. They are usable only\n inside its body.
Symbol macros can be defined globally\n (defsymbolmacro) or
locally (symbol-macrolet). A symbol\n macro defines a form that
replaces a symbol during macro\n expansion. Function arguments
and symbols bound in let\n forms are not subject to symbol macro
expansion.\n\n Local macros are most useful in the definition of
the expansion\n of another macro, they may be used anywhere.
Global symbol\n macros can be used only inside a
with-symbol-macros form."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macros.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMacrosApiDoc",
- "name":"clojure.contrib.macros",
- "author":"Konrad Hinsen",
- "doc":"Various small macros"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/map_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMapUtilsApiDoc",
- "name":"clojure.contrib.map-utils",
- "author":"Jason Wolfe, Chris Houser",
- "doc":"Utilities for operating on Clojure maps."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMathApiDoc",
- "name":"clojure.contrib.math",
- "author":"Mark Engelberg",
- "doc":
- "Math functions that deal intelligently with the various\ntypes in
Clojure's numeric tower, as well as math functions\ncommonly found in
Scheme implementations.\n\nexpt - (expt x y) is x to the yth power, returns
an exact number\n if the base is an exact number, and the power is an
integer,\n otherwise returns a double.\nabs - (abs n) is the absolute
value of n\ngcd - (gcd m n) returns the greatest common divisor of m and
n\nlcm - (lcm m n) returns the least common multiple of m and n\n\nThe
behavior of the next three functions on doubles is consistent\nwith the
behavior of the corresponding functions\nin Java's Math library, but on
exact numbers, returns an integer.\n\nfloor - (floor n) returns the
greatest integer less than or equal to n.\n If n is an exact number, floor
returns an integer,\n otherwise a double.\nceil - (ceil n) returns the
least integer greater than or equal to n.\n If n is an exact number, ceil
returns an integer,\n otherwise a double.\nround - (round n) rounds to the
nearest integer.\n round always returns an integer. round rounds up for
values\n exactly in between two integers.\n\n\nsqrt - Implements the sqrt
behavior I'm accustomed to from PLT Scheme,\n specifically, if the input
is an exact number, and is a square\n of an exact number, the output will
be exact. The downside\n is that for the common case (inexact square
root), some extra\n computation is done to look for an exact square root
first.\n So if you need blazingly fast square root performance, and you\n
know you're just going to need a double result, you're better\n off
calling java's Math/sqrt, or alternatively, you could just\n convert your
input to a double before calling this sqrt function.\n If Clojure ever
gets complex numbers, then this function will\n need to be updated (so
negative inputs yield complex outputs).\nexact-integer-sqrt - Implements a
math function from the R6RS Scheme\n standard. (exact-integer-sqrt k)
where k is a non-negative integer,\n returns [s r] where k = s^2+r and k <
(s+1)^2. In other words, it\n returns the floor of the square root and
the "},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math/tests.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMathTestsApiDoc",
- "name":"clojure.contrib.math.tests"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMiglayoutApiDoc",
- "name":"clojure.contrib.miglayout",
- "author":"Stephen C. Gilardi",
- "doc":
- "Clojure support for the MiGLayout layout
manager\nhttp://www.miglayout.com/\n\nExample:\n\n
(use '[clojure.contrib.miglayout.test :as mlt :only ()])\n (dotimes [i 5]
(mlt/run-test i))\n\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/example.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMiglayoutExampleApiDoc",
- "name":"clojure.contrib.miglayout.example"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMiglayoutInternalApiDoc",
- "name":"clojure.contrib.miglayout.internal"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/test.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMiglayoutTestApiDoc",
- "name":"clojure.contrib.miglayout.test"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/mmap.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMmapApiDoc",
- "name":"clojure.contrib.mmap",
- "author":"Chris Houser",
- "doc":
- "Functions for memory-mapping files, plus some functions that use
a\nmmaped file for \"normal\" activies -- slurp, load-file, etc."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribMonadsApiDoc",
- "name":"clojure.contrib.monads",
- "author":"Konrad Hinsen",
- "doc":
- "This library contains the most commonly used monads as
well\n as macros for defining and using monads and useful
monadic\n functions."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribNsUtilsApiDoc",
- "name":"clojure.contrib.ns-utils",
- "author":"Stephen C. Gilardi",
- "doc":"Namespace utilities"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintApiDoc",
- "name":"clojure.contrib.pprint",
- "author":"Tom Faulhaber",
- "doc":
- "This module comprises two elements:\n1) A pretty printer for Clojure
data structures, implemented in the function \"pprint\"\n2) A Common Lisp
compatible format function, implemented as \"cl-format\" because\n
Clojure is using the name \"format\" for its own format.\n\nComplete
documentation is available on the wiki at the contrib google code site."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/ColumnWriter.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintColumnWriterApiDoc",
- "name":"clojure.contrib.pprint.ColumnWriter"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/PrettyWriter.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintPrettyWriterApiDoc",
- "name":"clojure.contrib.pprint.PrettyWriter"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/hexdump.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintExamplesHexdumpApiDoc",
- "name":"clojure.contrib.pprint.examples.hexdump"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/json.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintExamplesJsonApiDoc",
- "name":"clojure.contrib.pprint.examples.json",
- "author":"Tom Faulhaber (based on the version by Stuart Sierra)",
- "doc":
- "Pretty printing JavaScript Object Notation (JSON) generator.\n\nThis
is an example of using a pretty printer dispatch function to generate JSON
output"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/multiply.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintExamplesMultiplyApiDoc",
- "name":"clojure.contrib.pprint.examples.multiply"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/props.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintExamplesPropsApiDoc",
- "name":"clojure.contrib.pprint.examples.props"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/show_doc.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintExamplesShowDocApiDoc",
- "name":"clojure.contrib.pprint.examples.show-doc"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/xml.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintExamplesXmlApiDoc",
- "name":"clojure.contrib.pprint.examples.xml",
- "author":"Tom Faulhaber, based on the original by Stuart Sierra",
- "doc":
- "A version of prxml that uses a pretty print dispatch function."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/utilities.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPprintUtilitiesApiDoc",
- "name":"clojure.contrib.pprint.utilities"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribProbabilitiesFiniteDistributionsApiDoc",
- "name":"clojure.contrib.probabilities.finite-distributions",
- "author":"Konrad Hinsen",
- "doc":
- "Finite probability distributions\n This library defines a
monad for combining finite probability\n distributions."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/monte_carlo.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribProbabilitiesMonteCarloApiDoc",
- "name":"clojure.contrib.probabilities.monte-carlo",
- "author":"Konrad Hinsen",
- "doc":
- "Monte-Carlo method support\n\n Monte-Carlo methods transform
an input random number stream\n (usually having a continuous
uniform distribution in the\n interval [0, 1)) into a random
number stream whose distribution\n satisfies certain conditions
(usually the expectation value\n is equal to some desired
quantity). They are thus\n transformations from one probability
distribution to another one.\n\n This library represents a
Monte-Carlo method by a function that\n takes as input the state
of a random number stream with\n uniform distribution
(see\n clojure.contrib.probabilities.random-numbers) and returns
a\n vector containing one sample value of the desired
output\n distribution and the final state of the input random
number\n stream. Such functions are state monad values and can
be\n composed using operations defined in
clojure.contrib.monads."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/random_numbers.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribProbabilitiesRandomNumbersApiDoc",
- "name":"clojure.contrib.probabilities.random-numbers",
- "author":"Konrad Hinsen",
- "doc":
- "Random number streams\n\n This library provides random
number generators with a common\n stream interface. They all
produce pseudo-random numbers that are\n uniformly distributed in
the interval [0, 1), i.e. 0 is a\n possible value but 1 isn't.
For transformations to other\n distributions, see
clojure.contrib.probabilities.monte-carlo.\n\n At the moment, the
only generator provided is a rather simple\n linear congruential
generator."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/profile.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribProfileApiDoc",
- "name":"clojure.contrib.profile",
- "author":"Stuart Sierra",
- "doc":
- "Simple code profiling & timing measurement.\n\nWrap any section of
code in the prof macro, giving it a name, like this:\n\n (defn
my-function [x y]\n (let [sum (prof :addition (+ x
y))\n product (prof :multiplication (* x y))]\n
[sum product]))\n\nThe run your code in the profile macro, like
this:\n\n (profile (dotimes [i 10000] (my-function 3 4)))\n\nWhich
prints a report for each named section of code:\n\n Name
mean min max count sum\n addition
265 0 37000 10000 2655000\nmultiplication
274 0 53000 10000 2747000\n\nTimes are measured in
nanoseconds, to the maximum precision available\nunder the JVM. See the
function documentation for more details.\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/prxml.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribPrxmlApiDoc",
- "name":"clojure.contrib.prxml",
- "author":"Stuart Sierra",
- "doc":
- "Compact syntax for generating XML. See the documentation of \"prxml\"
\nfor details."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/repl_ln.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribReplLnApiDoc",
- "name":"clojure.contrib.repl-ln",
- "author":"Stephen C. Gilardi",
- "doc":
- "A repl with that provides support for lines and line numbers in
the\n input stream."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/repl_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribReplUtilsApiDoc",
- "name":"clojure.contrib.repl-utils",
- "author":"Chris Houser, Christophe Grand, Stephen Gilardi",
- "doc":"Utilities meant to be used interactively at the REPL"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/seq_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribSeqUtilsApiDoc",
- "name":"clojure.contrib.seq-utils",
- "author":"Stuart Sierra (and others)",
- "doc":"Sequence utilities for Clojure"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/server_socket.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribServerSocketApiDoc",
- "name":"clojure.contrib.server-socket",
- "author":"Craig McDaniel",
- "doc":"Server socket library - includes REPL on socket"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/set.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribSetApiDoc",
- "name":"clojure.contrib.set",
- "author":"Jason Wolfe",
- "doc":
- "Clojure functions for operating on sets (supplemental to
clojure.set)"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/shell_out.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribShellOutApiDoc",
- "name":"clojure.contrib.shell-out",
- "author":"Chris Houser",
- "doc":
- "Conveniently launch a sub-process providing to its stdin
and\ncollecting its stdout"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/singleton.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribSingletonApiDoc",
- "name":"clojure.contrib.singleton",
- "author":"Stuart Sierra",
- "doc":"Singleton functions"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/sql.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribSqlApiDoc",
- "name":"clojure.contrib.sql",
- "author":"Stephen C. Gilardi",
- "doc":
- "A Clojure interface to sql databases via jdbc\n\n See
clojure.contrib.sql.test for an example"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/sql/internal.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribSqlInternalApiDoc",
- "name":"clojure.contrib.sql.internal"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/sql/test.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribSqlTestApiDoc",
- "name":"clojure.contrib.sql.test"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/stacktrace.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribStacktraceApiDoc",
- "name":"clojure.contrib.stacktrace",
- "author":"Stuart Sierra",
- "doc":"Print Clojure-centric stack traces"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/str_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribStrUtilsApiDoc",
- "name":"clojure.contrib.str-utils",
- "author":"Stuart Sierra",
- "doc":"String utilities for Clojure"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/str_utils2.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribStrUtils2ApiDoc",
- "name":"clojure.contrib.str-utils2",
- "author":"Stuart Sierra",
- "doc":
- "This is a library of string manipulation functions. It\n is
intented as a replacement for clojure.contrib.str-utils.\n\n You cannot
(use 'clojure.contrib.str-utils2) because it defines\n functions with
the same names as functions in clojure.core.\n Instead, do
(require '[clojure.contrib.str-utils2 :as s]) \n or something
similar.\n\n Goals:\n 1. Be functional\n 2. String argument
first, to work with ->\n 3. Performance linear in string length\n\n
Some ideas are borrowed from\n
http://github.com/francoisdevlin/devlinsf-clojure-utils/"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/stream_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribStreamUtilsApiDoc",
- "name":"clojure.contrib.stream-utils",
- "author":"Konrad Hinsen",
- "doc":
- "Functions for setting up computational pipelines via data
streams.\n\n NOTE: This library is experimental. It may change
significantly\n with future release.\n\n This
library defines:\n - an abstract stream type, whose interface
consists of the\n multimethod stream-next\n - a macro
for implementing streams\n - implementations of stream
for\n 1) Clojure sequences, and vectors\n 2) nil,
representing an empty stream\n - tools for writing stream
transformers, including the\n monad stream-m\n -
various utility functions for working with streams\n\n Streams
are building blocks in the construction of computational\n
pipelines. A stream is represented by its current state plus\n a
function that takes a stream state and obtains the next item\n in
the stream as well as the new stream state. The state is\n
implemented as a Java class or a Clojure type (as defined by
the\n function clojure.core/type), and the function is provided
as an\n implementation of the multimethod stream-next for this
class or type.\n\n While setting up pipelines using this
mechanism is somewhat more\n cumbersome than using Clojure's lazy
seq mechanisms, there are a\n few advantages:\n - The
state of a stream can be stored in any Clojure data
structure,\n and the stream can be re-generated from it any
number of times.\n Any number of states can be stored this
way.\n - The elements of the stream are never cached, so keeping
a reference\n to a stream state does not incur an
uncontrollable memory penalty.\n\n Note that the stream mechanism
is thread-safe as long as the\n concrete stream implementations
do not use any mutable state.\n\n Stream transformers take any
number of input streams and produce one\n output stream. They are
typically written using the stream-m\n monad. In the definition
of a stream transformer, (pick s) returns\n the next value of
stream argument s, whereas pick-all returns the\n next value of
all stream arguments in the form of a vector."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/swing_utils.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribSwingUtilsApiDoc",
- "name":"clojure.contrib.swing-utils"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/template.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribTemplateApiDoc",
- "name":"clojure.contrib.template",
- "author":"Stuart Sierra",
- "doc":
- "Anonymous functions that pre-evaluate sub-expressions\n\n
This file defines macros for using template expressions. These
are\n useful for writing macros.\n\n A template is an
expression containing \"holes\" represented by the\n symbols _1,
_2, _3, and so on. (\"_\" is a synonym for \"_1\".)\n\n The
\"template\" macro is similar to #(). It returns an anonymous\n
function containing the body of the template. Unlike #() or
\"fn\",\n however, any expressions that do not have any holes
will be\n evaluated only once, at the time the function is
created, not every\n time the function is called.\n\n
Examples:\n\n Assume we have some big, slow
calculation.\n (defn think-hard []\n
(Thread/sleep 1000)\n 1000)\n\n With #(),
think-hard gets called every time.\n (time (doall (map #(+ %
(think-hard))\n (range 5))))\n =>
\"Elapsed time: 5001.33455 msecs\"\n => (1000 1001 1002 1003
1004)\n\n With a template, think-hard only gets called
once.\n (time (doall (map (template (+ _
(think-hard)))\n (range 5))))\n
=> \"Elapsed time: 1000.907326 msecs\"\n => (1000 1001 1002
1003 1004)\n\n There is also the do-template macro, which works
differently. It\n calls the same template multiple times,
filling in values, and puts\n it all inside a \"do\" block. It
will split up the values based on\n the number of holes in the
template.\n\n (do-template (foo _1
_2) :a :b :c :d)\n expands to: (do (foo :a :b)
(foo :c :d))\n\n (do-template (foo _1 _2 _3) 10 11 12 13 14
15)\n expands to: (foo 10 11 12) (foo 13 14 15)"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/test_is.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribTestIsApiDoc",
- "name":"clojure.contrib.test-is",
- "author":
- "Stuart Sierra, with contributions and suggestions by \nChas Emerick,
Allen Rohner, and Stuart Halloway",
- "doc":
- "Inspired by many Common Lisp test frameworks and clojure/test,\n
this file is a Clojure test framework.\n\n ASSERTIONS\n\n The core of
the library is the \"is\" macro, which lets you make\n assertions of any
arbitrary expression:\n\n (is (= 4 (+ 2 2)))\n (is (instance? Integer
256))\n (is (.startsWith \"abcde\" \"ab\"))\n\n You can type an \"is\"
expression directly at the REPL, which will\n print a message if it
fails.\n\n user> (is (= 5 (+ 2 2)))\n\n FAIL in (:1)\n
expected: (= 5 (+ 2 2))\n actual: (not (= 5 4))\n false\n\n
The \"expected:\" line shows you the original expression, and the\n
\"actual:\" shows you what actually happened. In this case, it\n shows
that (+ 2 2) returned 4, which is not = to 5. Finally, the\n \"false\"
on the last line is the value returned from the\n expression. The \"is\"
macro always returns the result of the\n inner expression.\n\n There
are two special assertions for testing exceptions. The\n \"(is (thrown?
c ...))\" form tests if an exception of class c is\n thrown:\n\n (is
(thrown? ArithmeticException (/ 1 0))) \n\n \"(is (thrown-with-msg? c
re ...))\" does the same thing and also\n tests that the message on the
exception matches the regular\n expression re:\n\n (is
(thrown-with-msg? ArithmeticException #\"Divide by
zero\"\n (/ 1 0)))\n\n DOCUMENTING TESTS\n\n
\"is\" takes an optional second argument, a string describing the\n
assertion. This message will be included in the error report.\n\n (is (=
5 (+ 2 2)) \"Crazy arithmetic\")\n\n In addition, you can document groups
of assertions with the\n \"testing\" macro, which takes a string followed
by any number of\n assertions. The string will be included in failure
reports.\n Calls to \"testing\" may be nested, and all of the strings
will be\n joined together with spaces in the final report, in a style\n
similar to RSpec <http://rspec.info/>\n\n (testing \"Arithmetic\"\n
(testing \"with positive integers\"\n (is (= 4 (+ 2 2)))\n (is
(= 7 (+ 3 4))))\n (testing \"with negative integers\"\n (is (= -4
(+ -2 -2)))\n (is (= -1 (+ 3 -4)))))\n\n Note that, unlike RSpec,
the \"testing\" macro may only be used\n INSIDE a \"deftest\" or
\"with-test\" form (see below).\n\n\n DEFINING TESTS\n\n There are two
ways to define tests. The \"with-test\" macro takes\n a defn or def form
as its first argument, followed by any number\n of assertions. The tests
will be stored as metadata on the\n definition.\n\n (with-test\n
(defn my-function [x y]\n (+ x y))\n (is (= 4 (my-function 2
2)))\n (is (= 7 (my-function 3 4))))\n\n As of Clojure SVN rev. 1221,
this does not work with defmacro.\n See
http://code.google.com/p/clojure/issues/detail?id=51\n\n The other way
lets you define tests separately from the rest of\n your code, even in a
different namespace:\n\n (deftest addition\n (is (= 4 (+ 2 2)))\n
(is (= 7 (+ 3 4))))\n\n (deftest subtraction\n (is (= 1 (- 4
3)))\n (is (= 3 (- 7 4))))\n\n This creates functions named
\"addition\" and \"subtraction\", which\n can be called like any other
function. Therefore, tests can be\n grouped and composed, in a style
similar to the test framework in\n Peter Seibel's \"Practical Common
Lisp\"\n
<http://www.gigamonkeys.com/book/practical-building-a-unit-test-framework.html>\n\n
(deftest arithmetic\n (addition)\n (subtraction))\n\n The names
of the nested tests will be joined in a list, like\n \"(arithmetic
addition)\", in failure reports. You can use nested\n tests to set up a
context shared by several tests.\n\n\n RUNNING TESTS\n\n Run tests with
the function \"(run-tests namespaces...)\":\n\n
(run-tests 'your.namespace 'some.other.namespace)\n\n If you don't
specify any namespaces, the current namespace is\n used. To run all
tests in all namespaces, use \"(run-all-tests)\".\n\n By default, these
functions will search for all tests defined in\n a namespace and run them
in an undefined order. However, if you\n are composing tests, as in the
\"arithmetic\" example above, you\n probably do not want the \"addition\"
and \"subtraction\" tests run\n separately. In that case, you must
define a special function\n named \"test-ns-hook\" that runs your tests
in the correct order:\n\n (defn test-ns-hook []\n
(arithmetic))\n\n\n OMITTING TESTS FROM PRODUCTION CODE\n\n You can
bind the variable \"*load-tests*\" to false when loading or\n compiling
code in production. This will prevent any tests from\n being created by
\"with-test\" or \"deftest\".\n\n\n FIXTURES (new)\n\n Fixtures allow
you to run code before and after tests, to set up\n the context in which
tests should be run.\n\n A fixture is just a function that calls another
function passed as\n an argument. It looks like this:\n\n (defn
my-fixture [f]\n Perform setup, establish bindings, whatever.\n
(f) Then call the function we were passed.\n Tear-down / clean-up
code here.\n )\n\n Fixtures are attached to namespaces in one of two
ways. \"each\"\n fixtures are run repeatedly, once for each test
function created\n with \"deftest\" or \"with-test\". \"each\" fixtures
are useful for\n establishing a consistent before/after state for each
test, like\n clearing out database tables.\n\n \"each\" fixtures can be
attached to the current namespace like this:\n (use-fixtures :each
fixture1 fixture2 ...)\n The fixture1, fixture2 are just functions like
the example above.\n They can also be anonymous functions, like this:\n
(use-fixtures :each (fn [f] setup... (f) cleanup...))\n\n The other kind
of fixture, a \"once\" fixture, is only run once,\n around ALL the tests
in the namespace. \"once\" fixtures are useful\n for tasks that only
need to be performed once, like establishing\n database connections, or
for time-consuming tasks.\n\n Attach \"once\" fixtures to the current
namespace like this:\n (use-fixtures :once fixture1 fixture2 ...)\n\n\n
SAVING TEST OUTPUT TO A FILE\n\n All the test reporting functions write
to the var *test-out*. By\n default, this is the same as *out*, but you
can rebind it to any\n PrintWriter. For example, it could be a file
opened with\n clojure.contrib.duck-streams/writer.\n\n\n EXTENDING
TEST-IS (ADVANCED)\n\n You can extend the behavior of the \"is\" macro by
defining new\n methods for the \"assert-expr\" multimethod. These
methods are\n called during expansion of the \"is\" macro, so they should
return\n quoted forms to be evaluated.\n\n You can plug in your own
test-reporting framework by rebinding\n the \"report\" function: (report
event)\n\n The 'event' argument is a map. It will always have a :type
key,\n whose value will be a keyword signaling the type of event
being\n reported. Standard events with :type value of :pass, :fail,
and\n :error are called when an assertion passes, fails, and throws
an\n exception, respectively. In that case, the event will also have\n
the following keys:\n\n :expected The form that was expected to be
true\n :actual A form representing what actually
occurred\n :message The string message given as an argument
to 'is'\n\n The \"testing\" strings will be a list in
\"*testing-contexts*\", and\n the vars being tested will be a list in
\"*testing-vars*\".\n\n Your \"report\" function should wrap any printing
calls in the\n \"with-test-out\" macro, which rebinds *out* to the
current value\n of *test-out*.\n\n For additional event types, see the
examples in the code.\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/test_is/tap.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribTestIsTapApiDoc",
- "name":"clojure.contrib.test-is.tap"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/trace.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribTraceApiDoc",
- "name":"clojure.contrib.trace",
- "author":"Stuart Sierra",
- "doc":
- "This file defines simple \"tracing\" macros to help you see what
your\ncode is doing."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/types.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribTypesApiDoc",
- "name":"clojure.contrib.types",
- "author":"Konrad Hinsen",
- "doc":"General and algebraic data types"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/walk.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribWalkApiDoc",
- "name":"clojure.contrib.walk",
- "author":"Stuart Sierra",
- "doc":
- "This file defines a generic tree walker for Clojure data\nstructures.
It takes any data structure (list, vector, map, set,\nseq), calls a
function on every element, and uses the return value\nof the function in
place of the original. This makes it fairly\neasy to write recursive
search-and-replace functions, as shown in\nthe examples.\n\nNote: \"walk\"
supports all Clojure data structures EXCEPT maps\ncreated with
sorted-map-by. There is no (obvious) way to retrieve\nthe sorting
function."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/with_ns.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribWithNsApiDoc",
- "name":"clojure.contrib.with-ns",
- "author":"Stuart Sierra",
- "doc":"Temporary namespace macro"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/zip_filter.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribZipFilterApiDoc",
- "name":"clojure.contrib.zip-filter",
- "author":"Chris Houser",
- "doc":
- "System for filtering trees and nodes generated by zip.clj in\ngeneral,
and xml trees in particular.\n"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/zip_filter/xml.clj",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribZipFilterXmlApiDoc",
- "name":"clojure.contrib.zip-filter.xml"}],
- "vars":
- [{"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#30",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#add",
- "namespace":"clojure.contrib.accumulators",
- "name":"add",
- "arglists":[["acc", "item"]],
- "doc":
- "Add item to the accumulator acc. The exact meaning of adding an\n an
item depends on the type of the accumulator."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#36",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#add-items",
- "namespace":"clojure.contrib.accumulators",
- "name":"add-items",
- "arglists":[["acc", "items"]],
- "doc":
- "Add all elements of a collection coll to the accumulator acc."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#41",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#combine",
- "namespace":"clojure.contrib.accumulators",
- "name":"combine",
- "arglists":[["&", "accs"]],
- "doc":
- "Combine the values of the accumulators acc1 and acc2 into a\n single
accumulator of the same type."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#270",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-counter",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-counter",
- "doc":
- "An empty counter accumulator. Its value is a map that stores for\n
every item the number of times it was added."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#291",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-counter-with-total",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-counter-with-total",
- "doc":
- "An empty counter-with-total accumulator. It works like the counter\n
accumulator, except that the total number of items added is stored as
the\n value of the key :total."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#87",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-list",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-list",
- "doc":
- "An empty list accumulator. Adding an item appends it at the
beginning."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#144",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-map",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-map",
- "doc":
- "An empty map accumulator. Items to be added must be [key value]
pairs."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#184",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-maximum",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-maximum",
- "doc":"An empty maximum accumulator. Only numbers can be added."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#231",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-mean-variance",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-mean-variance",
- "doc":
- "An empty mean-variance accumulator, combining sample mean and\n
sample variance. Only numbers can be added."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#206",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-min-max",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-min-max",
- "doc":
- "An empty min-max accumulator, combining minimum and maximum.\n Only
numbers can be added."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#190",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-minimum",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-minimum",
- "doc":"An empty minimum accumulator. Only numbers can be added."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#176",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-product",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-product",
- "doc":"An empty sum accumulator. Only numbers can be added."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#101",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-queue",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-queue",
- "doc":
- "An empty queue accumulator. Adding an item appends it at the end."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#115",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-set",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-set",
- "doc":"An empty set accumulator."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#129",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-string",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-string",
- "doc":
- "An empty string accumulator. Adding an item (string or character)\n
appends it at the end."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#173",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-sum",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-sum",
- "doc":"An empty sum accumulator. Only numbers can be added."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#309",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-tuple",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-tuple",
- "arglists":[["empty-accumulators"]],
- "doc":
- "Returns an accumulator tuple with the supplied empty-accumulators\n
as its value. Accumulator tuples consist of several accumulators that\n
work in parallel. Added items must be sequences whose number of
elements\n matches the number of sub-accumulators."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/accumulators.clj#73",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAccumulatorsApiDoc#empty-vector",
- "namespace":"clojure.contrib.accumulators",
- "name":"empty-vector",
- "doc":
- "An empty vector accumulator. Adding an item appends it at the end."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/agent_utils.clj#22",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribAgentUtilsApiDoc#capture-and-send",
- "namespace":"clojure.contrib.agent-utils",
- "name":"capture-and-send",
- "arglists":[["vars", "agent", "action", "&", "args"]],
- "doc":
- "Capture the current value of the specified vars and rebind \n them on
the agent thread before executing the action.\n \n Example:\n
(capture-and-send [*out*] a f b c)"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/classpath.clj#23",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribClasspathApiDoc#classpath",
- "namespace":"clojure.contrib.classpath",
- "name":"classpath",
- "arglists":[[]],
- "doc":
- "Returns a sequence of File objects of the elements on CLASSPATH."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/classpath.clj#30",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribClasspathApiDoc#classpath-directories",
- "namespace":"clojure.contrib.classpath",
- "name":"classpath-directories",
- "arglists":[[]],
- "doc":
- "Returns a sequence of File objects for the directories on classpath."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/classpath.clj#35",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribClasspathApiDoc#classpath-jarfiles",
- "namespace":"clojure.contrib.classpath",
- "name":"classpath-jarfiles",
- "arglists":[[]],
- "doc":
- "Returns a sequence of JarFile objects for the JAR files on
classpath."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#107",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCombinatoricsApiDoc#cartesian-product",
- "namespace":"clojure.contrib.combinatorics",
- "name":"cartesian-product",
- "arglists":[["&", "seqs"]],
- "doc":"All the ways to take one item from each sequence"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#90",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCombinatoricsApiDoc#combinations",
- "namespace":"clojure.contrib.combinatorics",
- "name":"combinations",
- "arglists":[["items", "n"]],
- "doc":
- "All the unique ways of taking n different elements from items"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#151",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCombinatoricsApiDoc#lex-permutations",
- "namespace":"clojure.contrib.combinatorics",
- "name":"lex-permutations",
- "arglists":[["c"]],
- "doc":
- "Fast lexicographic permutation generator for a sequence of numbers"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#160",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCombinatoricsApiDoc#permutations",
- "namespace":"clojure.contrib.combinatorics",
- "name":"permutations",
- "arglists":[["items"]],
- "doc":"All the permutations of items, lexicographic by index"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#127",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCombinatoricsApiDoc#selections",
- "namespace":"clojure.contrib.combinatorics",
- "name":"selections",
- "arglists":[["items", "n"]],
- "doc":
- "All the ways of taking n (possibly the same) elements from the
sequence of items"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#101",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCombinatoricsApiDoc#subsets",
- "namespace":"clojure.contrib.combinatorics",
- "name":"subsets",
- "arglists":[["items"]],
- "doc":"All the subsets of items"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/command_line.clj#91",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCommandLineApiDoc#with-command-line",
- "namespace":"clojure.contrib.command-line",
- "name":"with-command-line",
- "arglists":[["args", "desc", "cmdspec", "&", "body"]],
- "doc":"Bind locals to command-line args."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/cond.clj#18",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCondApiDoc#cond-let",
- "namespace":"clojure.contrib.cond",
- "name":"cond-let",
- "arglists":[["bindings", "&", "clauses"]],
- "doc":
- "Takes a binding-form and a set of test/expr pairs. Evaluates each
test\n one at a time. If a test returns logical true, cond-let evaluates
and\n returns expr with binding-form bound to the value of test and
doesn't\n evaluate any of the other tests or exprs. To provide a default
value\n either provide a literal that evaluates to logical true and is\n
binding-compatible with binding-form, or use :else as the test and don't\n
refer to any parts of binding-form in the expr. (cond-let binding-form)\n
returns nil."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#56",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#*_full-stack-traces_*",
- "namespace":"clojure.contrib.condition",
- "name":"*full-stack-traces*",
- "doc":
- "Bind to true to include clojure.{core,lang,main} frames in stack\n
traces"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#71",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#handler-case",
- "namespace":"clojure.contrib.condition",
- "name":"handler-case",
- "arglists":[["dispatch-fn", "&", "body"]],
- "doc":
- "Executes body in a context where raised conditions can be
handled.\n\n dispatch-fn accepts a raised condition (a map) and returns a
selector\n used to choose a handler. Commonly, dispatch-fn will be :type
to dispatch\n on the condition's :type value.\n\n Handlers are forms
within body:\n\n (handle key\n ...)\n\n If a condition is raised,
executes the body of the first handler whose\n key satisfies (isa?
selector key). If no handlers match, re-raises the\n condition.\n\n While
a handler is running, *condition* is bound to the condition being\n
handled and *selector* is bound to to the value returned by dispatch-fn\n
that matched the handler's key."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#128",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#print-stack-trace",
- "namespace":"clojure.contrib.condition",
- "name":"print-stack-trace",
- "arglists":[["x"]],
- "doc":
- "Prints a stack trace for a condition or Throwable. Skips frames for\n
classes in clojure.{core,lang,main} unless the *full-stack-traces* is\n
bound to logical true"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#60",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#raise",
- "namespace":"clojure.contrib.condition",
- "name":"raise",
- "arglists":[[], ["m"], ["key", "val", "&", "keyvals"]],
- "doc":
- "Raises a condition. With no arguments, re-raises the current
condition.\n With one argument (a map), raises the argument. With two or
more\n arguments, raises a map with keys and values from the arguments."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#106",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#stack-trace-info",
- "namespace":"clojure.contrib.condition",
- "name":"stack-trace-info",
- "doc":
- "Returns header, stack-trace, and cause info from conditions and\n
Throwables"},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condt.clj#31",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCondtApiDoc#condt",
- "namespace":"clojure.contrib.condt",
- "name":"condt",
- "arglists":[["expr", "&", "clauses"]],
- "doc":
- "expr is a template expression (see template), clauses are test/expr\n
pairs like cond. Evalautes the template on each test value, one at\n a
time. If a test returns logical true, condt evaluates the\n corresponding
expr and returns its value. If none of the tests are\n true, and there
are an odd number of clauses, the last clause is\n evaluated, otherwise
returns nil."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condt.clj#50",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCondtApiDoc#econdt",
- "namespace":"clojure.contrib.condt",
- "name":"econdt",
- "arglists":[["expr", "&", "clauses"]],
- "doc":"Like condt but throws Exception if no tests match."},
- {"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core.clj#30",
- "wiki-url":
- "http://code.google.com/p/clojure-contrib/wiki/ClojureContribCoreApiDoc#-?>",
- "namespace":"clojure.contrib.core",
- "name":"-?>",
- "arglists":[["x", "form"], ["x", "form", "&", "forms"]],
- "doc":
***The diff for this file has been truncated for email.***
=======================================
--- /wiki/ApiDocIndex.wiki Mon Jun 15 22:12:56 2009
+++ /dev/null
@@ -1,771 +0,0 @@
-#summary Index of documented functions and variables
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=Index of Functions and Variables=
-This page has an alphabetical index of all the documented functions and
variables
-in clojure.contrib.
-
-In a narrow browser window, you may want to collapse the sidebar (use
the "<<" link)
-to get more screen space for the index.
-
-Shortcuts:
-
- [#A A] [#B B] [#C C] [#D D] [#E E] [#F F] [#G
G] [#H H] [#I I] [#J J] [#K K] [#L L] [#M M]
-
- [#N N] [#O O] [#P P] [#Q Q] [#R R] [#S S] [#T
T] [#U U] [#V V] [#W W] [#X X] [#Y Y] [#Z Z]
-
- [#Other Other]
-
-==A==
-<pre>
-[DuckStreamsApiDoc#*_append-to-writer_* *append-to-writer*]
var duck-streams If true, writer and spit will open files in
append...
-[GenericMathFunctionsApiDoc#abs abs]
multimethod generic.math-functions Return the abs of x..
-[MathApiDoc#abs abs] function
math (abs n) is the absolute value of n.
-[GenericMathFunctionsApiDoc#acos acos]
multimethod generic.math-functions Return the acos of x..
-[SwingUtilsApiDoc#action-translation-table action-translation-table]
var swing-utils Translation table for the make-action
constructor..
-[AccumulatorsApiDoc#add add] multimethod
accumulators Add item to the accumulator acc. The exact meaning...
-[SwingUtilsApiDoc#add-action-listener add-action-listener]
function swing-utils Adds an ActionLister to component. When the
action...
-[ReplUtilsApiDoc#add-break-thread! add-break-thread!]
function repl-utils Add the given thread to break-threads so
that it w...
-[DataflowApiDoc#add-cell-watcher add-cell-watcher]
function dataflow Adds a watcher to a cell to respond to
changes of ...
-[DataflowApiDoc#add-cells add-cells] function
dataflow Given a collection of cells, add them to the dataf...
-[MiglayoutApiDoc#add-components add-components]
function miglayout.internal Adds components with constraints to a
container.
-[DatalogApiDoc#add-index add-index] function
datalog.database Adds an index to an empty relation named name.
-[AccumulatorsApiDoc#add-items add-items] function
accumulators Add all elements of a collection coll to the accum...
-[SwingUtilsApiDoc#add-key-typed-listener add-key-typed-listener]
function swing-utils Adds a KeyListener to component that only
responds...
-[ReplUtilsApiDoc#add-local-javadoc add-local-javadoc]
function repl-utils Adds to the list of local Javadoc paths..
-[GraphApiDoc#add-loops add-loops] function
graph For each node n, add the edge n->n if not already ...
-[SwingUtilsApiDoc#add-menu-item add-menu-item]
multimethod swing-utils Adds a menu item to the parent according to
the it...
-[DatalogApiDoc#add-relation add-relation] function
datalog.database Adds a relation to the database.
-[ReplUtilsApiDoc#add-remote-javadoc add-remote-javadoc]
function repl-utils Adds to the list of remote Javadoc URLs.
package-...
-[DatalogApiDoc#add-tuple add-tuple] function
datalog.database Two forms: `[`db relation-name tuple`]` adds tuple...
-[DatalogApiDoc#add-tuples add-tuples] function
datalog.database Adds a collection of tuples to the db, as (add-...
-[DatalogApiDoc#adorn-query adorn-query] function
datalog.magic Adorn a query.
-[DatalogApiDoc#adorn-rules-set adorn-rules-set] function
datalog.magic Adorns the given rules-set for the given query. (...
-[DatalogApiDoc#adorned-literal adorned-literal] multimethod
datalog.literals When passed a set of bound columns, returns the ad...
-[GreatestLeastApiDoc#all-greatest all-greatest]
function greatest-least Returns all the greatest elements..
-[GreatestLeastApiDoc#all-greatest-by all-greatest-by]
function greatest-least Return all the elements for which f yields
the gre...
-[GreatestLeastApiDoc#all-least all-least] function
greatest-least Returns all the least elements..
-[GreatestLeastApiDoc#all-least-by all-least-by]
function greatest-least Return all the elements for which f yields
the lea...
-[DatalogApiDoc#all-predicates all-predicates] function
datalog.rules Given a rules-set, return all defined predicates.
-[ZipFilterApiDoc#ancestors ancestors] function
zip-filter Returns a lazy sequence of all ancestors of locati...
-[DatalogApiDoc#any-match? any-match?] function
datalog.database Finds if there are any matching records for the pa...
-[DuckStreamsApiDoc#append-spit append-spit] function
duck-streams Like spit but appends to file..
-[DuckStreamsApiDoc#append-writer append-writer]
function duck-streams Like writer but opens file for appending.
Does no...
-[DatalogApiDoc#apply-rule apply-rule] function
datalog.rules Apply the rule against db-1, adding the results to...
-[TemplateApiDoc#apply-template apply-template] function
template Replaces `_`1, `_`2, `_`3, etc. in expr with
correspondi...
-[GenericMathFunctionsApiDoc#approx_= approx=]
function generic.math-functions Return true if the absolute value of
the diffe...
-[TestIsApiDoc#are are] macro
test-is Checks multiple assertions with a template express...
-[JavaUtilsApiDoc#as-file as-file] multimethod
java-utils Interpret a String or a java.io.File as a File. Bu...
-[JavaUtilsApiDoc#as-properties as-properties] function
java-utils Convert any seq of pairs to a java.utils.Propertie...
-[JavaUtilsApiDoc#as-str as-str] function
java-utils Returns the name or string representation of x.
-[JavaUtilsApiDoc#as-url as-url] multimethod
java-utils Coerces argument (URL, URI, or String) to a java.n...
-[GenericMathFunctionsApiDoc#asin asin]
multimethod generic.math-functions Return the asin of x..
-[TestIsApiDoc#assert-any assert-any] function
test-is Returns generic assertion code for any test, inclu...
-[TestIsApiDoc#assert-predicate assert-predicate] function
test-is Returns generic assertion code for any functional ...
-[GenericCollectionApiDoc#assoc assoc] multimethod
generic.collection Returns a new collection in which the values corre...
-[GenericMathFunctionsApiDoc#atan atan]
multimethod generic.math-functions Return the atan of x..
-[GenericMathFunctionsApiDoc#atan2 atan2]
multimethod generic.math-functions Return the atan2 of x and y..
-[ZipFilterApiDoc#attr attr] function
zip-filter.xml Returns the xml attribute named attrname, of the x...
-[ZipFilterApiDoc#attr_= attr=] function
zip-filter.xml Returns a query predicate that matches a node when...
-</pre>
-==B==
-<pre>
-[DuckStreamsApiDoc#*_buffer-size_* *buffer-size*]
var duck-streams Size, in bytes or characters, of the buffer
used w...
-[DuckStreamsApiDoc#*_byte-array-type_* *byte-array-type*]
var duck-streams Type object for a Java primitive byte
array..
-[ErrorKitApiDoc#bind-continue bind-continue] function
error-kit Special form to be used inside a 'with-handler'. ...
-[StrUtils2ApiDoc#blank? blank?] function
str-utils2 True if s is nil, empty, or contains only whitespa...
-[ReplUtilsApiDoc#break-threads break-threads] var
repl-utils Threads to stop when Ctrl-C is pressed. See 'add-...
-[MmapApiDoc#buffer-stream buffer-stream] function
mmap Returns an InputStream for a ByteBuffer, such as r...
-[DatalogApiDoc#build-atom build-atom] function
datalog.literals Returns an unevaluated expression (to be used in a...
-[DataflowApiDoc#build-dataflow build-dataflow] function
dataflow Given a collection of cells, build and return a da...
-[DatalogApiDoc#build-literal build-literal] multimethod
datalog.literals (Returns an unevaluated expression (to be used in ...
-[DatalogApiDoc#build-partial-tuple build-partial-tuple]
function datalog.magic Given a query and a set of bindings, build
a parti...
-[DatalogApiDoc#build-seed-bindings build-seed-bindings]
function datalog.literals Given a seed literal, already adorned and
in magic...
-[DatalogApiDoc#build-soft-strat-work-plan build-soft-strat-work-plan]
function datalog.softstrat Return a work plan for the given rules-set
and que...
-[DataflowApiDoc#build-source-cell build-source-cell]
function dataflow Builds a source cell.
-[DataflowApiDoc#build-standard-cell build-standard-cell]
function dataflow Builds a standard cell.
-[DataflowApiDoc#build-validator-cell build-validator-cell]
function dataflow Builds a validator cell.
-[DatalogApiDoc#build-work-plan build-work-plan] function
datalog Given a list of rules and a query, build a work pl...
-[StrUtils2ApiDoc#butlast butlast] function
str-utils2 Returns s without the last n characters. Returns ...
-</pre>
-==C==
-<pre>
-[PprintApiDoc#*_code-dispatch_* *code-dispatch*]
multimethod pprint The pretty print dispatch function for
pretty prin...
-[MonadsApiDoc#call-cc call-cc] function
monads A computation in the cont monad that calls functio...
-[AgentUtilsApiDoc#capture-and-send capture-and-send]
macro agent-utils Capture the current value of the specified
vars an...
-[CombinatoricsApiDoc#cartesian-product cartesian-product]
function combinatorics All the ways to take one item from each
sequence.
-[FcaseApiDoc#case case] macro
fcase Like cond, but test-value is compared against the ...
-[GenericMathFunctionsApiDoc#ceil ceil]
multimethod generic.math-functions Return the ceil of x..
-[MathApiDoc#ceil ceil] multimethod
math (ceil n) returns the least integer greater than or...
-[DataflowApiDoc#cell cell] macro
dataflow Build a standard cell, like this: (cell fred ...
-[ProbabilitiesFiniteDistributionsApiDoc#certainly
certainly] function
probabilities.finite-distributions Returns a distribution in which th...
-[ZipFilterApiDoc#children children] function
zip-filter Returns a lazy sequence of all immediate children ...
-[ZipFilterApiDoc#children-auto children-auto] function
zip-filter Returns a lazy sequence of all immediate children ...
-[StrUtilsApiDoc#chomp chomp] function
str-utils Removes all trailing newline \n or return \r chara...
-[StrUtils2ApiDoc#chomp chomp] function
str-utils2 Removes all trailing newline \n or return \r chara...
-[ProbabilitiesFiniteDistributionsApiDoc#choose
choose] function
probabilities.finite-distributions Construct a distribution from an e...
-[StrUtilsApiDoc#chop chop] function
str-utils Removes the last character of string..
-[StrUtils2ApiDoc#chop chop] function
str-utils2 Removes the last character of string..
-[PprintApiDoc#cl-format cl-format] function
pprint An implementation of a Common Lisp compatible form...
-[ClasspathApiDoc#classpath classpath] function
classpath Returns a sequence of File objects of the elements...
-[ClasspathApiDoc#classpath-directories classpath-directories]
function classpath Returns a sequence of File objects for the
directo...
-[ClasspathApiDoc#classpath-jarfiles classpath-jarfiles]
function classpath Returns a sequence of JarFile objects for
the JAR ...
-[FindNamespacesApiDoc#clojure-source-file? clojure-source-file?]
function find-namespaces Returns true if file is a normal file with
a .clj ...
-[FindNamespacesApiDoc#clojure-sources-in-jar
clojure-sources-in-jar] function find-namespaces Returns a
sequence of filenames ending in .clj fou...
-[StrUtils2ApiDoc#codepoints codepoints] function
str-utils2 Returns a sequence of integer Unicode code points ...
-[CombinatoricsApiDoc#combinations combinations]
function combinatorics All the unique ways of taking n different
elements...
-[AccumulatorsApiDoc#combine combine] multimethod
accumulators Combine the values of the accumulators acc1 and ac...
-[FindNamespacesApiDoc#comment? comment?] function
find-namespaces Returns true if form is a (comment ...).
-[PprintApiDoc#compile-format compile-format] function
pprint Compiles format-str into a compiled format which c...
-[GraphApiDoc#component-graph component-graph] function
graph Given a graph, perhaps with cycles, return a reduc...
-[MiglayoutApiDoc#component? component?] function
miglayout.internal Returns true if x is a java.awt.Component.
-[MiglayoutApiDoc#components components] function
miglayout Returns a map from id (a keyword) to component for...
-[TestIsApiDoc#compose-fixtures compose-fixtures] function
test-is Composes two fixture functions, creating a new fix...
-[DatalogApiDoc#compute-sip compute-sip] function
datalog.rules Given a set of bound column names, return an adorn...
-[ProbabilitiesFiniteDistributionsApiDoc#cond-dist-m
cond-dist-m] var
probabilities.finite-distributions Variant of the dist monad that can...
-[CondApiDoc#cond-let cond-let] macro
cond Takes a binding-form and a set of test/expr pairs....
-[ProbabilitiesFiniteDistributionsApiDoc#cond-prob
cond-prob] function
probabilities.finite-distributions Returns the conditional probabilit...
-[CondtApiDoc#condt condt] macro
condt expr is a template expression (see template), clau...
-[GenericCollectionApiDoc#conj conj] multimethod
generic.collection Returns a new collection resulting from adding all...
-[GenericMathFunctionsApiDoc#conjugate conjugate]
multimethod generic.math-functions Return the conjugate of x..
-[SqlApiDoc#connection connection] function
sql Returns the current database connection (or throws...
-[SqlApiDoc#connection_* connection*] function
sql.internal Returns the current database connection (or throws...
-[MacrosApiDoc#const const] macro
macros Evaluate the constant expression expr at compile t...
-[MiglayoutApiDoc#constraint? constraint?] function
miglayout.internal Returns true if x is not a keyword-item or compone...
-[MonadsApiDoc#cont-m cont-m] var
monads Monad describing computations in continuation-pass...
-[StrUtils2ApiDoc#contains? contains?] function
str-utils2 True if s contains the substring..
-[MiglayoutApiDoc#converter-ui converter-ui] function
miglayout.example Lays out and shows a Temperature Converter UI.
-[DuckStreamsApiDoc#copy copy] multimethod
duck-streams Copies input to output. Returns nil. Input may ...
-[GenericMathFunctionsApiDoc#cos cos]
multimethod generic.math-functions Return the cos of x..
-[SqlApiDoc#create-fruit create-fruit] function
sql.test Create a table.
-[ServerSocketApiDoc#create-repl-server create-repl-server]
function server-socket create a repl on a socket.
-[ServerSocketApiDoc#create-server create-server]
function server-socket Creates a server socket on port. Upon
accept, a ne...
-[SqlApiDoc#create-table create-table] function
sql Creates a table on the open database connection gi...
-</pre>
-==D==
-<pre>
-[DuckStreamsApiDoc#*_default-encoding_* *default-encoding*]
var duck-streams Name of the default encoding to use when
reading &...
-[DatalogApiDoc#database-counts database-counts] function
datalog.database Returns a map with the count of elements in each r...
-[DatalogApiDoc#database-merge database-merge] function
datalog.database Merges databases together.
-[DatalogApiDoc#database-merge-parallel database-merge-parallel]
function datalog.database Merges databases together in parallel.
-[DatalogApiDoc#datalog-relation datalog-relation]
function datalog.database Creates a relation.
-[SqlApiDoc#db-batchupdate-exception db-batchupdate-exception]
function sql.test Demonstrate a batch update exception.
-[SqlApiDoc#db-exception db-exception] function
sql.test Demonstrate rolling back a partially completed tra...
-[SqlApiDoc#db-get-tables db-get-tables] function
sql.test Demonstrate getting table info.
-[SqlApiDoc#db-grade-a db-grade-a] function
sql.test Print rows describing all grade a fruit (grade bet...
-[SqlApiDoc#db-grade-range db-grade-range] function
sql.test Print rows describing fruit that are within a grad...
-[SqlApiDoc#db-read db-read] function
sql.test Read the entire fruit table.
-[SqlApiDoc#db-read-all db-read-all] function
sql.test Return all the rows of the fruit table as a vector.
-[SqlApiDoc#db-rollback db-rollback] function
sql.test Demonstrate a rollback-only trasaction.
-[SqlApiDoc#db-sql-exception db-sql-exception] function
sql.test Demonstrate an sql exception.
-[SqlApiDoc#db-update db-update] function
sql.test Update two fruits as a transaction.
-[SqlApiDoc#db-update-appearance-cost db-update-appearance-cost]
function sql.test Update the appearance and cost of the named
fruit.
-[SqlApiDoc#db-update-or-insert db-update-or-insert] function
sql.test Updates or inserts a fruit.
-[SqlApiDoc#db-write db-write] function
sql.test Write initial values to the database as a transact...
-[MapUtilsApiDoc#deep-merge-with deep-merge-with]
function map-utils Like merge-with, but merges maps
recursively, appl...
-[TypesApiDoc#defadt defadt] macro
types Define an algebraic data type name by an exhaustiv...
-[DefApiDoc#defalias defalias] macro
def Defines an alias for a var: a new var with the sam...
-[ErrorKitApiDoc#deferror deferror] macro
error-kit Define a new error type.
-[DefApiDoc#defhinted defhinted] macro
def Defines a var with a type hint matching the class ...
-[DefApiDoc#defmacro- defmacro-] macro
def Same as defmacro but yields a private definition.
-[GenericArithmeticApiDoc#defmethod_* defmethod*]
macro generic.arithmetic Define a method implementation for the
multimethod...
-[MonadsApiDoc#defmonad defmonad] macro
monads Define a named monad by defining the monad operati...
-[MonadsApiDoc#defmonadfn defmonadfn] macro
monads Like defn, but for functions that use monad operat...
-[DefApiDoc#defnk defnk] macro
def Define a function accepting keyword arguments. Sym...
-[DefApiDoc#defonce- defonce-] macro
def Same as defonce but yields a private definition.
-[StreamUtilsApiDoc#defst defst] macro
stream-utils Define the stream transformer name by body. The...
-[StreamUtilsApiDoc#defstream defstream] macro
stream-utils Define object of the given type as a stream whose ...
-[DefApiDoc#defstruct- defstruct-] macro
def Same as defstruct but yields a private definition.
-[MacroUtilsApiDoc#defsymbolmacro defsymbolmacro]
macro macro-utils Define a symbol macro. Because symbol
macros are n...
-[MacroUtilsApiDoc#deftemplate deftemplate] macro
macro-utils Define a macro that expands into forms after repla...
-[TestIsApiDoc#deftest deftest] macro
test-is Defines a test function with no arguments. Test f...
-[TestIsApiDoc#deftest- deftest-] macro
test-is Like deftest but creates a private var..
-[TraceApiDoc#deftrace deftrace] macro
trace Use in place of defn; traces each call/return of t...
-[TypesApiDoc#deftype deftype] macro
types Define a data type by a type tag (a namespace-qual...
-[TypesApiDoc#deftype- deftype-] macro
types Same as deftype but the constructor is private..
-[DefApiDoc#defunbound defunbound] macro
def Defines an unbound var with optional doc string.
-[DefApiDoc#defunbound- defunbound-] macro
def Same as defunbound but yields a private definition.
-[DefApiDoc#defvar defvar] macro
def Defines a var with an optional intializer and doc ...
-[DefApiDoc#defvar- defvar-] macro
def Same as defvar but yields a private definition.
-[SqlApiDoc#delete-rows delete-rows] function
sql Deletes rows from a table. where-params is a vecto...
-[DatalogApiDoc#delta-literal delta-literal] function
datalog.literals Given a literal l, return a delta version.
-[GraphApiDoc#dependency-list dependency-list] function
graph Similar to a topological sort, this returns a vect...
-[ZipFilterApiDoc#descendants descendants] function
zip-filter Returns a lazy sequence of all descendants of loca...
-[NsUtilsApiDoc#dir dir] macro
ns-utils Prints a sorted directory of public vars in a name...
-[ProbabilitiesMonteCarloApiDoc#discrete discrete]
function probabilities.monte-carlo A discrete distribution, defined by
a map d...
-[PprintApiDoc#dispatch-json dispatch-json] multimethod
pprint.examples.json The dispatch function for printing objects as JS...
-[DataflowApiDoc#display-cell display-cell] multimethod
dataflow A 'readable' form of the cell.
-[DatalogApiDoc#display-literal display-literal] multimethod
datalog.literals Converts a struct representing a literal to a norm...
-[DatalogApiDoc#display-query display-query] function
datalog.rules Return a query in a readable format..
-[DatalogApiDoc#display-rule display-rule] function
datalog.rules Return the rule in a readable format..
-[GenericCollectionApiDoc#dissoc dissoc]
multimethod generic.collection Returns a new collection in which the
entries corr...
-[CoreApiDoc#dissoc-in dissoc-in] function
core Dissociates an entry from a nested associative str...
-[ProbabilitiesFiniteDistributionsApiDoc#dist-m
dist-m] var
probabilities.finite-distributions Monad describing computations on f...
-[SqlApiDoc#do-commands do-commands] function
sql Executes SQL commands on the open database connect...
-[MiglayoutApiDoc#do-layout do-layout] function
miglayout.internal Attaches a MigLayout layout manager to container a...
-[ErrorKitApiDoc#do-not-handle do-not-handle] macro
error-kit Use in a tail position of a 'handle' form to indic...
-[SqlApiDoc#do-prepared do-prepared] function
sql Executes an (optionally parameterized) SQL prepare...
-[SwingUtilsApiDoc#do-swing do-swing] macro
swing-utils Executes body in the Swing event thread asynchrono...
-[SwingUtilsApiDoc#do-swing_* do-swing*] function
swing-utils Runs thunk in the Swing event thread according to ...
-[SwingUtilsApiDoc#do-swing-and-wait do-swing-and-wait]
macro swing-utils Executes body in the Swing event thread
synchronou...
-[TemplateApiDoc#do-template do-template] macro
template Repeatedly evaluates template expr (in a do block)...
-[StrUtils2ApiDoc#dochars dochars] macro
str-utils2 bindings `=`> `[`name string`]` Repeatedly executes b...
-[StrUtils2ApiDoc#docodepoints docodepoints] macro
str-utils2 bindings `=`> `[`name string`]` Repeatedly executes b...
-[NsUtilsApiDoc#docs docs] macro
ns-utils Prints documentation for the public vars in a name...
-[MonadsApiDoc#domonad domonad] macro
monads Monad comprehension. Takes the name of a monad, a ...
-[SqlApiDoc#drop-fruit drop-fruit] function
sql.test Drop a table.
-[SqlApiDoc#drop-table drop-table] function
sql Drops a table on the open database connection give...
-</pre>
-==E==
-<pre>
-[ProfileApiDoc#*_enable-profiling_* *enable-profiling*]
var profile Set this to false before loading/compiling
to omit...
-[StacktraceApiDoc#e e] function
stacktrace REPL utility. Prints a brief stack trace for the ...
-[CondtApiDoc#econdt econdt] macro
condt Like condt but throws Exception if no tests match..
-[LazyXmlApiDoc#emit emit] function
lazy-xml Prints an <?xml?> declaration line, and then calls...
-[LazyXmlApiDoc#emit-element emit-element] function
lazy-xml Recursively prints as XML text the element struct ...
-[GenericCollectionApiDoc#empty empty] multimethod
generic.collection Returns an empty collection of the same kind as th...
-[AccumulatorsApiDoc#empty-counter empty-counter]
var accumulators An empty counter accumulator. Its value is
a map t...
-[AccumulatorsApiDoc#empty-counter-with-total
empty-counter-with-total] var accumulators An empty
counter-with-total accumulator. It works ...
-[AccumulatorsApiDoc#empty-list empty-list] var
accumulators An empty list accumulator. Adding an item appends ...
-[AccumulatorsApiDoc#empty-map empty-map] var
accumulators An empty map accumulator. Items to be added must b...
-[AccumulatorsApiDoc#empty-maximum empty-maximum]
var accumulators An empty maximum accumulator. Only numbers
can be ...
-[AccumulatorsApiDoc#empty-mean-variance empty-mean-variance]
var accumulators An empty mean-variance accumulator,
combining samp...
-[AccumulatorsApiDoc#empty-min-max empty-min-max]
var accumulators An empty min-max accumulator, combining
minimum an...
-[AccumulatorsApiDoc#empty-minimum empty-minimum]
var accumulators An empty minimum accumulator. Only numbers
can be ...
-[AccumulatorsApiDoc#empty-product empty-product]
var accumulators An empty sum accumulator. Only numbers can
be adde...
-[AccumulatorsApiDoc#empty-queue empty-queue]
var accumulators An empty queue accumulator. Adding an item
appends...
-[AccumulatorsApiDoc#empty-set empty-set] var
accumulators An empty set accumulator..
-[AccumulatorsApiDoc#empty-string empty-string]
var accumulators An empty string accumulator. Adding an item
(strin...
-[AccumulatorsApiDoc#empty-sum empty-sum] var
accumulators An empty sum accumulator. Only numbers can be adde...
-[AccumulatorsApiDoc#empty-tuple empty-tuple]
function accumulators Returns an accumulator tuple with the
supplied emp...
-[AccumulatorsApiDoc#empty-vector empty-vector]
var accumulators An empty vector accumulator. Adding an item
append...
-[DatalogApiDoc#ensure-relation ensure-relation] function
datalog.database If the database lacks the named relation, add it.
-[ErrorKitApiDoc#error error] function
error-kit Base type for all error-kit errors.
-[StrUtils2ApiDoc#escape escape] function
str-utils2 Escapes characters in string according to a cmap, ...
-[DataflowApiDoc#eval-cell eval-cell] multimethod
dataflow Evaluate a dataflow cell. Return `[`changed, old va...
-[MathApiDoc#exact-integer-sqrt exact-integer-sqrt] function
math (exact-integer-sqrt n) expects a non-negative inte...
-[GenericMathFunctionsApiDoc#exp exp]
multimethod generic.math-functions Return the exp of x..
-[ProbabilitiesMonteCarloApiDoc#exponential exponential]
function probabilities.monte-carlo Transform a sequence of uniform
random numb...
-[ReplUtilsApiDoc#expression-info expression-info]
function repl-utils Uses the Clojure compiler to analyze the
given s-e...
-[MathApiDoc#expt expt] multimethod
math (expt base pow) is base to the pow power. Returns ...
-</pre>
-==F==
-<pre>
-[ConditionApiDoc#*_full-stack-traces_* *full-stack-traces*]
var condition Bind to true to include
clojure.{core,lang,main} f...
-[MiglayoutApiDoc#fahrenheit fahrenheit] function
miglayout.example Converts a Celsius temperature to Fahrenheit. Inpu...
-[FcaseApiDoc#fcase fcase] macro
fcase Generic switch/case macro. 'fcase' is short for '...
-[LazySeqsApiDoc#fibs fibs] function
lazy-seqs Returns a lazy sequence of all the Fibonacci numbe...
-[JavaUtilsApiDoc#file file] function
java-utils Returns a java.io.File from string or file args..
-[TestIsApiDoc#file-position file-position] function
test-is Returns a vector `[`filename line-number`]` for the nt...
-[DuckStreamsApiDoc#file-str file-str] function
duck-streams Concatenates args as strings and returns a java.io...
-[JarApiDoc#filenames-in-jar filenames-in-jar] function
jar Returns a sequence of Strings naming the non-direc...
-[FindNamespacesApiDoc#find-clojure-sources-in-dir
find-clojure-sources-in-dir] function find-namespaces Searches
recursively under dir for Clojure source ...
-[SqlApiDoc#find-connection find-connection] function
sql Returns the current database connection (or nil if...
-[SqlApiDoc#find-connection_* find-connection*] function
sql.internal Returns the current database connection (or nil if...
-[SeqUtilsApiDoc#find-first find-first] function
seq-utils Returns the first item of coll for which (pred ite...
-[TemplateApiDoc#find-holes find-holes] function
template Recursively finds all symbols starting with `_` in f...
-[ReplUtilsApiDoc#find-javadoc-url find-javadoc-url]
function repl-utils Searches for a URL for the given class
name. Trie...
-[FindNamespacesApiDoc#find-namespaces-in-dir
find-namespaces-in-dir] function find-namespaces Searches dir
recursively for (ns ...) declarations...
-[FindNamespacesApiDoc#find-namespaces-in-jarfile
find-namespaces-in-jarfile] function find-namespaces Searches the
JAR file for Clojure source files con...
-[FindNamespacesApiDoc#find-namespaces-on-classpath
find-namespaces-on-classpath] function find-namespaces Searches
CLASSPATH (both directories and JAR files...
-[FindNamespacesApiDoc#find-ns-decls-in-dir find-ns-decls-in-dir]
function find-namespaces Searches dir recursively for (ns ...)
declarations...
-[FindNamespacesApiDoc#find-ns-decls-in-jarfile
find-ns-decls-in-jarfile] function find-namespaces Searches the
JAR file for Clojure source files con...
-[FindNamespacesApiDoc#find-ns-decls-on-classpath
find-ns-decls-on-classpath] function find-namespaces Searches
CLASSPATH (both directories and JAR files...
-[TemplateApiDoc#find-pure-exprs find-pure-exprs]
function template Recursively finds all sub-expressions in
form that...
-[TemplateApiDoc#find-symbols find-symbols] function
template Recursively finds all symbols in form..
-[GraphApiDoc#fixed-point fixed-point] function
graph Repeatedly apply fun to data until (equal old-data...
-[SeqUtilsApiDoc#flatten flatten] function
seq-utils Takes any nested combination of sequential things ...
-[TemplateApiDoc#flatten-map flatten-map] function
template Transforms a map into a vector like `[`key value key...
-[GenericMathFunctionsApiDoc#floor floor]
multimethod generic.math-functions Return the floor of x..
-[MathApiDoc#floor floor] multimethod
math (floor n) returns the greatest integer less than o...
-[GenericFunctorApiDoc#fmap fmap] multimethod
generic.functor Applies function f to each item in the data struct...
-[FnmapApiDoc#fnmap fnmap] function
fnmap Creates a fnmap, or functional map. A fnmap behav...
-[MiglayoutApiDoc#format-constraint format-constraint]
function miglayout.internal Returns a vector of vectors representing
one or mo...
-[MiglayoutApiDoc#format-constraints format-constraints]
function miglayout.internal Returns a string representing all the
constraints ...
-[PprintApiDoc#formatter formatter] macro
pprint Makes a function which can directly run format-in....
-[PprintApiDoc#formatter-out formatter-out] macro
pprint Makes a function which can directly run format-in....
-[SeqUtilsApiDoc#frequencies frequencies] function
seq-utils Returns a map from distinct items in coll to the n...
-[PprintApiDoc#fresh-line fresh-line] function
pprint Make a newline if the Writer is not already at the...
-[TestIsApiDoc#function? function?] function
test-is Returns true if argument is a function or a symbol...
-</pre>
-==G==
-<pre>
-[MathApiDoc#gcd gcd] function
math (gcd a b) returns the greatest common divisor of a...
-[GenHtmlDocsApiDoc#generate-documentation generate-documentation]
function gen-html-docs Returns a string which is the HTML
documentation f...
-[GenHtmlDocsApiDoc#generate-documentation-to-file
generate-documentation-to-file] function gen-html-docs Calls
generate-documentation on the libraries name...
-[GenericCollectionApiDoc#get get] multimethod
generic.collection Returns the element of coll referred to by key. Ea...
-[StrUtils2ApiDoc#get get] function
str-utils2 Gets the i'th character in string..
-[DatalogApiDoc#get-adorned-bindings get-adorned-bindings]
function datalog.literals Get the bindings from this adorned literal..
-[DatalogApiDoc#get-all-relations get-all-relations]
function datalog.softstrat Return a set of all relation names defined
in this...
-[DatalogApiDoc#get-base-predicate get-base-predicate]
function datalog.literals Get the base predicate from this predicate..
-[DataflowApiDoc#get-cell get-cell] function
dataflow Get the single cell named by name.
-[DataflowApiDoc#get-cells get-cells] function
dataflow Get all the cells named by name.
-[MiglayoutApiDoc#get-components get-components]
function miglayout.internal Returns a map from id to component for all
compone...
-[SqlApiDoc#get-connection get-connection] function
sql.internal Creates a connection to a database. db-spec is a m...
-[DatalogApiDoc#get-cs-from-vs get-cs-from-vs] multimethod
datalog.literals From a set of vars, get the columns.
-[GraphApiDoc#get-neighbors get-neighbors] function
graph Get the neighbors of a node..
-[NsUtilsApiDoc#get-ns get-ns] function
ns-utils Returns the namespace named by ns-sym or throws if...
-[DataflowApiDoc#get-old-value get-old-value] function
dataflow Looks up an old value.
-[TestIsApiDoc#get-possibly-unbound-var get-possibly-unbound-var]
function test-is Like var-get but returns nil if the var is
unbound...
-[DatalogApiDoc#get-relation get-relation] function
datalog.database Get a relation object by name.
-[DatalogApiDoc#get-self-bound-cs get-self-bound-cs]
multimethod datalog.literals Get the columns that are bound withing the
literal...
-[ReplUtilsApiDoc#get-source get-source] function
repl-utils Returns a string of the source code for the given ...
-[DataflowApiDoc#get-source-cells get-source-cells]
function dataflow Returns a collection of source cells from
the data...
-[JavaUtilsApiDoc#get-system-property get-system-property]
function java-utils Get a system property..
-[DataflowApiDoc#get-value get-value] function
dataflow Gets a value from the df matching the passed symbo...
-[DataflowApiDoc#get-value-from-cell get-value-from-cell]
function dataflow Given a cell, get its value.
-[DataflowApiDoc#get-values get-values] function
dataflow Gets a collection of values from the df by name.
-[DatalogApiDoc#get-vs-from-cs get-vs-from-cs] multimethod
datalog.literals From a set of columns, return the vars.
-[SingletonApiDoc#global-singleton global-singleton]
function singleton Returns a global singleton function. f is
a funct...
-[GreatestLeastApiDoc#greatest greatest] function
greatest-least Return the greatest argument..
-[GreatestLeastApiDoc#greatest-by greatest-by]
function greatest-least Return the argument for which f yields the
greates...
-[SeqUtilsApiDoc#group-by group-by] function
seq-utils Returns a sorted map of the elements of coll keyed...
-</pre>
-==H==
-<pre>
-[PprintApiDoc#*_html-compatible_* *html-compatible*]
var pprint.examples.xml If true, empty tags will have a space
before the ...
-[PrxmlApiDoc#*_html-compatible_* *html-compatible*]
var prxml If true, empty tags will have a space
before the c...
-[ErrorKitApiDoc#handle handle] function
error-kit Special form to be used inside a 'with-handler'. ...
-[ConditionApiDoc#handler-case handler-case] macro
condition Executes body in a context where raised conditions...
-[HttpAgentApiDoc#http-agent http-agent] function
http.agent Creates (and immediately returns) an Agent represe...
-[HttpConnectionApiDoc#http-connection http-connection]
function http.connection Opens an HttpURLConnection at the URL,
handled by ...
-</pre>
-==I==
-<pre>
-[MonadsApiDoc#identity-m identity-m] var
monads Monad describing plain computations. This monad do...
-[ImportStaticApiDoc#import-static import-static]
macro import-static Imports the named static fields and/or
static meth...
-[FcaseApiDoc#in-case in-case] macro
fcase Like case, but test expressions are sequences. Th...
-[TestIsApiDoc#inc-report-counter inc-report-counter]
function test-is Increments the named counter in
`*`report-counters`*`,...
-[SeqUtilsApiDoc#includes? includes?] function
seq-utils Returns true if coll contains something equal (wit...
-[SeqUtilsApiDoc#indexed indexed] function
seq-utils Returns a lazy sequence of `[`index, item`]` pairs, wh...
-[SqlApiDoc#insert-records insert-records] function
sql Inserts records into a table. records are maps fro...
-[SqlApiDoc#insert-records-fruit insert-records-fruit]
function sql.test Insert records, maps from keys specifying
columns ...
-[SqlApiDoc#insert-rows insert-rows] function
sql Inserts complete rows into a table. Each row is a ...
-[SqlApiDoc#insert-rows-fruit insert-rows-fruit] function
sql.test Insert complete rows.
-[SqlApiDoc#insert-values insert-values] function
sql Inserts rows into a table with values for specifie...
-[SqlApiDoc#insert-values-fruit insert-values-fruit] function
sql.test Insert rows with values for only specific columns.
-[FcaseApiDoc#instance-case instance-case] macro
fcase Like case, but the test expressions are Java class...
-[GenericCollectionApiDoc#into into] multimethod
generic.collection Returns a new coll consisting of to-coll with all ...
-[TestIsApiDoc#is is] macro
test-is Generic assertion macro. 'form' is any predicate ...
-[DatalogApiDoc#is-query-var? is-query-var?] function
datalog.util Is this a query variable: e.g. a symbol prefixed w...
-[SqlApiDoc#is-rollback-only is-rollback-only] function
sql Returns true if the outermost transaction will rol...
-[DatalogApiDoc#is-safe? is-safe?] function
datalog.rules Is the rule safe according to the datalog protocol...
-[DatalogApiDoc#is-var? is-var?] function
datalog.util Is this a logic variable: e.g. a symbol prefixed w...
-</pre>
-==J==
-<pre>
-[JsonReadApiDoc#*_json-keyword-keys_* *json-keyword-keys*]
var json.read If true, JSON object keys will be converted
to key...
-[JarApiDoc#jar-file? jar-file?] function
jar Returns true if file is a normal file with a .jar ...
-[ReplUtilsApiDoc#javadoc javadoc] function
repl-utils Opens a browser window displaying the javadoc for ...
-[StrUtils2ApiDoc#join join] function
str-utils2 Returns a string of all elements in coll, separate...
-[TestIsApiDoc#join-fixtures join-fixtures] function
test-is Composes a collection of fixtures, in order. Alwa...
-[DatalogApiDoc#join-literal join-literal] multimethod
datalog.literals Given a database (db), a literal (lit) and a seq o...
-[ProbabilitiesFiniteDistributionsApiDoc#join-with
join-with] function
probabilities.finite-distributions Returns the distribution of (f x y...
-[JsonWriteApiDoc#json-str json-str] function
json.write Converts x to a JSON-formatted string..
-[PprintApiDoc#json-str json-str] function
pprint.examples.json Converts x to a JSON-formatted string..
-</pre>
-==K==
-<pre>
-[DatalogApiDoc#keys-to-vals keys-to-vals] function
datalog.util Given a map and a collection of keys, return the c...
-[WalkApiDoc#keywordize-keys keywordize-keys] function
walk Recursively transforms all map keys from strings t...
-</pre>
-==L==
-<pre>
-[TestIsApiDoc#*_load-tests_* *load-tests*] var
test-is True by default. If set to false, no test functio...
-[ReplUtilsApiDoc#*_local-javadocs_* *local-javadocs*]
var repl-utils Ref to a list of local paths for
Javadoc-generated...
-[MiglayoutApiDoc#label label] function
miglayout.test Returns a swing label.
-[MapUtilsApiDoc#lazy-get lazy-get] macro
map-utils Like get, but doesn't evaluate not-found unless it...
-[GraphApiDoc#lazy-walk lazy-walk] function
graph Return a lazy sequence of the nodes of a graph sta...
-[ProbabilitiesRandomNumbersApiDoc#lcg lcg]
function probabilities.random-numbers Create a linear congruential
generator.
-[MathApiDoc#lcm lcm] function
math (lcm a b) returns the least common multiple of a a...
-[GreatestLeastApiDoc#least least] function
greatest-least Return the smallest element..
-[GreatestLeastApiDoc#least-by least-by] function
greatest-least Return the argument for which f yields the smalles...
-[ZipFilterApiDoc#left-locs left-locs] function
zip-filter Returns a lazy sequence of locations to the left o...
-[ZipFilterApiDoc#leftmost? leftmost?] function
zip-filter Returns true if there are no more nodes to the lef...
-[MacrosApiDoc#letfn- letfn-] macro
macros OBSOLETE: use clojure.core/letfn A variant of l...
-[CombinatoricsApiDoc#lex-permutations lex-permutations]
function combinatorics Fast lexicographic permutation generator
for a seq...
-[DatalogApiDoc#literal-appropriate? literal-appropriate?]
multimethod datalog.literals When passed a set of bound vars, determines
if thi...
-[DatalogApiDoc#literal-columns literal-columns] multimethod
datalog.literals Return the column names this applies to.
-[DatalogApiDoc#literal-magic? literal-magic?] function
datalog.literals Is this literal magic?.
-[DatalogApiDoc#literal-predicate literal-predicate]
multimethod datalog.literals Return the predicate/relation this
conditional ope...
-[DatalogApiDoc#literal-vars literal-vars] multimethod
datalog.literals Returns the logic vars used by this literal.
-[GenericMathFunctionsApiDoc#log log]
multimethod generic.math-functions Return the log of x..
-[ProbabilitiesMonteCarloApiDoc#lognormal lognormal]
function probabilities.monte-carlo Transform a sequence of uniform
random numb...
-[StrUtils2ApiDoc#lower-case lower-case] function
str-utils2 Converts string to all lower-case..
-[StrUtils2ApiDoc#ltrim ltrim] function
str-utils2 Removes whitespace from the left side of string..
-</pre>
-==M==
-<pre>
-[MonadsApiDoc#m-chain m-chain] var
monads Chains together monadic computation steps that are...
-[MonadsApiDoc#m-fmap m-fmap] var
monads Bind the monadic value m to the function returning...
-[MonadsApiDoc#m-join m-join] var
monads Converts a monadic value containing a monadic valu...
-[MonadsApiDoc#m-lift m-lift] macro
monads Converts a function f of n arguments into a functi...
-[MonadsApiDoc#m-map m-map] var
monads 'Executes' the sequence of monadic values resultin...
-[MonadsApiDoc#m-reduce m-reduce] var
monads Return the reduction of (m-lift 2 f) over the list...
-[MonadsApiDoc#m-seq m-seq] var
monads 'Executes' the monadic values in ms and returns a ...
-[MonadsApiDoc#m-when m-when] macro
monads If test if logical true, return monadic value m-ex...
-[MonadsApiDoc#m-when-not m-when-not] macro
monads If test if logical false, return monadic value m-e...
-[WalkApiDoc#macroexpand-all macroexpand-all] function
walk Recursively performs all possible macroexpansions ...
-[MacroUtilsApiDoc#macrolet macrolet] macro
macro-utils Define local macros that are used in the expansion...
-[DatalogApiDoc#magic-literal magic-literal] function
datalog.literals Create a magic version of this adorned predicate..
-[DatalogApiDoc#magic-transform magic-transform] function
datalog.magic Return a magic transformation of an adorned rules-...
-[MiglayoutApiDoc#main main] function
miglayout.example Invokes converter-ui in the AWT Event thread.
-[SwingUtilsApiDoc#make-action make-action] function
swing-utils Create an Action proxy from the given action spec....
-[DatalogApiDoc#make-database make-database] macro
datalog.database Makes a database, like this (make-database ...
-[ProbabilitiesFiniteDistributionsApiDoc#make-distribution
make-distribution] function
probabilities.finite-distributions Returns the distribution in which ...
-[SwingUtilsApiDoc#make-menubar make-menubar] function
swing-utils Create a menubar containing the given sequence of ...
-[DuckStreamsApiDoc#make-parents make-parents]
function duck-streams Creates all parent directories of file..
-[DatalogApiDoc#make-rules-set make-rules-set] function
datalog.rules Given an existing set of rules, make it a 'rules-s...
-[DatalogApiDoc#map-values map-values] function
datalog.util Like map, but works over the values of a hash map.
-[TypesApiDoc#match match] macro
types Given a value and a list of template-expr clauses,...
-[MonadsApiDoc#maybe-m maybe-m] var
monads Monad describing computations with possible failur...
-[MonadsApiDoc#maybe-t maybe-t] function
monads Monad transformer that transforms a monad m into a...
-[SwingUtilsApiDoc#menu-constructor-dispatch menu-constructor-dispatch]
var swing-utils An atom containing the dispatch set for the
add-me...
-[DatalogApiDoc#merge-relations merge-relations] function
datalog.database Merges two relations.
-[MacroUtilsApiDoc#mexpand mexpand] function
macro-utils Like clojure.core/macroexpand, but takes into acco...
-[MacroUtilsApiDoc#mexpand-1 mexpand-1] function
macro-utils Like clojure.core/macroexpand-1, but takes into ac...
-[MacroUtilsApiDoc#mexpand-all mexpand-all] function
macro-utils Perform a full recursive macro expansion of a form...
-[MiglayoutApiDoc#miglayout miglayout] function
miglayout Adds java.awt.Components to a javax.swing.JCompone...
-[MmapApiDoc#mmap mmap] function
mmap Memory-map the file named f. Returns a ByteBuffer...
-[MonadsApiDoc#monad monad] macro
monads Define a monad by defining the monad operations. T...
-[MonadsApiDoc#monad-transformer monad-transformer]
macro monads Define a monad transforer in terms of the
monad op...
-</pre>
-==N==
-<pre>
-[ProbabilitiesMonteCarloApiDoc#n-sphere n-sphere]
function probabilities.monte-carlo Return a uniform distribution of
n-dimensio...
-[DefApiDoc#name-with-attributes name-with-attributes]
function def To be used in macro definitions. Handles
option...
-[DatalogApiDoc#negated-literal negated-literal] function
datalog.literals Given a literal l, return a negated version.
-[DatalogApiDoc#negated? negated?] function
datalog.literals Is this literal a negated literal?.
-[DatalogApiDoc#negative-vars negative-vars] multimethod
datalog.literals Returns the logic vars used in a negative position.
-[CoreApiDoc#new-by-name new-by-name] function
core Constructs a Java object whose class is specified ...
-[DatalogApiDoc#non-base-rules non-base-rules] function
datalog.rules Return a collection of rules that depend, somehow,...
-[ProbabilitiesMonteCarloApiDoc#normal normal]
function probabilities.monte-carlo Transform a sequence urs of uniform
random ...
-[ProbabilitiesMonteCarloApiDoc#normal-box-muller
normal-box-muller] function probabilities.monte-carlo
Transform a sequence of uniform random numb...
-[ProbabilitiesFiniteDistributionsApiDoc#normalize
normalize] function
probabilities.finite-distributions Convert a weight map (e.g. a map o...
-[FindNamespacesApiDoc#ns-decl? ns-decl?] function
find-namespaces Returns true if form is a (ns ...) declaration..
-[NsUtilsApiDoc#ns-vars ns-vars] function
ns-utils Returns a sorted seq of symbols naming public vars...
-</pre>
-==O==
-<pre>
-[JavadocBrowseApiDoc#open-url-in-browser open-url-in-browser]
function javadoc.browse Opens url (a string) in the default system
web bro...
-[JavadocBrowseApiDoc#open-url-in-swing open-url-in-swing]
function javadoc.browse Opens url (a string) in a Swing window..
-</pre>
-==P==
-<pre>
-[PprintApiDoc#*_print-circle_* *print-circle*] var
pprint Mark circular structures (N.B. This is not yet use...
-[PprintApiDoc#*_print-lines_* *print-lines*] var
pprint Maximum number of lines to print in a pretty print...
-[PprintApiDoc#*_print-miser-width_* *print-miser-width*]
var pprint The column at which to enter miser style.
Dependin...
-[PprintApiDoc#*_print-pprint-dispatch_* *print-pprint-dispatch*]
var pprint The pretty print dispatch function. Use
with-pprin...
-[PprintApiDoc#*_print-pretty_* *print-pretty*] var
pprint Bind to true if you want write to use pretty print...
-[PprintApiDoc#*_print-right-margin_* *print-right-margin*]
var pprint Pretty printing will try to avoid anything
going b...
-[PprintApiDoc#*_print-shared_* *print-shared*] var
pprint Mark repeated structures rather than repeat them (...
-[PprintApiDoc#*_print-suppress-namespaces_* *print-suppress-namespaces*]
var pprint Don't print namespaces with symbols. This
is parti...
-[PprintApiDoc#*_prxml-indent_* *prxml-indent*] var
pprint.examples.xml The number of spaces to indent sub-tags..
-[PrxmlApiDoc#*_prxml-indent_* *prxml-indent*] var
prxml The number of spaces to indent sub-tags. nil for ...
-[MiglayoutApiDoc#parse-component-constraint parse-component-constraint]
function miglayout.internal Parses a component constraint string
returning a C...
-[MiglayoutApiDoc#parse-item-constraints parse-item-constraints]
function miglayout.internal Iterates over args and builds a map
containing val...
-[LazyXmlApiDoc#parse-seq parse-seq] function
lazy-xml Parses the source s, which can be a File, InputStr...
-[LazyXmlApiDoc#parse-trim parse-trim] function
lazy-xml Parses the source s, which can be a File, InputStr...
-[StrUtils2ApiDoc#partition partition] function
str-utils2 Splits the string into a lazy sequence of substrin...
-[SeqUtilsApiDoc#partition-all partition-all] function
seq-utils Returns a lazy sequence of lists like clojure.core...
-[SeqUtilsApiDoc#partition-by partition-by] function
seq-utils Applies f to each value in coll, splitting it each...
-[SingletonApiDoc#per-thread-singleton per-thread-singleton]
function singleton Returns a per-thread singleton function. f
is a f...
-[CombinatoricsApiDoc#permutations permutations]
function combinatorics All the permutations of items,
lexicographic by in...
-[StreamUtilsApiDoc#pick pick] function
stream-utils Return the next value of stream argument n inside ...
-[StreamUtilsApiDoc#pick-all pick-all] function
stream-utils Return a vector containing the next value of each ...
-[DatalogApiDoc#positive-vars positive-vars] multimethod
datalog.literals Returns the logic vars used in a positive position.
-[DatalogApiDoc#positive? positive?] function
datalog.literals Is this a positive literal?.
-[GraphApiDoc#post-ordered-nodes post-ordered-nodes]
function graph Return a sequence of indexes of a
post-ordered wal...
-[WalkApiDoc#postwalk postwalk] function
walk Performs a depth-first, post-order traversal of fo...
-[WalkApiDoc#postwalk-demo postwalk-demo] function
walk Demonstrates the behavior of postwalk by printing ...
-[WalkApiDoc#postwalk-replace postwalk-replace] function
walk Recursively transforms form by replacing keys in s...
-[GenericMathFunctionsApiDoc#pow pow]
multimethod generic.math-functions Return the pow of x and y..
-[LazySeqsApiDoc#powers-of-2 powers-of-2] function
lazy-seqs Returns a lazy sequence of all the powers of 2.
-[PprintApiDoc#pp pp] macro
pprint A convenience macro that pretty prints the last th...
-[PprintApiDoc#pprint pprint] function
pprint Pretty print object to the optional output writer....
-[PprintApiDoc#pprint-indent pprint-indent] function
pprint Create an indent at this point in the pretty print...
-[PprintApiDoc#pprint-logical-block pprint-logical-block]
macro pprint Execute the body as a pretty printing
logical bloc...
-[PprintApiDoc#pprint-newline pprint-newline] function
pprint Print a conditional newline to a pretty printing s...
-[PprintApiDoc#pprint-tab pprint-tab] function
pprint Tab at this point in the pretty printing stream. k...
-[DatalogApiDoc#predicate-map predicate-map] function
datalog.rules Given a rules-set, return a map of rules keyed by ...
-[DatalogApiDoc#preduce preduce] function
datalog.util Similar to merge-with, but the contents of each ke...
-[WalkApiDoc#prewalk prewalk] function
walk Like postwalk, but does pre-order traversal..
-[WalkApiDoc#prewalk-demo prewalk-demo] function
walk Demonstrates the behavior of prewalk by printing e...
-[WalkApiDoc#prewalk-replace prewalk-replace] function
walk Recursively transforms form by replacing keys in s...
-[LazySeqsApiDoc#primes primes] var
lazy-seqs Lazy sequence of all the prime numbers..
-[StacktraceApiDoc#print-cause-trace print-cause-trace]
function stacktrace Like print-stack-trace but prints chained
exceptio...
-[DataflowApiDoc#print-dataflow print-dataflow] function
dataflow Prints a dataflow, one cell per line.
-[NsUtilsApiDoc#print-dir print-dir] function
ns-utils Prints a sorted directory of public vars in a name...
-[NsUtilsApiDoc#print-docs print-docs] function
ns-utils Prints documentation for the public vars in a name...
-[JsonWriteApiDoc#print-json print-json] multimethod
json.write Prints x as JSON. Nil becomes JSON null. Keyword...
-[PprintApiDoc#print-json print-json] function
pprint.examples.json Prints x as JSON. Nil becomes JSON null. Keywo...
-[ReplLnApiDoc#print-repl-info print-repl-info] function
repl-ln Prints info about the current repl.
-[SqlApiDoc#print-sql-exception print-sql-exception] function
sql.internal Prints the contents of an SQLException to stream.
-[SqlApiDoc#print-sql-exception-chain print-sql-exception-chain]
function sql.internal Prints a chain of SQLExceptions to stream.
-[ConditionApiDoc#print-stack-trace print-stack-trace]
function condition Prints a stack trace for a condition or
Throwable....
-[StacktraceApiDoc#print-stack-trace print-stack-trace]
function stacktrace Prints a Clojure-oriented stack trace of
tr, a Thr...
-[ProfileApiDoc#print-summary print-summary] function
profile Prints a table of the results returned by summariz...
-[TestIsApiDoc#print-tap-diagnostic print-tap-diagnostic]
function test-is.tap Prints a TAP diagnostic line. data is a
(possibly...
-[TestIsApiDoc#print-tap-fail print-tap-fail] function
test-is.tap Prints a TAP 'not ok' line. msg is a string, with...
-[TestIsApiDoc#print-tap-pass print-tap-pass] function
test-is.tap Prints a TAP 'ok' line. msg is a string, with no ...
-[TestIsApiDoc#print-tap-plan print-tap-plan] function
test-is.tap Prints a TAP plan line like '1..n'. n is the numb...
-[StacktraceApiDoc#print-throwable print-throwable]
function stacktrace Prints the class and message of a
Throwable..
-[StacktraceApiDoc#print-trace-element print-trace-element]
function stacktrace Prints a Clojure-oriented view of one
element in a...
-[SqlApiDoc#print-update-counts print-update-counts] function
sql.internal Prints the update counts from a BatchUpdateExcepti...
-[ProbabilitiesFiniteDistributionsApiDoc#prob
prob] function
probabilities.finite-distributions Return the probability that the pr...
-[ProfileApiDoc#prof prof] macro
profile If `*`enable-profiling`*` is true, wraps body in profi...
-[ProfileApiDoc#profile profile] macro
profile Runs body with profiling enabled, then prints a su...
-[DatalogApiDoc#project-literal project-literal] function
datalog.literals Project a stream of bindings onto a literal/relati...
-[SetApiDoc#proper-subset? proper-subset?] function
set Is s1 a proper subset of s2?.
-[SetApiDoc#proper-superset? proper-superset?] function
set Is s1 a proper superset of s2?.
-[PprintApiDoc#prxml prxml] function
pprint.examples.xml Print XML to `*`out`*`. Vectors become XML tags: the...
-[PrxmlApiDoc#prxml prxml] function
prxml Print XML to `*`out`*`. Vectors become XML tags: the ...
-[DuckStreamsApiDoc#pwd pwd] function
duck-streams Returns current working directory as a String. (L...
-</pre>
-==Q==
-<pre>
-[GenericArithmeticApiDoc#qsym qsym] macro
generic.arithmetic Create the qualified symbol corresponding to sym i...
-</pre>
-==R==
-<pre>
-[ReplUtilsApiDoc#*_remote-javadocs_* *remote-javadocs*]
var repl-utils Ref to a map from package name prefixes to
URLs fo...
-[ConditionApiDoc#raise raise] macro
condition Raises a condition. With no arguments, re-raises t...
-[ErrorKitApiDoc#raise raise] macro
error-kit Raise an error of the type err-name, constructed w...
-[ErrorKitApiDoc#raise_* raise*] function
error-kit Raise the given error object, best if created by a...
-[SeqUtilsApiDoc#rand-elt rand-elt] function
seq-utils Return a random element of this seq.
-[ProbabilitiesRandomNumbersApiDoc#rand-stream
rand-stream] var probabilities.random-numbers A
random number stream based on clojure....
-[ProbabilitiesMonteCarloApiDoc#random-stream
random-stream] function probabilities.monte-carlo
Define a random stream by a distribution an...
-[FcaseApiDoc#re-case re-case] macro
fcase Like case, but the test expressions are regular ex...
-[StrUtilsApiDoc#re-gsub re-gsub] function
str-utils Replaces all instances of 'pattern' in 'string' wi...
-[StrUtilsApiDoc#re-partition re-partition] function
str-utils Splits the string into a lazy sequence of substrin...
-[StrUtilsApiDoc#re-split re-split] function
str-utils Splits the string on instances of 'pattern'. Retu...
-[StrUtilsApiDoc#re-sub re-sub] function
str-utils Replaces the first instance of 'pattern' in 'strin...
-[FindNamespacesApiDoc#read-file-ns-decl read-file-ns-decl]
function find-namespaces Attempts to read a (ns ...) declaration
from file,...
-[JsonReadApiDoc#read-json read-json] function
json.read Read one JSON record from s, which may be a String...
-[DuckStreamsApiDoc#read-lines read-lines] function
duck-streams Like clojure.core/line-seq but opens f with reader...
-[FindNamespacesApiDoc#read-ns-decl read-ns-decl]
function find-namespaces Attempts to read a (ns ...) declaration
from rdr, ...
-[FindNamespacesApiDoc#read-ns-decl-from-jarfile-entry
read-ns-decl-from-jarfile-entry] function find-namespaces Attempts to
read a (ns ...) declaration from the n...
-[JavaUtilsApiDoc#read-properties read-properties]
function java-utils Read properties from file-able..
-[DuckStreamsApiDoc#reader reader] multimethod
duck-streams Attempts to coerce its argument into an open jav...
-[SeqUtilsApiDoc#rec-cat rec-cat] macro
seq-utils Similar to lazy-cat but binds the resulting sequen...
-[SeqUtilsApiDoc#rec-seq rec-seq] macro
seq-utils Similar to lazy-seq but binds the resulting seq to...
-[GraphApiDoc#recursive-component? recursive-component?]
function graph Is the component (recieved from scc) self
recursiv...
-[SeqUtilsApiDoc#reductions reductions] function
seq-utils Returns a lazy seq of the intermediate values of t...
-[ProbabilitiesMonteCarloApiDoc#reject reject]
function probabilities.monte-carlo Return the distribution that results
from r...
-[JavaUtilsApiDoc#relative-path-string relative-path-string]
multimethod java-utils Interpret a String or java.io.File as a
relative p...
-[DataflowApiDoc#remove-cells remove-cells] function
dataflow Given a collection of cells, remove them from the ...
-[GraphApiDoc#remove-loops remove-loops] function
graph For each node n, remove any edges n->n..
-[DatalogApiDoc#remove-tuple remove-tuple] function
datalog.database Two forms: `[`db relation-name tuple`]` removes th...
-[ReplLnApiDoc#repl repl] function
repl-ln A repl that supports line numbers. For definitions...
-[ReplLnApiDoc#repl-info repl-info] function
repl-ln Returns a map of info about the current repl.
-[ReplLnApiDoc#repl-prompt repl-prompt] function
repl-ln Returns the current repl prompt based on this repl...
-[StrUtils2ApiDoc#replace replace] multimethod
str-utils2 Replaces all instances of pattern in string with r...
-[StrUtils2ApiDoc#replace-first replace-first] multimethod
str-utils2 Replaces the first instance of pattern in s with r...
-[DatalogApiDoc#replace-relation replace-relation]
function datalog.database Add or replace a fully constructed relation
object...
-[TestIsApiDoc#report report] multimethod
test-is Generic reporting function, may be overridden to p...
-[HttpAgentApiDoc#response-headers-seq response-headers-seq]
function http.agent Returns the HTTP response headers in order
as a se...
-[DatalogApiDoc#return-rule-data return-rule-data]
function datalog.rules Returns an untypted rule that will be fully
printe...
-[GraphApiDoc#reverse-graph reverse-graph] function
graph Given a directed graph, return another directed gr...
-[DatalogApiDoc#reverse-map reverse-map] function
datalog.util Reverse the keys/values of a map.
-[ZipFilterApiDoc#right-locs right-locs] function
zip-filter Returns a lazy sequence of locations to the right ...
-[ZipFilterApiDoc#rightmost? rightmost?] function
zip-filter Returns true if there are no more nodes to the rig...
-[GenericMathFunctionsApiDoc#rint rint]
multimethod generic.math-functions Return the rint of x..
-[SqlApiDoc#rollback rollback] function
sql.internal Accessor for the rollback flag on the current conn...
-[StacktraceApiDoc#root-cause root-cause] function
stacktrace Returns the last 'cause' Throwable in a chain of T...
-[SeqUtilsApiDoc#rotations rotations] function
seq-utils Returns a lazy seq of all rotations of a seq.
-[GenericMathFunctionsApiDoc#round round]
multimethod generic.math-functions Return the round of x..
-[MathApiDoc#round round] multimethod
math (round n) rounds to the nearest integer. round alw...
-[StrUtils2ApiDoc#rtrim rtrim] function
str-utils2 Removes whitespace from the right side of string..
-[DatalogApiDoc#rules-set rules-set] function
datalog.rules Given a collection of rules return a rules set.
-[ReplUtilsApiDoc#run run] macro
repl-utils Loads the specified namespace and invokes its "mai...
-[ReplUtilsApiDoc#run_* run*] function
repl-utils Loads the specified namespace and invokes its "mai...
-[TestIsApiDoc#run-all-tests run-all-tests] function
test-is Runs all tests in all namespaces; prints results. ...
-[MonadsApiDoc#run-cont run-cont] function
monads Execute the computation c in the cont monad and re...
-[TestIsApiDoc#run-tests run-tests] function
test-is Runs all tests in the given namespaces; prints res...
-[DatalogApiDoc#run-work-plan run-work-plan] function
datalog Given a work plan, a database, and some query bind...
-</pre>
-==S==
-<pre>
-[PprintApiDoc#*_simple-dispatch_* *simple-dispatch*]
multimethod pprint The pretty print dispatch function for
simple data...
-[TestIsApiDoc#*_stack-trace-depth_* *stack-trace-depth*]
var test-is The maximum depth of stack traces to print
when an...
-[MapUtilsApiDoc#safe-get safe-get] function
map-utils Like get, but throws an exception if the key is no...
-[MapUtilsApiDoc#safe-get-in safe-get-in] function
map-utils Like get-in, but throws an exception if any key is...
-[ProbabilitiesMonteCarloApiDoc#sample sample]
function probabilities.monte-carlo Return the distribution of samples
of lengt...
-[ProbabilitiesMonteCarloApiDoc#sample-mean sample-mean]
function probabilities.monte-carlo Return the distribution of the mean
over n ...
-[ProbabilitiesMonteCarloApiDoc#sample-mean-variance
sample-mean-variance] function probabilities.monte-carlo
Return the distribution of the mean-and-var...
-[ProbabilitiesMonteCarloApiDoc#sample-reduce
sample-reduce] function probabilities.monte-carlo
Returns the distribution of the reduction o...
-[ProbabilitiesMonteCarloApiDoc#sample-sum sample-sum]
function probabilities.monte-carlo Return the distribution of the sum
over n s...
-[GraphApiDoc#scc scc] function
graph Returns, as a sequence of sets, the strongly conne...
-[DatalogApiDoc#seed-predicate-for-insertion seed-predicate-for-insertion]
function datalog.magic Given a query, return the predicate to use
for dat...
-[DatalogApiDoc#seed-relation seed-relation] function
datalog.magic Given a magic form of a query, give back the liter...
-[DatalogApiDoc#seed-rule seed-rule] function
datalog.magic Given an adorned query, give back its seed rule.
-[DatalogApiDoc#select select] function
datalog.database finds all matching tuples to the partial tuple (pt...
-[CombinatoricsApiDoc#selections selections]
function combinatorics All the ways of taking n (possibly the
same) eleme...
-[GraphApiDoc#self-recursive-sets self-recursive-sets]
function graph Returns, as a sequence of sets, the
components of ...
-[HttpConnectionApiDoc#send-request-entity send-request-entity]
multimethod http.connection Transmits a request entity body..
-[MiglayoutApiDoc#sep sep] function
miglayout.test Returns a swing separator.
-[SeqUtilsApiDoc#separate separate] function
seq-utils Returns a vector: `[` (filter f s), (filter (comp...
-[GenericCollectionApiDoc#seq seq] multimethod
generic.collection Returns a seq on the object s..
-[SeqUtilsApiDoc#seq-on seq-on] multimethod
seq-utils Returns a seq on the object s. Works like the buil...
-[ZipFilterApiDoc#seq-test seq-test] function
zip-filter.xml Returns a query predicate that matches a node when...
-[CoreApiDoc#seqable? seqable?] function
core Returns true if (seq x) will succeed, false otherw...
-[MonadsApiDoc#sequence-m sequence-m] var
monads Monad describing multi-valued computations, i.e. c...
-[MonadsApiDoc#sequence-t sequence-t] function
monads Monad transformer that transforms a monad m into a...
-[MonadsApiDoc#set-m set-m] var
monads Monad describing multi-valued computations, like s...
-[PprintApiDoc#set-pprint-dispatch set-pprint-dispatch]
function pprint Set the pretty print dispatch function to a
functi...
-[ReplLnApiDoc#set-repl-name set-repl-name] function
repl-ln Sets the repl name format to the string name-fmt. ...
-[ReplLnApiDoc#set-repl-prompt set-repl-prompt] function
repl-ln Sets the repl prompt. Include the following codes ...
-[SqlApiDoc#set-rollback-only set-rollback-only] function
sql Marks the outermost transaction such that it will ...
-[JavaUtilsApiDoc#set-system-properties set-system-properties]
function java-utils Set some system properties. Nil clears a
property..
-[TestIsApiDoc#set-test set-test] macro
test-is Experimental. Sets :test metadata of the named v...
-[GenericMathFunctionsApiDoc#sgn sgn]
multimethod generic.math-functions Return the sign of x (-1, 0, or 1)..
-[ShellOutApiDoc#sh sh] function
shell-out Passes the given strings to Runtime.exec() to laun...
-[ReplUtilsApiDoc#show show] function
repl-utils With one arg prints all static and instance member...
-[SeqUtilsApiDoc#shuffle shuffle] function
seq-utils Return a random permutation of coll.
-[GenericMathFunctionsApiDoc#sin sin]
multimethod generic.math-functions Return the sin of x..
-[MmapApiDoc#slurp slurp] function
mmap Reads the file named by f and returns it as a stri...
-[DuckStreamsApiDoc#slurp_* slurp*] function
duck-streams Like clojure.core/slurp but opens f with reader..
-[ReplUtilsApiDoc#source source] macro
repl-utils Prints the source code for the given symbol, if it...
-[DataflowApiDoc#source-cell? source-cell?] function
dataflow Is this cell a source cell?.
-[DuckStreamsApiDoc#spit spit] function
duck-streams Opposite of slurp. Opens f with writer, writes co...
-[StrUtils2ApiDoc#split split] function
str-utils2 Splits string on a regular expression. Optional a...
-[StrUtils2ApiDoc#split-lines split-lines] function
str-utils2 Splits s on \n or \r\n..
-[GenericMathFunctionsApiDoc#sqr sqr]
multimethod generic.math-functions Return the square of x..
-[GenericMathFunctionsApiDoc#sqrt sqrt]
multimethod generic.math-functions Return the sqrt of x..
-[MathApiDoc#sqrt sqrt] multimethod
math Square root, but returns exact number if possible..
-[ConditionApiDoc#stack-trace-info stack-trace-info]
multimethod condition Returns header, stack-trace, and cause info
from c...
-[ReplUtilsApiDoc#start-handling-break start-handling-break]
function repl-utils Register INT signal handler. After calling
this, ...
-[MonadsApiDoc#state-m state-m] var
monads Monad describing stateful computations. The monadi...
-[MonadsApiDoc#state-t state-t] function
monads Monad transformer that transforms a monad m into a...
-[StrUtilsApiDoc#str-join str-join] function
str-utils Returns a string of all elements in 'sequence', se...
-[GraphApiDoc#stratification-list stratification-list]
function graph Similar to dependency-list (see doc),
except two g...
-[StreamUtilsApiDoc#stream-drop stream-drop] function
stream-utils Return a stream containing all but the first n ele...
-[StreamUtilsApiDoc#stream-filter stream-filter]
multimethod stream-utils Return a new stream that contrains the
elements of...
-[StreamUtilsApiDoc#stream-flatten stream-flatten]
function stream-utils Converts a stream of sequences into a
stream of th...
-[StreamUtilsApiDoc#stream-m stream-m] var
stream-utils Monad describing stream computations. The monadic ...
-[StreamUtilsApiDoc#stream-map stream-map] multimethod
stream-utils Return a new stream by mapping the function f on t...
-[StreamUtilsApiDoc#stream-next stream-next] multimethod
stream-utils Returns a vector `[`next-value new-state`]` where next...
-[ReplLnApiDoc#stream-repl stream-repl] function
repl-ln Repl entry point that provides convenient overridi...
-[StreamUtilsApiDoc#stream-seq stream-seq] function
stream-utils Return a lazy seq on the stream. Also accessible v...
-[StreamUtilsApiDoc#stream-type stream-type] var
stream-utils The root type for the stream hierarchy. For each s...
-[WalkApiDoc#stringify-keys stringify-keys] function
walk Recursively transforms all map keys from keywords ...
-[SetApiDoc#subset? subset?] function
set Is set1 a subset of set2?.
-[CombinatoricsApiDoc#subsets subsets] function
combinatorics All the subsets of items.
-[ProfileApiDoc#summarize summarize] function
profile Takes the raw data returned by with-profile-data a...
-[SetApiDoc#superset? superset?] function
set Is set1 a superset of set2?.
-[MacroUtilsApiDoc#symbol-macrolet symbol-macrolet]
macro macro-utils Define local symbol macros that are used in
the ex...
-</pre>
-==T==
-<pre>
-[TraceApiDoc#*_trace-depth_* *trace-depth*] var
trace Current stack depth of traced function calls..
-[ZipFilterApiDoc#tag_= tag=] function
zip-filter.xml Returns a query predicate that matches a node when...
-[StrUtils2ApiDoc#tail tail] function
str-utils2 Returns the last n characters of s..
-[StrUtils2ApiDoc#take take] function
str-utils2 Take first n characters from s, up to the length o...
-[GenericMathFunctionsApiDoc#tan tan]
multimethod generic.math-functions Return the tan of x..
-[TemplateApiDoc#template template] macro
template Expands to a fn using `_`1, `_`2, `_`3, etc. as
argument...
-[TemplateApiDoc#template? template?] function
template Returns true if form is a valid template expressio...
-[TestIsApiDoc#test-all-vars test-all-vars] function
test-is Calls test-var on every var interned in the namesp...
-[TestIsApiDoc#test-ns test-ns] function
test-is If the namespace defines a function named test-ns-...
-[TestIsApiDoc#test-var test-var] function
test-is If v has a function in its :test metadata, calls t...
-[TestIsApiDoc#testing testing] macro
test-is Adds a new string to the list of testing contexts....
-[TestIsApiDoc#testing-contexts-str testing-contexts-str]
function test-is Returns a string representation of the
current tes...
-[TestIsApiDoc#testing-vars-str testing-vars-str] function
test-is Returns a string representation of the current tes...
-[ZipFilterApiDoc#text text] function
zip-filter.xml Returns the textual contents of the given location...
-[MiglayoutApiDoc#text-field text-field] function
miglayout.test Returns a swing text field.
-[ZipFilterApiDoc#text_= text=] function
zip-filter.xml Returns a query predicate that matches a node when...
-[ExceptApiDoc#throw-arg throw-arg] function
except Throws an IllegalArgumentException. All arguments ...
-[ExceptApiDoc#throw-if throw-if] function
except Throws an Exception or Error if test is true. args...
-[ExceptApiDoc#throw-if-not throw-if-not] function
except Throws an Exception or Error if test is false. arg...
-[ErrorKitApiDoc#throw-msg throw-msg] macro
error-kit Returns a function that throws a Java Exception wi...
-[SqlApiDoc#throw-rollback throw-rollback] function
sql.internal Sets rollback and throws a wrapped exception.
-[ExceptApiDoc#throwf throwf] function
except Throws an Exception or Error with an optional mess...
-[DuckStreamsApiDoc#to-byte-array to-byte-array]
multimethod duck-streams Converts argument into a Java byte array.
Argumen...
-[TraceApiDoc#trace trace] function
trace Sends name (optional) and value to the tracer func...
-[DatalogApiDoc#trace-datalog trace-datalog] macro
datalog.util If `*`test-datalog`*` is set to true, run the enclosed...
-[TraceApiDoc#trace-fn-call trace-fn-call] function
trace Traces a single call to a function f with args. '...
-[TraceApiDoc#trace-indent trace-indent] function
trace Returns an indentation string based on `*`trace-dept...
-[TraceApiDoc#tracer tracer] function
trace This function is called by trace. Prints to stand...
-[SqlApiDoc#transaction transaction] macro
sql Evaluates body as a transaction on the open databa...
-[SqlApiDoc#transaction_* transaction*] function
sql.internal Evaluates func as a transaction on the open databa...
-[GraphApiDoc#transitive-closure transitive-closure]
function graph Returns the transitive closure of a graph.
The ne...
-[StrUtils2ApiDoc#trim trim] function
str-utils2 Removes whitespace from both ends of string..
-[TestIsApiDoc#try-expr try-expr] macro
test-is Used by the 'is' macro to catch unexpected excepti...
-</pre>
-==U==
-<pre>
-[ProbabilitiesFiniteDistributionsApiDoc#uniform
uniform] function
probabilities.finite-distributions Return a distribution in which eac...
-[SqlApiDoc#update-or-insert-values update-or-insert-values]
function sql Updates values on selected rows in a table,
or ins...
-[DataflowApiDoc#update-values update-values] function
dataflow Given a dataflow, and a map of name-value pairs, u...
-[SqlApiDoc#update-values update-values] function
sql Updates values on selected rows in a table. where-...
-[StrUtils2ApiDoc#upper-case upper-case] function
str-utils2 Converts string to all upper-case..
-[PprintApiDoc#use-method use-method] function
pprint Installs a function as a new method of multimethod...
-</pre>
-==V==
-<pre>
-[NsUtilsApiDoc#vars vars] macro
ns-utils Returns a sorted seq of symbols naming public vars...
-</pre>
-==W==
-<pre>
-[WalkApiDoc#walk walk] function
walk Traverses form, an arbitrary data structure. inne...
-[CommandLineApiDoc#with-command-line with-command-line]
macro command-line Bind locals to command-line args..
-[SqlApiDoc#with-connection with-connection] macro
sql Evaluates body in the context of a new connection ...
-[SqlApiDoc#with-connection_* with-connection*] function
sql.internal Evaluates func in the context of a new connection ...
-[ErrorKitApiDoc#with-handler with-handler] macro
error-kit This is error-kit's dynamic scope form. The body ...
-[DuckStreamsApiDoc#with-in-reader with-in-reader]
macro duck-streams Opens a PushbackReader on f, binds it to
`*`in`*`, and...
-[MonadsApiDoc#with-monad with-monad] macro
monads Evaluates an expression after replacing the keywor...
-[WithNsApiDoc#with-ns with-ns] macro
with-ns Evaluates body in another namespace. ns is either...
-[DuckStreamsApiDoc#with-out-append-writer with-out-append-writer]
macro duck-streams Like with-out-writer but appends to file..
-[DuckStreamsApiDoc#with-out-writer with-out-writer]
macro duck-streams Opens a writer on f, binds it to `*`out`*`,
and evalut...
-[PprintApiDoc#with-pprint-dispatch with-pprint-dispatch]
macro pprint Execute body with the pretty print dispatch
functi...
-[ProfileApiDoc#with-profile-data with-profile-data]
macro profile Executes body with `*`profile-data`*` bound
to an atom...
-[SqlApiDoc#with-query-results with-query-results] macro
sql Executes a query, then evaluates body with results...
-[SqlApiDoc#with-query-results_* with-query-results*]
function sql.internal Executes a query, then evaluates func
passing in a...
-[MacroUtilsApiDoc#with-symbol-macros with-symbol-macros]
macro macro-utils Fully expand exprs, including symbol
macros..
-[JavaUtilsApiDoc#with-system-properties with-system-properties]
macro java-utils setting `=`> property-name value Sets the
system ...
-[TestIsApiDoc#with-tap-output with-tap-output] macro
test-is.tap Execute body with modified test-is reporting funct...
-[WithNsApiDoc#with-temp-ns with-temp-ns] macro
with-ns Evaluates body in an anonymous namespace, which is...
-[TestIsApiDoc#with-test with-test] macro
test-is Takes any definition form (that returns a Var) as ...
-[TestIsApiDoc#with-test-out with-test-out] macro
test-is Runs body with `*`out`*` bound to the value of
`*`test-o...
-[PprintApiDoc#write write] function
pprint Write an object subject to the current bindings of...
-[DuckStreamsApiDoc#write-lines write-lines] function
duck-streams Writes lines (a seq) to f, separated by newlines. ...
-[PprintApiDoc#write-out write-out] function
pprint Write an object to `*`out`*` subject to the current bi...
-[JavaUtilsApiDoc#write-properties write-properties]
function java-utils Write properties to file-able..
-[DuckStreamsApiDoc#writer writer] multimethod
duck-streams Attempts to coerce its argument into an open java....
-[MonadsApiDoc#writer-m writer-m] function
monads Monad describing computations that accumulate data...
-</pre>
-==X==
-<pre>
-[ZipFilterApiDoc#xml-> xml->] function
zip-filter.xml The loc is passed to the first predicate. If the ...
-[ZipFilterApiDoc#xml1-> xml1->] function
zip-filter.xml Returns the first item from loc based on the query...
-</pre>
-==Y==
-<pre>
-</pre>
-==Z==
-<pre>
-[GenericComparisonApiDoc#zero? zero?] multimethod
generic.comparison Return true of x is zero..
-[ProbabilitiesFiniteDistributionsApiDoc#zipf
zipf] function
probabilities.finite-distributions Returns the Zipf distribution in w...
-</pre>
-==Other==
-<pre>
-[GenericArithmeticApiDoc#* *] multimethod
generic.arithmetic Return the product of all arguments. The minimal i...
-[GenericArithmeticApiDoc#+ +] multimethod
generic.arithmetic Return the sum of all arguments. The minimal imple...
-[GenericArithmeticApiDoc#- -] multimethod
generic.arithmetic Return the difference of the first argument and th...
-[CoreApiDoc#-?> -?>] macro
core Same as clojure.core/-> but returns nil as soon as...
-[CoreApiDoc#.?. .?.] macro
core Same as clojure.core/.. but returns nil as soon as...
-[GenericArithmeticApiDoc#/ /] multimethod
generic.arithmetic Return the quotient of the first argument and the ...
-[GenericComparisonApiDoc#< <] multimethod
generic.comparison Return true if each argument is smaller than the f...
-[DatalogApiDoc#<- <-] macro
datalog.rules Build a datalog rule. Like this: (<- (:head :...
-[GenericComparisonApiDoc#<_= <=] multimethod
generic.comparison Return true if each arguments is smaller than or e...
-[GenericComparisonApiDoc#= =] multimethod
generic.comparison Return true if all arguments are equal. The minima...
-[GenericComparisonApiDoc#> >] multimethod
generic.comparison Return true if each argument is larger than the fo...
-[GenericComparisonApiDoc#>_= >=] multimethod
generic.comparison Return true if each argument is larger than or equ...
-[DatalogApiDoc#?- ?-] macro
datalog.rules Define a datalog query.
-</pre>
=======================================
--- /wiki/ApiDocSidebar.wiki Wed Jun 10 00:20:05 2009
+++ /dev/null
@@ -1,83 +0,0 @@
-#summary The navigational sidebar for the generated API documentation
-
-<wiki:comment>
-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.
-</wiki:comment>
-[OverviewOfContrib Overview]<br/>
-[ApiDocIndex Index]
-
-[AccumulatorsApiDoc accumulators]<br/>
-[AgentUtilsApiDoc agent-utils]<br/>
-[ClasspathApiDoc classpath]<br/>
-[CombinatoricsApiDoc combinatorics]<br/>
-[CommandLineApiDoc command-line]<br/>
-[ComplexNumbersApiDoc complex-numbers]<br/>
-[CondApiDoc cond]<br/>
-[ConditionApiDoc condition]<br/>
-[CondtApiDoc condt]<br/>
-[CoreApiDoc core]<br/>
-[DataflowApiDoc dataflow]<br/>
-[DatalogApiDoc datalog]<br/>
-[DefApiDoc def]<br/>
-[DuckStreamsApiDoc duck-streams]<br/>
-[ErrorKitApiDoc error-kit]<br/>
-[ExceptApiDoc except]<br/>
-[FcaseApiDoc fcase]<br/>
-[FindNamespacesApiDoc find-namespaces]<br/>
-[FnmapApiDoc fnmap]<br/>
-[GenHtmlDocsApiDoc gen-html-docs]<br/>
-[GenericArithmeticApiDoc generic.arithmetic]<br/>
-[GenericCollectionApiDoc generic.collection]<br/>
-[GenericComparisonApiDoc generic.comparison]<br/>
-[GenericFunctorApiDoc generic.functor]<br/>
-[GenericMathFunctionsApiDoc generic.math-functions]<br/>
-[GraphApiDoc graph]<br/>
-[GreatestLeastApiDoc greatest-least]<br/>
-[HttpAgentApiDoc http.agent]<br/>
-[HttpConnectionApiDoc http.connection]<br/>
-[ImportStaticApiDoc import-static]<br/>
-[JarApiDoc jar]<br/>
-[JavaUtilsApiDoc java-utils]<br/>
-[JavadocBrowseApiDoc javadoc.browse]<br/>
-[JsonReadApiDoc json.read]<br/>
-[JsonWriteApiDoc json.write]<br/>
-[LazySeqsApiDoc lazy-seqs]<br/>
-[LazyXmlApiDoc lazy-xml]<br/>
-[MacroUtilsApiDoc macro-utils]<br/>
-[MacrosApiDoc macros]<br/>
-[MapUtilsApiDoc map-utils]<br/>
-[MathApiDoc math]<br/>
-[MiglayoutApiDoc miglayout]<br/>
-[MmapApiDoc mmap]<br/>
-[MonadsApiDoc monads]<br/>
-[NsUtilsApiDoc ns-utils]<br/>
-[PprintApiDoc pprint]<br/>
-[ProbabilitiesFiniteDistributionsApiDoc
probabilities.finite-distributions]<br/>
-[ProbabilitiesMonteCarloApiDoc probabilities.monte-carlo]<br/>
-[ProbabilitiesRandomNumbersApiDoc probabilities.random-numbers]<br/>
-[ProfileApiDoc profile]<br/>
-[PrxmlApiDoc prxml]<br/>
-[ReplLnApiDoc repl-ln]<br/>
-[ReplUtilsApiDoc repl-utils]<br/>
-[SeqUtilsApiDoc seq-utils]<br/>
-[ServerSocketApiDoc server-socket]<br/>
-[SetApiDoc set]<br/>
-[ShellOutApiDoc shell-out]<br/>
-[SingletonApiDoc singleton]<br/>
-[SqlApiDoc sql]<br/>
-[StacktraceApiDoc stacktrace]<br/>
-[StrUtilsApiDoc str-utils]<br/>
-[StrUtils2ApiDoc str-utils2]<br/>
-[StreamUtilsApiDoc stream-utils]<br/>
-[SwingUtilsApiDoc swing-utils]<br/>
-[TemplateApiDoc template]<br/>
-[TestIsApiDoc test-is]<br/>
-[TraceApiDoc trace]<br/>
-[TypesApiDoc types]<br/>
-[WalkApiDoc walk]<br/>
-[WithNsApiDoc with-ns]<br/>
-[ZipFilterApiDoc zip-filter]<br/>
=======================================
--- /wiki/ClasspathApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,53 +0,0 @@
-#summary classpath API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for classpath=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.classpath))
-}}}
-==Overview==
-<pre> Utilities for dealing with the JVM's classpath</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#classpath classpath] [#classpath-directories classpath-directories]
[#classpath-jarfiles classpath-jarfiles]
-
-----
-===classpath===
-====function====
-<pre>
-Usage: *(_classpath_)*
-</pre>
-<pre> Returns a sequence of File objects of the elements on
CLASSPATH.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/classpath.clj#23
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=classpath+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===classpath-directories===
-====function====
-<pre>
-Usage: *(_classpath-directories_)*
-</pre>
-<pre> Returns a sequence of File objects for the directories on
classpath.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/classpath.clj#30
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=classpath-directories+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===classpath-jarfiles===
-====function====
-<pre>
-Usage: *(_classpath-jarfiles_)*
-</pre>
-<pre> Returns a sequence of JarFile objects for the JAR files on
classpath.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/classpath.clj#35
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=classpath-jarfiles+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/CombinatoricsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,82 +0,0 @@
-#summary combinatorics API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for combinatorics=
-by Mark Engelberg
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.combinatorics))
-}}}
-==Overview==
-<pre> Efficient, functional algorithms for generating lazy
-sequences for common combinatorial functions. (See the source code
-for a longer description.)</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#cartesian-product cartesian-product] [#combinations combinations]
[#lex-permutations lex-permutations] [#permutations permutations]
[#selections selections] [#subsets subsets]
-
-----
-===cartesian-product===
-====function====
-<pre>
-Usage: *(_cartesian-product_ & seqs)*
-</pre>
-<pre> All the ways to take one item from each sequence</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#107
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cartesian-product+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===combinations===
-====function====
-<pre>
-Usage: *(_combinations_ items n)*
-</pre>
-<pre> All the unique ways of taking n different elements from items</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#90
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=combinations+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===lex-permutations===
-====function====
-<pre>
-Usage: *(_lex-permutations_ c)*
-</pre>
-<pre> Fast lexicographic permutation generator for a sequence of
numbers</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#151
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=lex-permutations+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===permutations===
-====function====
-<pre>
-Usage: *(_permutations_ items)*
-</pre>
-<pre> All the permutations of items, lexicographic by index</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#160
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=permutations+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===selections===
-====function====
-<pre>
-Usage: *(_selections_ items n)*
-</pre>
-<pre> All the ways of taking n (possibly the same) elements from the
sequence of items</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#127
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=selections+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===subsets===
-====function====
-<pre>
-Usage: *(_subsets_ items)*
-</pre>
-<pre> All the subsets of items</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/combinatorics.clj#101
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=subsets+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/CommandLineApiDoc.wiki Wed Jun 3 13:53:21 2009
+++ /dev/null
@@ -1,35 +0,0 @@
-#summary command-line API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for command-line=
-by Chris Houser
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.command-line))
-}}}
-==Overview==
-<pre> Process command-line arguments according to a given cmdspec</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#with-command-line with-command-line]
-
-----
-===with-command-line===
-====macro====
-<pre>
-Usage: *(_with-command-line_ args desc cmdspec & body)*
-</pre>
-<pre> Bind locals to command-line args.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/command_line.clj#91
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-command-line+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/ComplexNumbersApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,25 +0,0 @@
-#summary complex-numbers API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for complex-numbers=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.complex-numbers))
-}}}
-==Overview==
-<pre> Complex numbers
-NOTE: This library is in evolution. Most math functions are
- not implemented yet.</pre>
-
-
-==Public Variables and Functions==
=======================================
--- /wiki/CondApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,42 +0,0 @@
-#summary cond API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for cond=
-by Stephen C. Gilardi
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.cond))
-}}}
-==Overview==
-<pre> Extensions to the basic cond function.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#cond-let cond-let]
-
-----
-===cond-let===
-====macro====
-<pre>
-Usage: *(_cond-let_ bindings & clauses)*
-</pre>
-<pre> Takes a binding-form and a set of test/expr pairs. Evaluates each
test
-one at a time. If a test returns logical true, cond-let evaluates and
-returns expr with binding-form bound to the value of test and doesn't
-evaluate any of the other tests or exprs. To provide a default value
-either provide a literal that evaluates to logical true and is
-binding-compatible with binding-form, or use :else as the test and don't
-refer to any parts of binding-form in the expr. (cond-let binding-form)
-returns nil.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/cond.clj#18
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cond-let+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/ConditionApiDoc.wiki Mon Jun 15 22:12:56 2009
+++ /dev/null
@@ -1,112 +0,0 @@
-#summary condition API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for condition=
-by Stephen C. Gilardi
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.condition))
-}}}
-==Overview==
-<pre> Flexible raising and handling of conditions:
-
-Functions:
-
- raise: raises a condition
- handler-case: dispatches raised conditions to appropriate handlers
- print-stack-trace: prints abbreviated or full condition stack traces
-
-Data:
-
- A condition is a map containing values for these keys:
-
- - :type, a condition type specifier, typically a keyword
- - :stack-trace, a stack trace to the site of the raise
- - :message, a human-readable message (optional)
- - :cause, a wrapped exception or condition (optional)
- - other keys given as arguments to raise (optional)
-
-Note: requires AOT compilation.
-
-Based on an idea from Chouser:
-http://groups.google.com/group/clojure/browse`_`frm/thread/da1285c538f22bb5</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#*_full-stack-traces_* *full-stack-traces*] [#handler-case handler-case]
[#print-stack-trace print-stack-trace] [#raise raise] [#stack-trace-info
stack-trace-info]
-
-----
-===`*`full-stack-traces`*`===
-====var====
-<pre> Bind to true to include clojure.{core,lang,main} frames in stack
-traces</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#56
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*full-stack-traces*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===handler-case===
-====macro====
-<pre>
-Usage: *(_handler-case_ dispatch-fn & body)*
-</pre>
-<pre> Executes body in a context where raised conditions can be handled.
-
-dispatch-fn accepts a raised condition (a map) and returns a selector
-used to choose a handler. Commonly, dispatch-fn will be :type to dispatch
-on the condition's :type value.
-
-Handlers are forms within body:
-
- (handle key
- ...)
-
-If a condition is raised, executes the body of the first handler whose
-key satisfies (isa? selector key). If no handlers match, re-raises the
-condition.
-
-While a handler is running, `*`condition`*` is bound to the condition being
-handled and `*`selector`*` is bound to to the value returned by dispatch-fn
-that matched the handler's key.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#71
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=handler-case+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===print-stack-trace===
-====function====
-<pre>
-Usage: *(_print-stack-trace_ x)*
-</pre>
-<pre> Prints a stack trace for a condition or Throwable. Skips frames for
-classes in clojure.{core,lang,main} unless the `*`full-stack-traces`*` is
-bound to logical true</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#128
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-stack-trace+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===raise===
-====macro====
-<pre>
-Usage: *(_raise_)
- (_raise_ m)
- (_raise_ key val & keyvals)*
-</pre>
-<pre> Raises a condition. With no arguments, re-raises the current
condition.
-With one argument (a map), raises the argument. With two or more
-arguments, raises a map with keys and values from the arguments.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#60
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=raise+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===stack-trace-info===
-====multimethod====
-_No usage documentation available_
-<pre> Returns header, stack-trace, and cause info from conditions and
-Throwables</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#106
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=stack-trace-info+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/CondtApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,49 +0,0 @@
-#summary condt API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for condt=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.condt))
-}}}
-==Overview==
-<pre> Generic case-like macro using template expressions</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#condt condt] [#econdt econdt]
-
-----
-===condt===
-====macro====
-<pre>
-Usage: *(_condt_ expr & clauses)*
-</pre>
-<pre> expr is a template expression (see template), clauses are test/expr
-pairs like cond. Evalautes the template on each test value, one at
-a time. If a test returns logical true, condt evaluates the
-corresponding expr and returns its value. If none of the tests are
-true, and there are an odd number of clauses, the last clause is
-evaluated, otherwise returns nil.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condt.clj#31
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=condt+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===econdt===
-====macro====
-<pre>
-Usage: *(_econdt_ expr & clauses)*
-</pre>
-<pre> Like condt but throws Exception if no tests match.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condt.clj#50
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=econdt+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/CoreApiDoc.wiki Wed Jun 3 13:53:21 2009
+++ /dev/null
@@ -1,84 +0,0 @@
-#summary core API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for core=
-by Laurent Petit (and others)
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.core))
-}}}
-==Overview==
-<pre> Functions/macros variants of the ones that can be found in
clojure.core
-(note to other contrib members: feel free to add to this lib)</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#-?> -?>] [#.?. .?.] [#dissoc-in dissoc-in] [#new-by-name new-by-name]
[#seqable? seqable?]
-
-----
-===-?>===
-====macro====
-<pre>
-Usage: *(_-?>_ x form)
- (_-?>_ x form & forms)*
-</pre>
-<pre> Same as clojure.core/-> but returns nil as soon as the threaded
value is nil itself (thus short-circuiting any pending computation).
-Examples :
-(-?> "foo" .toUpperCase (.substring 1)) returns "OO"
-(-?> nil .toUpperCase (.substring 1)) returns nil
-</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core.clj#30
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=-?>+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===.?.===
-====macro====
-<pre>
-Usage: *(_.?._ x form)
- (_.?._ x form & forms)*
-</pre>
-<pre> Same as clojure.core/.. but returns nil as soon as the threaded
value is nil itself (thus short-circuiting any pending computation).
-Examples :
-(.?. "foo" .toUpperCase (.substring 1)) returns "OO"
-(.?. nil .toUpperCase (.substring 1)) returns nil
-</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core.clj#38
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=.?.+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===dissoc-in===
-====function====
-<pre>
-Usage: *(_dissoc-in_ m `[`k & ks :as keys`]`)*
-</pre>
-<pre> Dissociates an entry from a nested associative structure returning a
new
-nested structure. keys is a sequence of keys. Any empty maps that result
-will not be present in the new structure.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core.clj#49
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=dissoc-in+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===new-by-name===
-====function====
-<pre>
-Usage: *(_new-by-name_ class-name & args)*
-</pre>
-<pre> Constructs a Java object whose class is specified by a String.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core.clj#63
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=new-by-name+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===seqable?===
-====function====
-<pre>
-Usage: *(_seqable?_ x)*
-</pre>
-<pre> Returns true if (seq x) will succeed, false otherwise.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/core.clj#70
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=seqable?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/DataflowApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,234 +0,0 @@
-#summary dataflow API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for dataflow=
-by Jeffrey Straszheim
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.dataflow))
-}}}
-==Overview==
-<pre> A library to support a dataflow model of state</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#add-cell-watcher add-cell-watcher] [#add-cells add-cells]
[#build-dataflow build-dataflow] [#build-source-cell build-source-cell]
[#build-standard-cell build-standard-cell] [#build-validator-cell
build-validator-cell] [#cell cell] [#display-cell display-cell] [#eval-cell
eval-cell] [#get-cell get-cell] [#get-cells get-cells] [#get-old-value
get-old-value] [#get-source-cells get-source-cells] [#get-value get-value]
[#get-value-from-cell get-value-from-cell] [#get-values get-values]
[#print-dataflow print-dataflow] [#remove-cells remove-cells]
[#source-cell? source-cell?] [#update-values update-values]
-
-----
-===add-cell-watcher===
-====function====
-<pre>
-Usage: *(_add-cell-watcher_ cell key fun)*
-</pre>
-<pre> Adds a watcher to a cell to respond to changes of value. The is a
-function of 4 values: a key, the cell, its old value, its new
-value. This is implemented using Clojure's add-watch to the
-underlying ref, and shared its sematics</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#460
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-cell-watcher+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===add-cells===
-====function====
-<pre>
-Usage: *(_add-cells_ df cells)*
-</pre>
-<pre> Given a collection of cells, add them to the dataflow.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#210
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-cells+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-dataflow===
-====function====
-<pre>
-Usage: *(_build-dataflow_ cs)*
-</pre>
-<pre> Given a collection of cells, build and return a dataflow object</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#188
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-dataflow+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-source-cell===
-====function====
-<pre>
-Usage: *(_build-source-cell_ name init)*
-</pre>
-<pre> Builds a source cell</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#231
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-source-cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-standard-cell===
-====function====
-<pre>
-Usage: *(_build-standard-cell_ name deps fun expr)*
-</pre>
-<pre> Builds a standard cell</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#292
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-standard-cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-validator-cell===
-====function====
-<pre>
-Usage: *(_build-validator-cell_ deps fun expr)*
-</pre>
-<pre> Builds a validator cell</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#298
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-validator-cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===cell===
-====macro====
-<pre>
-Usage: *(_cell_ type & data)*
-</pre>
-<pre> Build a standard cell, like this:
-
- (cell fred
- (`*` ?mary ?joe))
-
-Which creates a cell named fred that is the product of a cell mary and
cell joe
-
-Or:
-
- (cell joe
- (apply `*` ?`*`sally))
-
-Which creates a cell that applies `*` to the collection of all cells named
sally
-
-Or:
-
- (cell :source fred 0)
-
-Which builds a source cell fred with initial value 0
-
-Or:
-
- (cell :validator (when (< ?fred ?sally)
- (throwf "%s must be greater than %s" ?fred ?sally))
-
-Which will perform the validation</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#304
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===display-cell===
-====multimethod====
-_No usage documentation available_
-<pre> A 'readable' form of the cell</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#348
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=display-cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===eval-cell===
-====multimethod====
-_No usage documentation available_
-<pre> Evaluate a dataflow cell. Return `[`changed, old val`]`</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#372
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=eval-cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-cell===
-====function====
-<pre>
-Usage: *(_get-cell_ df name)*
-</pre>
-<pre> Get the single cell named by name</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#94
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-cells===
-====function====
-<pre>
-Usage: *(_get-cells_ df name)*
-</pre>
-<pre> Get all the cells named by name</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#89
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-cells+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-old-value===
-====function====
-<pre>
-Usage: *(_get-old-value_ df env name)*
-</pre>
-<pre> Looks up an old value</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#136
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-old-value+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-source-cells===
-====function====
-<pre>
-Usage: *(_get-source-cells_ df)*
-</pre>
-<pre> Returns a collection of source cells from the dataflow</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#108
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-source-cells+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-value===
-====function====
-<pre>
-Usage: *(_get-value_ df name)*
-</pre>
-<pre> Gets a value from the df matching the passed symbol.
-Signals an error if the name is not present, or if it not a single
-value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#115
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-value+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-value-from-cell===
-====function====
-<pre>
-Usage: *(_get-value-from-cell_ cell)*
-</pre>
-<pre> Given a cell, get its value</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#143
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-value-from-cell+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-values===
-====function====
-<pre>
-Usage: *(_get-values_ df name)*
-</pre>
-<pre> Gets a collection of values from the df by name</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#126
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-values+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===print-dataflow===
-====function====
-<pre>
-Usage: *(_print-dataflow_ df)*
-</pre>
-<pre> Prints a dataflow, one cell per line</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#199
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-dataflow+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===remove-cells===
-====function====
-<pre>
-Usage: *(_remove-cells_ df cells)*
-</pre>
-<pre> Given a collection of cells, remove them from the dataflow.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#218
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=remove-cells+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===source-cell?===
-====function====
-<pre>
-Usage: *(_source-cell?_ cell)*
-</pre>
-<pre> Is this cell a source cell?</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#103
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=source-cell?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===update-values===
-====function====
-<pre>
-Usage: *(_update-values_ df data)*
-</pre>
-<pre> Given a dataflow, and a map of name-value pairs, update the
-dataflow by binding the new values. Each name must be of a source
-cell</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/dataflow.clj#438
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=update-values+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/DatalogApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,714 +0,0 @@
-#summary datalog API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for datalog=
-by Jeffrey Straszheim
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.datalog))
-}}}
-==Overview==
-<pre> A Clojure implementation of Datalog</pre>
-See also: [DatalogOverview]
-
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#build-work-plan build-work-plan] [#run-work-plan run-work-plan]
-
-Variables and Functions in datalog.database:
-[DatalogApiDoc#add-index add-index] [DatalogApiDoc#add-relation
add-relation] [DatalogApiDoc#add-tuple add-tuple] [DatalogApiDoc#add-tuples
add-tuples] [DatalogApiDoc#any-match? any-match?]
[DatalogApiDoc#database-counts database-counts]
[DatalogApiDoc#database-merge database-merge]
[DatalogApiDoc#database-merge-parallel database-merge-parallel]
[DatalogApiDoc#datalog-relation datalog-relation]
[DatalogApiDoc#ensure-relation ensure-relation] [DatalogApiDoc#get-relation
get-relation] [DatalogApiDoc#make-database make-database]
[DatalogApiDoc#merge-relations merge-relations] [DatalogApiDoc#remove-tuple
remove-tuple] [DatalogApiDoc#replace-relation replace-relation]
[DatalogApiDoc#select select]
-
-Variables and Functions in datalog.literals:
-[DatalogApiDoc#adorned-literal adorned-literal] [DatalogApiDoc#build-atom
build-atom] [DatalogApiDoc#build-literal build-literal]
[DatalogApiDoc#build-seed-bindings build-seed-bindings]
[DatalogApiDoc#delta-literal delta-literal] [DatalogApiDoc#display-literal
display-literal] [DatalogApiDoc#get-adorned-bindings get-adorned-bindings]
[DatalogApiDoc#get-base-predicate get-base-predicate]
[DatalogApiDoc#get-cs-from-vs get-cs-from-vs]
[DatalogApiDoc#get-self-bound-cs get-self-bound-cs]
[DatalogApiDoc#get-vs-from-cs get-vs-from-cs] [DatalogApiDoc#join-literal
join-literal] [DatalogApiDoc#literal-appropriate? literal-appropriate?]
[DatalogApiDoc#literal-columns literal-columns]
[DatalogApiDoc#literal-magic? literal-magic?]
[DatalogApiDoc#literal-predicate literal-predicate]
[DatalogApiDoc#literal-vars literal-vars] [DatalogApiDoc#magic-literal
magic-literal] [DatalogApiDoc#negated-literal negated-literal]
[DatalogApiDoc#negated? negated?] [DatalogApiDoc#negative-vars
negative-vars] [DatalogApiDoc#positive-vars positive-vars]
[DatalogApiDoc#positive? positive?] [DatalogApiDoc#project-literal
project-literal]
-
-Variables and Functions in datalog.magic:
-[DatalogApiDoc#adorn-query adorn-query] [DatalogApiDoc#adorn-rules-set
adorn-rules-set] [DatalogApiDoc#build-partial-tuple build-partial-tuple]
[DatalogApiDoc#magic-transform magic-transform]
[DatalogApiDoc#seed-predicate-for-insertion seed-predicate-for-insertion]
[DatalogApiDoc#seed-relation seed-relation] [DatalogApiDoc#seed-rule
seed-rule]
-
-Variables and Functions in datalog.rules:
-[DatalogApiDoc#<- <-] [DatalogApiDoc#?- ?-] [DatalogApiDoc#all-predicates
all-predicates] [DatalogApiDoc#apply-rule apply-rule]
[DatalogApiDoc#compute-sip compute-sip] [DatalogApiDoc#display-query
display-query] [DatalogApiDoc#display-rule display-rule]
[DatalogApiDoc#is-safe? is-safe?] [DatalogApiDoc#make-rules-set
make-rules-set] [DatalogApiDoc#non-base-rules non-base-rules]
[DatalogApiDoc#predicate-map predicate-map] [DatalogApiDoc#return-rule-data
return-rule-data] [DatalogApiDoc#rules-set rules-set]
-
-Variables and Functions in datalog.softstrat:
-[DatalogApiDoc#build-soft-strat-work-plan build-soft-strat-work-plan]
[DatalogApiDoc#get-all-relations get-all-relations]
-
-Variables and Functions in datalog.util:
-[DatalogApiDoc#is-query-var? is-query-var?] [DatalogApiDoc#is-var?
is-var?] [DatalogApiDoc#keys-to-vals keys-to-vals]
[DatalogApiDoc#map-values map-values] [DatalogApiDoc#preduce preduce]
[DatalogApiDoc#reverse-map reverse-map] [DatalogApiDoc#trace-datalog
trace-datalog]
-
-----
-===build-work-plan===
-====function====
-<pre>
-Usage: *(_build-work-plan_ rules query)*
-</pre>
-<pre> Given a list of rules and a query, build a work plan that can be
-used to execute the query.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog.clj#47
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-work-plan+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===run-work-plan===
-====function====
-<pre>
-Usage: *(_run-work-plan_ work-plan database query-bindings)*
-</pre>
-<pre> Given a work plan, a database, and some query bindings, run the
-work plan and return the results.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog.clj#57
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=run-work-plan+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.datalog.database==
-----
-===add-index===
-====function====
-<pre>
-Usage: *(_add-index_ db name key)*
-</pre>
-<pre> Adds an index to an empty relation named name</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#85
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-index+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===add-relation===
-====function====
-<pre>
-Usage: *(_add-relation_ db name keys)*
-</pre>
-<pre> Adds a relation to the database</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#80
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-relation+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===add-tuple===
-====function====
-<pre>
-Usage: *(_add-tuple_ db rel-name tuple)
- (_add-tuple_ rel tuple)*
-</pre>
-<pre> Two forms:
-
-`[`db relation-name tuple`]` adds tuple to the named relation. Returns
-the new database.
-
-`[`rel tuple`]` adds to the relation object. Returns the new
relation.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#171
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-tuple+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===add-tuples===
-====function====
-<pre>
-Usage: *(_add-tuples_ db & tupls)*
-</pre>
-<pre> Adds a collection of tuples to the db, as
-(add-tuples db
- `[`:rel-name :key-1 1 :key-2 2`]`
- `[`:rel-name :key-1 2 :key-2 3`]`)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#206
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-tuples+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===any-match?===
-====function====
-<pre>
-Usage: *(_any-match?_ db rn pt)*
-</pre>
-<pre> Finds if there are any matching records for the partial tuple</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#252
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=any-match?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===database-counts===
-====function====
-<pre>
-Usage: *(_database-counts_ db)*
-</pre>
-<pre> Returns a map with the count of elements in each relation.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#143
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=database-counts+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===database-merge===
-====function====
-<pre>
-Usage: *(_database-merge_ dbs)*
-</pre>
-<pre> Merges databases together</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#276
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=database-merge+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===database-merge-parallel===
-====function====
-<pre>
-Usage: *(_database-merge-parallel_ dbs)*
-</pre>
-<pre> Merges databases together in parallel</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#281
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=database-merge-parallel+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===datalog-relation===
-====function====
-<pre>
-Usage: *(_datalog-relation_ schema data indexes)*
-</pre>
-<pre> Creates a relation</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#75
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=datalog-relation+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===ensure-relation===
-====function====
-<pre>
-Usage: *(_ensure-relation_ db name keys indexes)*
-</pre>
-<pre> If the database lacks the named relation, add it</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#95
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=ensure-relation+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-relation===
-====function====
-<pre>
-Usage: *(_get-relation_ db rel-name)*
-</pre>
-<pre> Get a relation object by name</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#129
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-relation+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===make-database===
-====macro====
-<pre>
-Usage: *(_make-database_ & commands)*
-</pre>
-<pre> Makes a database, like this
-(make-database
- (relation :fred `[`:mary :sue`]`)
- (index :fred :mary)
- (relation :sally `[`:jen :becky`]`)
- (index :sally :jen)
- (index :sally :becky))</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#108
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=make-database+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===merge-relations===
-====function====
-<pre>
-Usage: *(_merge-relations_ r1 r2)*
-</pre>
-<pre> Merges two relations</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#266
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=merge-relations+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===remove-tuple===
-====function====
-<pre>
-Usage: *(_remove-tuple_ db rel-name tuple)
- (_remove-tuple_ rel tuple)*
-</pre>
-<pre> Two forms:
-
-`[`db relation-name tuple`]` removes the tuple from the named relation,
-returns a new database.
-
-`[`rel tuple`]` removes the tuple from the relation. Returns the new
-relation.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#189
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=remove-tuple+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===replace-relation===
-====function====
-<pre>
-Usage: *(_replace-relation_ db rel-name rel)*
-</pre>
-<pre> Add or replace a fully constructed relation object to the
database.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#134
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=replace-relation+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===select===
-====function====
-<pre>
-Usage: *(_select_ db rn pt)*
-</pre>
-<pre> finds all matching tuples to the partial tuple (pt) in the relation
named (rn)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/database.clj#247
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=select+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.datalog.literals==
-----
-===adorned-literal===
-====multimethod====
-_No usage documentation available_
-<pre> When passed a set of bound columns, returns the adorned literal</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#254
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=adorned-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-atom===
-====function====
-<pre>
-Usage: *(_build-atom_ f type)*
-</pre>
-<pre> Returns an unevaluated expression (to be used in a macro) of an
-atom.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#133
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-atom+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-literal===
-====multimethod====
-_No usage documentation available_
-<pre> (Returns an unevaluated expression (to be used in macros) of a
-literal.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#128
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-seed-bindings===
-====function====
-<pre>
-Usage: *(_build-seed-bindings_ s)*
-</pre>
-<pre> Given a seed literal, already adorned and in magic form, convert
-its bound constants to new variables.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#303
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-seed-bindings+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===delta-literal===
-====function====
-<pre>
-Usage: *(_delta-literal_ l)*
-</pre>
-<pre> Given a literal l, return a delta version</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#320
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=delta-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===display-literal===
-====multimethod====
-_No usage documentation available_
-<pre> Converts a struct representing a literal to a normal list</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#164
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=display-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-adorned-bindings===
-====function====
-<pre>
-Usage: *(_get-adorned-bindings_ pred)*
-</pre>
-<pre> Get the bindings from this adorned literal.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#271
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-adorned-bindings+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-base-predicate===
-====function====
-<pre>
-Usage: *(_get-base-predicate_ pred)*
-</pre>
-<pre> Get the base predicate from this predicate.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#276
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-base-predicate+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-cs-from-vs===
-====multimethod====
-_No usage documentation available_
-<pre> From a set of vars, get the columns</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#202
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-cs-from-vs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-self-bound-cs===
-====multimethod====
-_No usage documentation available_
-<pre> Get the columns that are bound withing the literal.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#219
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-self-bound-cs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-vs-from-cs===
-====multimethod====
-_No usage documentation available_
-<pre> From a set of columns, return the vars</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#187
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-vs-from-cs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===join-literal===
-====multimethod====
-_No usage documentation available_
-<pre> Given a database (db), a literal (lit) and a seq of bindings (bs),
-return a new seq of bindings by joining this literal.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#361
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=join-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===literal-appropriate?===
-====multimethod====
-_No usage documentation available_
-<pre> When passed a set of bound vars, determines if this literal can be
-used during this point of a SIP computation.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#236
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=literal-appropriate?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===literal-columns===
-====multimethod====
-_No usage documentation available_
-<pre> Return the column names this applies to</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#48
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=literal-columns+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===literal-magic?===
-====function====
-<pre>
-Usage: *(_literal-magic?_ lit)*
-</pre>
-<pre> Is this literal magic?</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#296
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=literal-magic?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===literal-predicate===
-====multimethod====
-_No usage documentation available_
-<pre> Return the predicate/relation this conditional operates over</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#44
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=literal-predicate+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===literal-vars===
-====multimethod====
-_No usage documentation available_
-<pre> Returns the logic vars used by this literal</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#52
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=literal-vars+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===magic-literal===
-====function====
-<pre>
-Usage: *(_magic-literal_ l)*
-</pre>
-<pre> Create a magic version of this adorned predicate.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#286
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=magic-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===negated-literal===
-====function====
-<pre>
-Usage: *(_negated-literal_ l)*
-</pre>
-<pre> Given a literal l, return a negated version</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#314
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=negated-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===negated?===
-====function====
-<pre>
-Usage: *(_negated?_ l)*
-</pre>
-<pre> Is this literal a negated literal?</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#112
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=negated?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===negative-vars===
-====multimethod====
-_No usage documentation available_
-<pre> Returns the logic vars used in a negative position</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#60
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=negative-vars+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===positive-vars===
-====multimethod====
-_No usage documentation available_
-<pre> Returns the logic vars used in a positive position</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#56
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=positive-vars+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===positive?===
-====function====
-<pre>
-Usage: *(_positive?_ l)*
-</pre>
-<pre> Is this a positive literal?</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#117
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=positive?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===project-literal===
-====function====
-<pre>
-Usage: *(_project-literal_ db lit bs)
- (_project-literal_ db lit bs var?)*
-</pre>
-<pre> Project a stream of bindings onto a literal/relation. Returns a new
-db.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/literals.clj#393
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=project-literal+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.datalog.magic==
-----
-===adorn-query===
-====function====
-<pre>
-Usage: *(_adorn-query_ q)*
-</pre>
-<pre> Adorn a query</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj#26
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=adorn-query+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===adorn-rules-set===
-====function====
-<pre>
-Usage: *(_adorn-rules-set_ rs q)*
-</pre>
-<pre> Adorns the given rules-set for the given query. (rs) is a
-rules-set, (q) is an adorned query.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj#31
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=adorn-rules-set+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===build-partial-tuple===
-====function====
-<pre>
-Usage: *(_build-partial-tuple_ q bindings)*
-</pre>
-<pre> Given a query and a set of bindings, build a partial tuple needed
-to extract the relation from the database.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj#78
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-partial-tuple+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===magic-transform===
-====function====
-<pre>
-Usage: *(_magic-transform_ rs)
- (_magic-transform_ rs i-preds)*
-</pre>
-<pre> Return a magic transformation of an adorned rules-set (rs). The
-(i-preds) are the predicates of the intension database. These
-default to the predicates within the rules-set.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj#98
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=magic-transform+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===seed-predicate-for-insertion===
-====function====
-<pre>
-Usage: *(_seed-predicate-for-insertion_ q)*
-</pre>
-<pre> Given a query, return the predicate to use for database
insertion.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj#90
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=seed-predicate-for-insertion+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===seed-relation===
-====function====
-<pre>
-Usage: *(_seed-relation_ q)*
-</pre>
-<pre> Given a magic form of a query, give back the literal form of its seed
-relation</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj#63
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=seed-relation+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===seed-rule===
-====function====
-<pre>
-Usage: *(_seed-rule_ q)*
-</pre>
-<pre> Given an adorned query, give back its seed rule</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/magic.clj#71
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=seed-rule+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.datalog.rules==
-----
-===<-===
-====macro====
-<pre>
-Usage: *(_<-_ hd & body)*
-</pre>
-<pre> Build a datalog rule. Like this:
-
-(<- (:head :x ?x :y ?y) (:body-1 :x ?x :y ?y) (:body-2 :z ?z)
(not! :body-3 :x ?x) (if > ?y ?z))</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#66
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=<-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===?-===
-====macro====
-<pre>
-Usage: *(_?-_ & q)*
-</pre>
-<pre> Define a datalog query</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#84
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=?-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===all-predicates===
-====function====
-<pre>
-Usage: *(_all-predicates_ rs)*
-</pre>
-<pre> Given a rules-set, return all defined predicates</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#161
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=all-predicates+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===apply-rule===
-====function====
-<pre>
-Usage: *(_apply-rule_ db rule)
- (_apply-rule_ db-1 db-2 rule)*
-</pre>
-<pre> Apply the rule against db-1, adding the results to the appropriate
-relation in db-2. The relation will be created if needed.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#182
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=apply-rule+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===compute-sip===
-====function====
-<pre>
-Usage: *(_compute-sip_ bindings i-preds rule)*
-</pre>
-<pre> Given a set of bound column names, return an adorned sip for this
-rule. A set of intensional predicates should be provided to
-determine what should be adorned.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#98
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=compute-sip+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===display-query===
-====function====
-<pre>
-Usage: *(_display-query_ query)*
-</pre>
-<pre> Return a query in a readable format.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#37
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=display-query+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===display-rule===
-====function====
-<pre>
-Usage: *(_display-rule_ rule)*
-</pre>
-<pre> Return the rule in a readable format.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#30
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=display-rule+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===is-safe?===
-====function====
-<pre>
-Usage: *(_is-safe?_ rule)*
-</pre>
-<pre> Is the rule safe according to the datalog protocol?</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#45
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=is-safe?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===make-rules-set===
-====function====
-<pre>
-Usage: *(_make-rules-set_ rs)*
-</pre>
-<pre> Given an existing set of rules, make it a 'rules-set' for
-printing.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#127
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=make-rules-set+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===non-base-rules===
-====function====
-<pre>
-Usage: *(_non-base-rules_ rs)*
-</pre>
-<pre> Return a collection of rules that depend, somehow, on other
rules</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#166
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=non-base-rules+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===predicate-map===
-====function====
-<pre>
-Usage: *(_predicate-map_ rs)*
-</pre>
-<pre> Given a rules-set, return a map of rules keyed by their predicates.
-Each value will be a set of rules.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#151
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=predicate-map+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===return-rule-data===
-====function====
-<pre>
-Usage: *(_return-rule-data_ rule)*
-</pre>
-<pre> Returns an untypted rule that will be fully printed</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#79
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=return-rule-data+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===rules-set===
-====function====
-<pre>
-Usage: *(_rules-set_ & rules)*
-</pre>
-<pre> Given a collection of rules return a rules set</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/rules.clj#135
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=rules-set+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.datalog.softstrat==
-----
-===build-soft-strat-work-plan===
-====function====
-<pre>
-Usage: *(_build-soft-strat-work-plan_ rs q)*
-</pre>
-<pre> Return a work plan for the given rules-set and query</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/softstrat.clj#115
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=build-soft-strat-work-plan+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-all-relations===
-====function====
-<pre>
-Usage: *(_get-all-relations_ ws)*
-</pre>
-<pre> Return a set of all relation names defined in this workplan</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/softstrat.clj#121
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-all-relations+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.datalog.util==
-----
-===is-query-var?===
-====function====
-<pre>
-Usage: *(_is-query-var?_ sym)*
-</pre>
-<pre> Is this a query variable: e.g. a symbol prefixed with ??</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj#33
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=is-query-var?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===is-var?===
-====function====
-<pre>
-Usage: *(_is-var?_ sym)*
-</pre>
-<pre> Is this a logic variable: e.g. a symbol prefixed with a ?</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj#25
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=is-var?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===keys-to-vals===
-====function====
-<pre>
-Usage: *(_keys-to-vals_ m ks)*
-</pre>
-<pre> Given a map and a collection of keys, return the collection of
vals</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj#49
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=keys-to-vals+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===map-values===
-====function====
-<pre>
-Usage: *(_map-values_ f hash)*
-</pre>
-<pre> Like map, but works over the values of a hash map</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj#41
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=map-values+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===preduce===
-====function====
-<pre>
-Usage: *(_preduce_ f data)*
-</pre>
-<pre> Similar to merge-with, but the contents of each key are merged in
-parallel using f.
-
-f - a function of 2 arguments.
-data - a collection of hashes.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj#62
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=preduce+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===reverse-map===
-====function====
-<pre>
-Usage: *(_reverse-map_ m)*
-</pre>
-<pre> Reverse the keys/values of a map</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj#54
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=reverse-map+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===trace-datalog===
-====macro====
-<pre>
-Usage: *(_trace-datalog_ & body)*
-</pre>
-<pre> If `*`test-datalog`*` is set to true, run the enclosed commands</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/datalog/util.clj#82
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=trace-datalog+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/DefApiDoc.wiki Thu Jun 4 16:01:05 2009
+++ /dev/null
@@ -1,148 +0,0 @@
-#summary def API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for def=
-by Stephen C. Gilardi
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.def))
-}}}
-==Overview==
-<pre> def.clj provides variants of def that make including doc strings and
-making private definitions more succinct.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#defalias defalias] [#defhinted defhinted] [#defmacro- defmacro-] [#defnk
defnk] [#defonce- defonce-] [#defstruct- defstruct-] [#defunbound
defunbound] [#defunbound- defunbound-] [#defvar defvar] [#defvar- defvar-]
[#name-with-attributes name-with-attributes]
-
-----
-===defalias===
-====macro====
-<pre>
-Usage: *(_defalias_ name orig)
- (_defalias_ name orig doc)*
-</pre>
-<pre> Defines an alias for a var: a new var with the same root binding (if
-any) and similar metadata. The metadata of the alias is its initial
-metadata (as provided by def) merged into the metadata of the
original.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#66
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defalias+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defhinted===
-====macro====
-<pre>
-Usage: *(_defhinted_ sym init)*
-</pre>
-<pre> Defines a var with a type hint matching the class of the given
-init. Be careful about using any form of 'def' or 'binding' to a
-value of a different type. See http://paste.lisp.org/display/73344</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#83
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defhinted+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defmacro-===
-====macro====
-<pre>
-Usage: *(_defmacro-_ name & decls)*
-</pre>
-<pre> Same as defmacro but yields a private definition</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#39
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defmacro-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defnk===
-====macro====
-<pre>
-Usage: *(_defnk_ fn-name & fn-tail)*
-</pre>
-<pre> Define a function accepting keyword arguments. Symbols up to the
first
-keyword in the parameter list are taken as positional arguments. Then
-an alternating sequence of keywords and defaults values is expected. The
-values of the keyword arguments are available in the function body by
-virtue of the symbol corresponding to the keyword (cf. :keys
destructuring).
-defnk accepts an optional docstring as well as an optional metadata
map.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#120
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defnk+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defonce-===
-====macro====
-<pre>
-Usage: *(_defonce-_ name expr)
- (_defonce-_ name expr doc)*
-</pre>
-<pre> Same as defonce but yields a private definition</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#59
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defonce-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defstruct-===
-====macro====
-<pre>
-Usage: *(_defstruct-_ name & decls)*
-</pre>
-<pre> Same as defstruct but yields a private definition</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#54
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defstruct-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defunbound===
-====macro====
-<pre>
-Usage: *(_defunbound_ name)
- (_defunbound_ name doc)*
-</pre>
-<pre> Defines an unbound var with optional doc string</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#32
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defunbound+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defunbound-===
-====macro====
-<pre>
-Usage: *(_defunbound-_ name & decls)*
-</pre>
-<pre> Same as defunbound but yields a private definition</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#49
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defunbound-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defvar===
-====macro====
-<pre>
-Usage: *(_defvar_ name)
- (_defvar_ name init)
- (_defvar_ name init doc)*
-</pre>
-<pre> Defines a var with an optional intializer and doc string</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#23
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defvar+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defvar-===
-====macro====
-<pre>
-Usage: *(_defvar-_ name & decls)*
-</pre>
-<pre> Same as defvar but yields a private definition</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#44
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defvar-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===name-with-attributes===
-====function====
-<pre>
-Usage: *(_name-with-attributes_ name macro-args)*
-</pre>
-<pre> To be used in macro definitions.
-Handles optional docstrings and attribute maps for a name to be defined
-in a list of macro arguments. If the first macro argument is a string,
-it is added as a docstring to name and removed from the macro argument
-list. If afterwards the first macro argument is a map, its entries are
-added to the name's metadata map and the map is removed from the
-macro argument list. The return value is a vector containing the name
-with its extended metadata map and the list of unprocessed macro
-arguments.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/def.clj#94
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=name-with-attributes+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/DuckStreamsApiDoc.wiki Fri Jun 5 15:30:52 2009
+++ /dev/null
@@ -1,242 +0,0 @@
-#summary duck-streams API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for duck-streams=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.duck-streams))
-}}}
-==Overview==
-<pre> This file defines "duck-typed" I/O utility functions for Clojure.
-The 'reader' and 'writer' functions will open and return an
-instance of java.io.BufferedReader and java.io.PrintWriter,
-respectively, for a variety of argument types -- filenames as
-strings, URLs, java.io.File's, etc. 'reader' even works on http
-URLs.
-
-Note: this is not really "duck typing" as implemented in languages
-like Ruby. A better name would have been "do-what-I-mean-streams"
-or "just-give-me-a-stream", but ducks are funnier.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#*_append-to-writer_* *append-to-writer*] [#*_buffer-size_*
*buffer-size*] [#*_byte-array-type_* *byte-array-type*]
[#*_default-encoding_* *default-encoding*] [#append-spit append-spit]
[#append-writer append-writer] [#copy copy] [#file-str file-str]
[#make-parents make-parents] [#pwd pwd] [#read-lines read-lines] [#reader
reader] [#slurp_* slurp*] [#spit spit] [#to-byte-array to-byte-array]
[#with-in-reader with-in-reader] [#with-out-append-writer
with-out-append-writer] [#with-out-writer with-out-writer] [#write-lines
write-lines] [#writer writer]
-
-----
-===`*`append-to-writer`*`===
-====var====
-<pre> If true, writer and spit will open files in append mode.
-Defaults to false. Use append-writer or append-spit.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#140
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*append-to-writer*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`buffer-size`*`===
-====var====
-<pre> Size, in bytes or characters, of the buffer used when
-copying streams.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#75
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*buffer-size*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`byte-array-type`*`===
-====var====
-<pre> Type object for a Java primitive byte array.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#80
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*byte-array-type*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`default-encoding`*`===
-====var====
-<pre> Name of the default encoding to use when reading & writing.
-Default is UTF-8.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#70
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*default-encoding*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===append-spit===
-====function====
-<pre>
-Usage: *(_append-spit_ f content)*
-</pre>
-<pre> Like spit but appends to file.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#255
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=append-spit+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===append-writer===
-====function====
-<pre>
-Usage: *(_append-writer_ x)*
-</pre>
-<pre> Like writer but opens file for appending. Does not work on streams
-that are already open.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#207
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=append-writer+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===copy===
-====multimethod====
-<pre>
-Usage: *(_copy_ input output)*
-</pre>
-<pre> Copies input to output. Returns nil.
-Input may be an InputStream, Reader, File, byte`[``]`, or String.
-Output may be an OutputStream, Writer, or File.
-
-Does not close any streams except those it opens itself
-(on a File).
-
-Writing a File fails if the parent directory does not exist.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#291
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=copy+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===file-str===
-====function====
-<pre>
-Usage: *(_file-str_ & args)*
-</pre>
-<pre> Concatenates args as strings and returns a java.io.File. Replaces
-all / and \ with File/separatorChar. Replaces ~ at the start of
-the path with the user.home system property.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#85
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=file-str+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===make-parents===
-====function====
-<pre>
-Usage: *(_make-parents_ file)*
-</pre>
-<pre> Creates all parent directories of file.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#378
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=make-parents+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pwd===
-====function====
-<pre>
-Usage: *(_pwd_)*
-</pre>
-<pre> Returns current working directory as a String. (Like UNIX 'pwd'.)
-Note: In Java, you cannot change the current working directory.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#261
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pwd+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===read-lines===
-====function====
-<pre>
-Usage: *(_read-lines_ f)*
-</pre>
-<pre> Like clojure.core/line-seq but opens f with reader. Automatically
-closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#226
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=read-lines+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===reader===
-====multimethod====
-<pre>
-Usage: *(_reader_ x)*
-</pre>
-<pre> Attempts to coerce its argument into an open
-java.io.BufferedReader. Argument may be an instance of Reader,
-BufferedReader, InputStream, File, URI, URL, or String.
-
-If argument is a String, it tries to resolve it first as a URI, then
-as a local file name. URIs with a 'file' protocol are converted to
-local file names. Uses `*`default-encoding`*` as the text encoding.
-
-Should be used inside with-open to ensure the Reader is properly
-closed.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#99
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=reader+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===slurp`*`===
-====function====
-<pre>
-Usage: *(_slurp`*`_ f)*
-</pre>
-<pre> Like clojure.core/slurp but opens f with reader.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#237
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=slurp*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===spit===
-====function====
-<pre>
-Usage: *(_spit_ f content)*
-</pre>
-<pre> Opposite of slurp. Opens f with writer, writes content, then
-closes f.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#248
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=spit+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===to-byte-array===
-====multimethod====
-<pre>
-Usage: *(_to-byte-array_ arg)*
-</pre>
-<pre> Converts argument into a Java byte array. Argument may be
-a String, File, InputStream, or Reader. If the argument is already
-a byte array, returns it.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#383
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=to-byte-array+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-in-reader===
-====macro====
-<pre>
-Usage: *(_with-in-reader_ f & body)*
-</pre>
-<pre> Opens a PushbackReader on f, binds it to `*`in`*`, and evaluates
body.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#284
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-in-reader+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-out-append-writer===
-====macro====
-<pre>
-Usage: *(_with-out-append-writer_ f & body)*
-</pre>
-<pre> Like with-out-writer but appends to file.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#277
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-out-append-writer+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-out-writer===
-====macro====
-<pre>
-Usage: *(_with-out-writer_ f & body)*
-</pre>
-<pre> Opens a writer on f, binds it to `*`out`*`, and evalutes body.
-Anything printed within body will be written to f.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#269
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-out-writer+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===write-lines===
-====function====
-<pre>
-Usage: *(_write-lines_ f lines)*
-</pre>
-<pre> Writes lines (a seq) to f, separated by newlines. f is opened with
-writer, and automatically closed at the end of the sequence.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#215
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=write-lines+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===writer===
-====multimethod====
-<pre>
-Usage: *(_writer_ x)*
-</pre>
-<pre> Attempts to coerce its argument into an open java.io.PrintWriter
-wrapped around a java.io.BufferedWriter. Argument may be an
-instance of Writer, PrintWriter, BufferedWriter, OutputStream, File,
-URI, URL, or String.
-
-If argument is a String, it tries to resolve it first as a URI, then
-as a local file name. URIs with a 'file' protocol are converted to
-local file names.
-
-Should be used inside with-open to ensure the Writer is properly
-closed.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/duck_streams.clj#146
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=writer+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/ErrorKitApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,130 +0,0 @@
-#summary error-kit API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for error-kit=
-by Chris Houser
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.error-kit))
-}}}
-==Overview==
-<pre> EXPERIMENTAL
-System for defining and using custom errors
-Please contact Chouser if you have any suggestions for better names
-or API adjustments.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#bind-continue bind-continue] [#deferror deferror] [#do-not-handle
do-not-handle] [#error error] [#handle handle] [#raise raise] [#raise_*
raise*] [#throw-msg throw-msg] [#with-handler with-handler]
-
-----
-===bind-continue===
-====function====
-<pre>
-Usage: *(_bind-continue_ continue-name `[`args`*``]` & body)*
-</pre>
-<pre> Special form to be used inside a 'with-handler'.
-Control can be passed to this 'continue' form from a 'raise' enclosed
-in this with-handler's dynamic scope, when this 'continue-name' is
-given to a 'continue' form.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#150
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=bind-continue+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===deferror===
-====macro====
-<pre>
-Usage: *(_deferror_ name `[`parent-error?`]` doc-string? `[`args`*``]` &
body)
- (_deferror_ name `[`parent-error?`]` doc-string? args-destruct-map
& body)*
-</pre>
-<pre> Define a new error type</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#59
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=deferror+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===do-not-handle===
-====macro====
-<pre>
-Usage: *(_do-not-handle_)*
-</pre>
-<pre> Use in a tail position of a 'handle' form to indicate 'raise' should
-not consider the error handled, but should continue searching for an
-appropriate 'handle' form. Allows finer-grain control over catching
-than just the error type.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#117
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=do-not-handle+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===error===
-====function====
-<pre>
-Usage: *(_error_ details)*
-</pre>
-<pre> Base type for all error-kit errors</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#46
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=error+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===handle===
-====function====
-<pre>
-Usage: *(_handle_ error-name? `[`args`*``]` & body)
- (_handle_ error-name? args-destruct-map-args & body)*
-</pre>
-<pre> Special form to be used inside a 'with-handler'. When
-any error is 'raised' from withing the dynamic scope of 'body' that
-is of error-name's type or a derived type, the args will be bound
-and the body executed. If no 'error-name' is given, the body will
-be executed for regardless of the type of error raised. The body
-may return a value, in which case that will be the return value of
-the entire 'with-handler' form, or it may use any of the special
-return forms, 'do-not-handle', 'continue-with', or 'continue'.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#138
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=handle+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===raise===
-====macro====
-<pre>
-Usage: *(_raise_ err-name & args)*
-</pre>
-<pre> Raise an error of the type err-name, constructed with the given
args</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#110
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=raise+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===raise`*`===
-====function====
-<pre>
-Usage: *(_raise`*`_ err)*
-</pre>
-<pre> Raise the given error object, best if created by an error
-constructor defined with deferror. See also 'raise' macro.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#86
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=raise*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===throw-msg===
-====macro====
-<pre>
-Usage: *(_throw-msg_ class-name)*
-</pre>
-<pre> Returns a function that throws a Java Exception with the given
-name. Useful to associate a new error-kit error type with a
-particular Java Exception class, via the :unhandled error key.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#39
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=throw-msg+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-handler===
-====macro====
-<pre>
-Usage: *(_with-handler_ & forms)*
-</pre>
-<pre> This is error-kit's dynamic scope form. The body will be executed
-in a dynamic context that includes all of the following 'handle' and
-'bind-continue' forms.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/error_kit.clj#163
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-handler+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/ExceptApiDoc.wiki Fri Jun 5 23:55:02 2009
+++ /dev/null
@@ -1,83 +0,0 @@
-#summary except API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for except=
-by Stephen C. Gilardi
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.except))
-}}}
-==Overview==
-<pre> Provides functions that make it easy to specify the class, cause, and
-message when throwing an Exception or Error. The optional message is
-formatted using clojure.core/format.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#throw-arg throw-arg] [#throw-if throw-if] [#throw-if-not throw-if-not]
[#throwf throwf]
-
-----
-===throw-arg===
-====function====
-<pre>
-Usage: *(_throw-arg_ & args)*
-</pre>
-<pre> Throws an IllegalArgumentException. All arguments are optional:
-
- cause? format? format-args`*`
-
-- cause defaults to nil, if present it must be a Throwable
-- format is a format string for clojure.core/format
-- format-args are objects that correspond to format specifiers in
- format.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/except.clj#57
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=throw-arg+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===throw-if===
-====function====
-<pre>
-Usage: *(_throw-if_ test & args)*
-</pre>
-<pre> Throws an Exception or Error if test is true. args are those
documented
-for throwf.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/except.clj#43
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=throw-if+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===throw-if-not===
-====function====
-<pre>
-Usage: *(_throw-if-not_ test & args)*
-</pre>
-<pre> Throws an Exception or Error if test is false. args are those
documented
-for throwf.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/except.clj#50
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=throw-if-not+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===throwf===
-====function====
-<pre>
-Usage: *(_throwf_ & args)*
-</pre>
-<pre> Throws an Exception or Error with an optional message formatted using
-clojure.core/format. All arguments are optional:
-
- class? cause? format? format-args`*`
-
-- class defaults to Exception, if present it must name a kind of
- Throwable
-- cause defaults to nil, if present it must be a Throwable
-- format is a format string for clojure.core/format
-- format-args are objects that correspond to format specifiers in
- format.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/except.clj#28
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=throwf+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/FcaseApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,108 +0,0 @@
-#summary fcase API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for fcase=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.fcase))
-}}}
-==Overview==
-<pre> This file defines a generic "case" macro called "fcase" which takes
-the equality-testing function as an argument. It also defines a
-traditional "case" macro that tests using "`=`" and variants that
-test for regular expressions and class membership.
-
-
-Note (December 23, 2008): This library has been supplanted by the
-inclusion of "condp" in clojure.core as of Clojure SVN rev. 1180.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#case case] [#fcase fcase] [#in-case in-case] [#instance-case
instance-case] [#re-case re-case]
-
-----
-===case===
-====macro====
-<pre>
-Usage: *(_case_ test-value & clauses)*
-</pre>
-<pre> Like cond, but test-value is compared against the value of each
-test expression with `=`. If they are equal, executes the "body"
-expression. Optional last expression is executed if none of the
-test expressions match.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fcase.clj#77
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=case+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===fcase===
-====macro====
-<pre>
-Usage: *(_fcase_ compare-fn case-value & test-expr-clauses)*
-</pre>
-<pre> Generic switch/case macro. 'fcase' is short for 'function case'.
-
-The 'compare-fn' is a fn of two arguments.
-
-The 'test-expr-clauses' are value-expression pairs without
-surrounding parentheses, like in Clojure's 'cond'.
-
-The 'case-value' is evaluated once and cached. Then, 'compare-fn'
-is called once for each clause, with the clause's test value as its
-first argument and 'case-value' as its second argument. If
-'compare-fn' returns logical true, the clause's expression is
-evaluated and returned. If 'compare-fn' returns false/nil, we go to
-the next test value.
-
-If 'test-expr-clauses' contains an odd number of items, the last
-item is the default expression evaluated if no case-value matches.
-If there is no default expression and no case-value matches, fcase
-returns nil.
-
-See specific forms of this macro in 'case' and 're-case'.
-
-The test expressions in 'fcase' are always evaluated linearly, in
-order. For a large number of case expressions it may be more
-efficient to use a hash lookup.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fcase.clj#38
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=fcase+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===in-case===
-====macro====
-<pre>
-Usage: *(_in-case_ test-value & clauses)*
-</pre>
-<pre> Like case, but test expressions are sequences. The test expression
-is true if any item in the sequence is equal (tested with '`=`') to
-the test value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fcase.clj#101
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=in-case+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===instance-case===
-====macro====
-<pre>
-Usage: *(_instance-case_ test-value & clauses)*
-</pre>
-<pre> Like case, but the test expressions are Java class names, tested with
-'instance?'.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fcase.clj#91
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=instance-case+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===re-case===
-====macro====
-<pre>
-Usage: *(_re-case_ test-value & clauses)*
-</pre>
-<pre> Like case, but the test expressions are regular expressions, tested
-with re-find.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fcase.clj#85
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=re-case+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/FindNamespacesApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,169 +0,0 @@
-#summary find-namespaces API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for find-namespaces=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.find-namespaces))
-}}}
-==Overview==
-<pre> Search for ns declarations in dirs, JARs, or CLASSPATH</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#clojure-source-file? clojure-source-file?] [#clojure-sources-in-jar
clojure-sources-in-jar] [#comment? comment?] [#find-clojure-sources-in-dir
find-clojure-sources-in-dir] [#find-namespaces-in-dir
find-namespaces-in-dir] [#find-namespaces-in-jarfile
find-namespaces-in-jarfile] [#find-namespaces-on-classpath
find-namespaces-on-classpath] [#find-ns-decls-in-dir find-ns-decls-in-dir]
[#find-ns-decls-in-jarfile find-ns-decls-in-jarfile]
[#find-ns-decls-on-classpath find-ns-decls-on-classpath] [#ns-decl?
ns-decl?] [#read-file-ns-decl read-file-ns-decl] [#read-ns-decl
read-ns-decl] [#read-ns-decl-from-jarfile-entry
read-ns-decl-from-jarfile-entry]
-
-----
-===clojure-source-file?===
-====function====
-<pre>
-Usage: *(_clojure-source-file?_ file)*
-</pre>
-<pre> Returns true if file is a normal file with a .clj extension.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#28
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=clojure-source-file?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===clojure-sources-in-jar===
-====function====
-<pre>
-Usage: *(_clojure-sources-in-jar_ jar-file)*
-</pre>
-<pre> Returns a sequence of filenames ending in .clj found in the JAR
file.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#88
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=clojure-sources-in-jar+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===comment?===
-====function====
-<pre>
-Usage: *(_comment?_ form)*
-</pre>
-<pre> Returns true if form is a (comment ...)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#42
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=comment?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===find-clojure-sources-in-dir===
-====function====
-<pre>
-Usage: *(_find-clojure-sources-in-dir_ dir)*
-</pre>
-<pre> Searches recursively under dir for Clojure source files (.clj).
-Returns a sequence of File objects, in breadth-first sort order.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#34
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=find-clojure-sources-in-dir+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===find-namespaces-in-dir===
-====function====
-<pre>
-Usage: *(_find-namespaces-in-dir_ dir)*
-</pre>
-<pre> Searches dir recursively for (ns ...) declarations in Clojure
-source files; returns the symbol names of the declared namespaces.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#79
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=find-namespaces-in-dir+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===find-namespaces-in-jarfile===
-====function====
-<pre>
-Usage: *(_find-namespaces-in-jarfile_ jarfile)*
-</pre>
-<pre> Searches the JAR file for Clojure source files containing (ns ...)
-declarations. Returns a sequence of the symbol names of the
-declared namespaces.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#112
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=find-namespaces-in-jarfile+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===find-namespaces-on-classpath===
-====function====
-<pre>
-Usage: *(_find-namespaces-on-classpath_)*
-</pre>
-<pre> Searches CLASSPATH (both directories and JAR files) for Clojure
-source files containing (ns ...) declarations. Returns a sequence
-of the symbol names of the declared namespaces.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#131
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=find-namespaces-on-classpath+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===find-ns-decls-in-dir===
-====function====
-<pre>
-Usage: *(_find-ns-decls-in-dir_ dir)*
-</pre>
-<pre> Searches dir recursively for (ns ...) declarations in Clojure
-source files; returns the unevaluated ns declarations.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#73
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=find-ns-decls-in-dir+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===find-ns-decls-in-jarfile===
-====function====
-<pre>
-Usage: *(_find-ns-decls-in-jarfile_ jarfile)*
-</pre>
-<pre> Searches the JAR file for Clojure source files containing (ns ...)
-declarations; returns the unevaluated ns declarations.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#104
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=find-ns-decls-in-jarfile+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===find-ns-decls-on-classpath===
-====function====
-<pre>
-Usage: *(_find-ns-decls-on-classpath_)*
-</pre>
-<pre> Searches CLASSPATH (both directories and JAR files) for Clojure
-source files containing (ns ...) declarations. Returns a sequence
-of the unevaluated ns declaration forms.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#122
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=find-ns-decls-on-classpath+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===ns-decl?===
-====function====
-<pre>
-Usage: *(_ns-decl?_ form)*
-</pre>
-<pre> Returns true if form is a (ns ...) declaration.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#47
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=ns-decl?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===read-file-ns-decl===
-====function====
-<pre>
-Usage: *(_read-file-ns-decl_ file)*
-</pre>
-<pre> Attempts to read a (ns ...) declaration from file, and returns the
-unevaluated form. Returns nil if read fails, or if the first form
-is not a ns declaration.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#65
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=read-file-ns-decl+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===read-ns-decl===
-====function====
-<pre>
-Usage: *(_read-ns-decl_ rdr)*
-</pre>
-<pre> Attempts to read a (ns ...) declaration from rdr, and returns the
-unevaluated form. Returns nil if read fails or if a ns declaration
-cannot be found. The ns declaration must be the first Clojure form
-in the file, except for (comment ...) forms.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#52
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=read-ns-decl+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===read-ns-decl-from-jarfile-entry===
-====function====
-<pre>
-Usage: *(_read-ns-decl-from-jarfile-entry_ jarfile entry-name)*
-</pre>
-<pre> Attempts to read a (ns ...) declaration from the named entry in the
-JAR file, and returns the unevaluated form. Returns nil if the read
-fails, or if the first form is not a ns declaration.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/find_namespaces.clj#93
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=read-ns-decl-from-jarfile-entry+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/FnmapApiDoc.wiki Fri Jun 5 15:05:47 2009
+++ /dev/null
@@ -1,48 +0,0 @@
-#summary fnmap API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for fnmap=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.fnmap))
-}}}
-==Overview==
-<pre> Maps that dispatch get/assoc to user-defined functions.
-
-Note: requires AOT-compilation</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#fnmap fnmap]
-
-----
-===fnmap===
-====function====
-<pre>
-Usage: *(_fnmap_ getter setter)
- (_fnmap_ getter setter & keyvals)*
-</pre>
-<pre> Creates a fnmap, or functional map. A fnmap behaves like an
-ordinary Clojure map, except that calls to get and assoc are
-filtered through user-defined getter and setter functions, which
-operate on an internal map.
-
-(getter m key) should return a value for key.
-
-(setter m key value) should assoc key with value and return a new
-map for m.
-
-All other map operations are passed through to the internal map.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/fnmap.clj#19
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=fnmap+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GenHtmlDocsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,48 +0,0 @@
-#summary gen-html-docs API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for gen-html-docs=
-by Craig Andera
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.gen-html-docs))
-}}}
-==Overview==
-<pre> Generates a single HTML page that contains the documentation for
-one or more Clojure libraries.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#generate-documentation generate-documentation]
[#generate-documentation-to-file generate-documentation-to-file]
-
-----
-===generate-documentation===
-====function====
-<pre>
-Usage: *(_generate-documentation_ libs)*
-</pre>
-<pre> Returns a string which is the HTML documentation for the libraries
-named by libs. Libs is a vector of symbols identifying Clojure
-libraries.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/gen_html_docs.clj#430
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=generate-documentation+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===generate-documentation-to-file===
-====function====
-<pre>
-Usage: *(_generate-documentation-to-file_ path libs)*
-</pre>
-<pre> Calls generate-documentation on the libraries named by libs and
-emits the generated HTML to the path named by path.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/gen_html_docs.clj#456
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=generate-documentation-to-file+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GenericArithmeticApiDoc.wiki Fri Jun 5 15:30:52 2009
+++ /dev/null
@@ -1,103 +0,0 @@
-#summary generic.arithmetic API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for generic.arithmetic=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.generic.arithmetic))
-}}}
-==Overview==
-<pre> Generic arithmetic interface
-This library defines generic versions of + - `*` / as multimethods
-that can be defined for any type. The minimal required
-implementations for a type are binary + and `*` plus unary - and /.
-Everything else is derived from these automatically. Explicit
-binary definitions for - and / can be provided for
-efficiency reasons.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#* *] [#+ +] [#- -] [#/ /] [#defmethod_* defmethod*] [#qsym qsym]
-
-----
-===`*`===
-====multimethod====
-<pre>
-Usage: *(_`*`_ x)
- (_`*`_ x y)
- (_`*`_ x y & more)*
-</pre>
-<pre> Return the product of all arguments. The minimal implementation for
type
-::my-type is the binary form with dispatch value
`[`::my-type ::my-type`]`.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/arithmetic.clj#111
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===+===
-====multimethod====
-<pre>
-Usage: *(_+_ x)
- (_+_ x y)
- (_+_ x y & more)*
-</pre>
-<pre> Return the sum of all arguments. The minimal implementation for type
-::my-type is the binary form with dispatch value
`[`::my-type ::my-type`]`.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/arithmetic.clj#45
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=++package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===-===
-====multimethod====
-<pre>
-Usage: *(_-_ x)
- (_-_ x y)
- (_-_ x y & more)*
-</pre>
-<pre> Return the difference of the first argument and the sum of all other
-arguments. The minimal implementation for type ::my-type is the binary
-form with dispatch value `[`::my-type ::my-type`]`.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/arithmetic.clj#77
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===/===
-====multimethod====
-<pre>
-Usage: *(_/_ x)
- (_/_ x y)
- (_/_ x y & more)*
-</pre>
-<pre> Return the quotient of the first argument and the product of all
other
-arguments. The minimal implementation for type ::my-type is the binary
-form with dispatch value `[`::my-type ::my-type`]`.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/arithmetic.clj#143
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=/+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defmethod`*`===
-====macro====
-<pre>
-Usage: *(_defmethod`*`_ ns name & args)*
-</pre>
-<pre> Define a method implementation for the multimethod name in namespace
ns.
-Required for implementing the division function from another
namespace.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/arithmetic.clj#173
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defmethod*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===qsym===
-====macro====
-<pre>
-Usage: *(_qsym_ ns sym)*
-</pre>
-<pre> Create the qualified symbol corresponding to sym in namespace ns.
-Required to access the division function from another namespace,
-e.g. as (qsym clojure.contrib.generic.arithmetic /).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/arithmetic.clj#180
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=qsym+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GenericCollectionApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,99 +0,0 @@
-#summary generic.collection API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for generic.collection=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.generic.collection))
-}}}
-==Overview==
-<pre> Generic arithmetic interface
-This library defines generic versions of common
-collection-related functions as multimethods that can be
-defined for any type.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#assoc assoc] [#conj conj] [#dissoc dissoc] [#empty empty] [#get get]
[#into into] [#seq seq]
-
-----
-===assoc===
-====multimethod====
-<pre>
-Usage: *(_assoc_ coll & key-val-pairs)*
-</pre>
-<pre> Returns a new collection in which the values corresponding to the
-given keys are updated by the given values. Each type of collection
-can have specific restrictions on the possible keys.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj#26
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=assoc+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===conj===
-====multimethod====
-<pre>
-Usage: *(_conj_ coll & xs)*
-</pre>
-<pre> Returns a new collection resulting from adding all xs to coll.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj#42
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=conj+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===dissoc===
-====multimethod====
-<pre>
-Usage: *(_dissoc_ coll & keys)*
-</pre>
-<pre> Returns a new collection in which the entries corresponding to the
-given keys are removed. Each type of collection can have specific
-restrictions on the possible keys.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj#54
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=dissoc+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===empty===
-====multimethod====
-<pre>
-Usage: *(_empty_ coll)*
-</pre>
-<pre> Returns an empty collection of the same kind as the argument</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj#68
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=empty+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get===
-====multimethod====
-<pre>
-Usage: *(_get_ coll key)
- (_get_ coll key not-found)*
-</pre>
-<pre> Returns the element of coll referred to by key. Each type of
collection
-can have specific restrictions on the possible keys.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj#80
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===into===
-====multimethod====
-<pre>
-Usage: *(_into_ to from)*
-</pre>
-<pre> Returns a new coll consisting of to-coll with all of the items of
-from-coll conjoined.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj#95
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=into+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===seq===
-====multimethod====
-<pre>
-Usage: *(_seq_ s)*
-</pre>
-<pre> Returns a seq on the object s.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/collection.clj#109
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=seq+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GenericComparisonApiDoc.wiki Fri Jun 5 15:30:52 2009
+++ /dev/null
@@ -1,105 +0,0 @@
-#summary generic.comparison API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for generic.comparison=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.generic.comparison))
-}}}
-==Overview==
-<pre> Generic comparison interface
-This library defines generic versions of `=` < > <`=` >`=` zero?
-as multimethods that can be defined for any type. Of the
-greater/less-than relations, types must minimally implement >.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#< <] [#<_= <=] [#= =] [#> >] [#>_= >=] [#zero? zero?]
-
-----
-===<===
-====multimethod====
-<pre>
-Usage: *(_<_ x)
- (_<_ x y)
- (_<_ x y & more)*
-</pre>
-<pre> Return true if each argument is smaller than the following ones.
-The minimal implementation for type ::my-type is the binary form
-with dispatch value `[`::my-type ::my-type`]`. A default implementation
-is provided in terms of >.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/comparison.clj#77
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=<+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===<`=`===
-====multimethod====
-<pre>
-Usage: *(_<`=`_ x)
- (_<`=`_ x y)
- (_<`=`_ x y & more)*
-</pre>
-<pre> Return true if each arguments is smaller than or equal to the
following
-ones. The minimal implementation for type ::my-type is the binary form
-with dispatch value `[`::my-type ::my-type`]`. A default implementation
-is provided in terms of >.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/comparison.clj#129
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=<=+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`=`===
-====multimethod====
-<pre>
-Usage: *(_`=`_ x)
- (_`=`_ x y)
- (_`=`_ x y & more)*
-</pre>
-<pre> Return true if all arguments are equal. The minimal implementation
for type
-::my-type is the binary form with dispatch value
`[`::my-type ::my-type`]`.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/comparison.clj#36
Source]
[http://www.google.com/codesearch?hl=en&lr=&q==+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===>===
-====multimethod====
-<pre>
-Usage: *(_>_ x)
- (_>_ x y)
- (_>_ x y & more)*
-</pre>
-<pre> Return true if each argument is larger than the following ones.
-The minimal implementation for type ::my-type is the binary form
-with dispatch value `[`::my-type ::my-type`]`.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/comparison.clj#56
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=>+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===>`=`===
-====multimethod====
-<pre>
-Usage: *(_>`=`_ x)
- (_>`=`_ x y)
- (_>`=`_ x y & more)*
-</pre>
-<pre> Return true if each argument is larger than or equal to the following
-ones. The minimal implementation for type ::my-type is the binary form
-with dispatch value `[`::my-type ::my-type`]`. A default implementation
-is provided in terms of <.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/comparison.clj#103
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=>=+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===zero?===
-====multimethod====
-<pre>
-Usage: *(_zero?_ x)*
-</pre>
-<pre> Return true of x is zero.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/comparison.clj#28
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=zero?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GenericFunctorApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,36 +0,0 @@
-#summary generic.functor API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for generic.functor=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.generic.functor))
-}}}
-==Overview==
-<pre> Generic functor interface (fmap)</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#fmap fmap]
-
-----
-===fmap===
-====multimethod====
-<pre>
-Usage: *(_fmap_ f s)*
-</pre>
-<pre> Applies function f to each item in the data structure s and returns
-a structure of the same kind.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/functor.clj#20
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=fmap+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GenericMathFunctionsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,210 +0,0 @@
-#summary generic.math-functions API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for generic.math-functions=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.generic.math-functions))
-}}}
-==Overview==
-<pre> Generic math function interface
-This library defines generic versions of common mathematical
-functions such as sqrt or sin as multimethods that can be
-defined for any type.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#abs abs] [#acos acos] [#approx_= approx=] [#asin asin] [#atan atan]
[#atan2 atan2] [#ceil ceil] [#conjugate conjugate] [#cos cos] [#exp exp]
[#floor floor] [#log log] [#pow pow] [#rint rint] [#round round] [#sgn sgn]
[#sin sin] [#sqr sqr] [#sqrt sqrt] [#tan tan]
-
-----
-===abs===
-====multimethod====
-<pre>
-Usage: *(_abs_ x)*
-</pre>
-<pre> Return the abs of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#53
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=abs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===acos===
-====multimethod====
-<pre>
-Usage: *(_acos_ x)*
-</pre>
-<pre> Return the acos of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#54
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=acos+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===approx`=`===
-====function====
-<pre>
-Usage: *(_approx`=`_ x y eps)*
-</pre>
-<pre> Return true if the absolute value of the difference between x and y
-is less than eps.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#110
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=approx=+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===asin===
-====multimethod====
-<pre>
-Usage: *(_asin_ x)*
-</pre>
-<pre> Return the asin of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#55
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=asin+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===atan===
-====multimethod====
-<pre>
-Usage: *(_atan_ x)*
-</pre>
-<pre> Return the atan of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#56
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=atan+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===atan2===
-====multimethod====
-<pre>
-Usage: *(_atan2_ x y)*
-</pre>
-<pre> Return the atan2 of x and y.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#57
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=atan2+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===ceil===
-====multimethod====
-<pre>
-Usage: *(_ceil_ x)*
-</pre>
-<pre> Return the ceil of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#58
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=ceil+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===conjugate===
-====multimethod====
-<pre>
-Usage: *(_conjugate_ x)*
-</pre>
-<pre> Return the conjugate of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#87
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=conjugate+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===cos===
-====multimethod====
-<pre>
-Usage: *(_cos_ x)*
-</pre>
-<pre> Return the cos of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#59
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cos+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===exp===
-====multimethod====
-<pre>
-Usage: *(_exp_ x)*
-</pre>
-<pre> Return the exp of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#60
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=exp+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===floor===
-====multimethod====
-<pre>
-Usage: *(_floor_ x)*
-</pre>
-<pre> Return the floor of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#61
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=floor+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===log===
-====multimethod====
-<pre>
-Usage: *(_log_ x)*
-</pre>
-<pre> Return the log of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#62
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=log+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pow===
-====multimethod====
-<pre>
-Usage: *(_pow_ x y)*
-</pre>
-<pre> Return the pow of x and y.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#63
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pow+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===rint===
-====multimethod====
-<pre>
-Usage: *(_rint_ x)*
-</pre>
-<pre> Return the rint of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#64
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=rint+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===round===
-====multimethod====
-<pre>
-Usage: *(_round_ x)*
-</pre>
-<pre> Return the round of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#65
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=round+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sgn===
-====multimethod====
-<pre>
-Usage: *(_sgn_ x)*
-</pre>
-<pre> Return the sign of x (-1, 0, or 1).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#73
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sgn+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sin===
-====multimethod====
-<pre>
-Usage: *(_sin_ x)*
-</pre>
-<pre> Return the sin of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#66
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sin+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sqr===
-====multimethod====
-<pre>
-Usage: *(_sqr_ x)*
-</pre>
-<pre> Return the square of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#98
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sqr+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sqrt===
-====multimethod====
-<pre>
-Usage: *(_sqrt_ x)*
-</pre>
-<pre> Return the sqrt of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#67
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sqrt+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===tan===
-====multimethod====
-<pre>
-Usage: *(_tan_ x)*
-</pre>
-<pre> Return the tan of x.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/generic/math_functions.clj#68
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=tan+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GraphApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,178 +0,0 @@
-#summary graph API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for graph=
-by Jeffrey Straszheim
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.graph))
-}}}
-==Overview==
-<pre> Basic graph theory algorithms</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#add-loops add-loops] [#component-graph component-graph]
[#dependency-list dependency-list] [#fixed-point fixed-point]
[#get-neighbors get-neighbors] [#lazy-walk lazy-walk] [#post-ordered-nodes
post-ordered-nodes] [#recursive-component? recursive-component?]
[#remove-loops remove-loops] [#reverse-graph reverse-graph] [#scc scc]
[#self-recursive-sets self-recursive-sets] [#stratification-list
stratification-list] [#transitive-closure transitive-closure]
-
-----
-===add-loops===
-====function====
-<pre>
-Usage: *(_add-loops_ g)*
-</pre>
-<pre> For each node n, add the edge n->n if not already present.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#49
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-loops+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===component-graph===
-====function====
-<pre>
-Usage: *(_component-graph_ g)
- (_component-graph_ g sccs)*
-</pre>
-<pre> Given a graph, perhaps with cycles, return a reduced graph that is
acyclic.
-Each node in the new graph will be a set of nodes from the old.
-These sets are the strongly connected components. Each edge will
-be the union of the corresponding edges of the prior graph.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#133
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=component-graph+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===dependency-list===
-====function====
-<pre>
-Usage: *(_dependency-list_ g)*
-</pre>
-<pre> Similar to a topological sort, this returns a vector of sets. The
-set of nodes at index 0 are independent. The set at index 1 depend
-on index 0; those at 2 depend on 0 and 1, and so on. Those withing
-a set have no mutual dependencies. Assume the input graph (which
-much be acyclic) has an edge a->b when a depends on b.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#190
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=dependency-list+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===fixed-point===
-====function====
-<pre>
-Usage: *(_fixed-point_ data fun max equal)*
-</pre>
-<pre> Repeatedly apply fun to data until (equal old-data new-data)
-returns true. If max iterations occur, it will throw an
-exception. Set max to nil for unlimited iterations.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#167
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=fixed-point+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-neighbors===
-====function====
-<pre>
-Usage: *(_get-neighbors_ g n)*
-</pre>
-<pre> Get the neighbors of a node.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#29
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-neighbors+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===lazy-walk===
-====function====
-<pre>
-Usage: *(_lazy-walk_ g n)
- (_lazy-walk_ g ns v)*
-</pre>
-<pre> Return a lazy sequence of the nodes of a graph starting a node n.
Optionally,
-provide a set of visited notes (v) and a collection of nodes to
-visit (ns).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#68
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=lazy-walk+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===post-ordered-nodes===
-====function====
-<pre>
-Usage: *(_post-ordered-nodes_ g)*
-</pre>
-<pre> Return a sequence of indexes of a post-ordered walk of the
graph.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#110
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=post-ordered-nodes+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===recursive-component?===
-====function====
-<pre>
-Usage: *(_recursive-component?_ g ns)*
-</pre>
-<pre> Is the component (recieved from scc) self recursive?</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#151
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=recursive-component?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===remove-loops===
-====function====
-<pre>
-Usage: *(_remove-loops_ g)*
-</pre>
-<pre> For each node n, remove any edges n->n.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#57
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=remove-loops+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===reverse-graph===
-====function====
-<pre>
-Usage: *(_reverse-graph_ g)*
-</pre>
-<pre> Given a directed graph, return another directed graph with the
-order of the edges reversed.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#37
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=reverse-graph+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===scc===
-====function====
-<pre>
-Usage: *(_scc_ g)*
-</pre>
-<pre> Returns, as a sequence of sets, the strongly connected components
-of g.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#117
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=scc+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===self-recursive-sets===
-====function====
-<pre>
-Usage: *(_self-recursive-sets_ g)*
-</pre>
-<pre> Returns, as a sequence of sets, the components of a graph that are
-self-recursive.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#158
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=self-recursive-sets+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===stratification-list===
-====function====
-<pre>
-Usage: *(_stratification-list_ g1 g2)*
-</pre>
-<pre> Similar to dependency-list (see doc), except two graphs are
-provided. The first is as dependency-list. The second (which may
-have cycles) provides a partial-dependency relation. If node a
-depends on node b (meaning an edge a->b exists) in the second
-graph, node a must be equal or later in the sequence.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#207
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=stratification-list+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===transitive-closure===
-====function====
-<pre>
-Usage: *(_transitive-closure_ g)*
-</pre>
-<pre> Returns the transitive closure of a graph. The neighbors are lazily
computed.
-
-Note: some version of this algorithm return all edges a->a
-regardless of whether such loops exist in the original graph. This
-version does not. Loops will be included only if produced by
-cycles in the graph. If you have code that depends on such
-behavior, call (-> g transitive-closure add-loops)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/graph.clj#81
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=transitive-closure+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/GreatestLeastApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,98 +0,0 @@
-#summary greatest-least API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for greatest-least=
-by Vincent Foley
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.greatest-least))
-}}}
-==Overview==
-<pre> Various functions for finding greatest and least values in a
collection</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#all-greatest all-greatest] [#all-greatest-by all-greatest-by]
[#all-least all-least] [#all-least-by all-least-by] [#greatest greatest]
[#greatest-by greatest-by] [#least least] [#least-by least-by]
-
-----
-===all-greatest===
-====function====
-<pre>
-Usage: *(_all-greatest_ & args)*
-</pre>
-<pre> Returns all the greatest elements.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#52
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=all-greatest+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===all-greatest-by===
-====function====
-<pre>
-Usage: *(_all-greatest-by_ f & args)*
-</pre>
-<pre> Return all the elements for which f yields the greatest value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#47
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=all-greatest-by+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===all-least===
-====function====
-<pre>
-Usage: *(_all-least_ & args)*
-</pre>
-<pre> Returns all the least elements.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#62
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=all-least+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===all-least-by===
-====function====
-<pre>
-Usage: *(_all-least-by_ f & args)*
-</pre>
-<pre> Return all the elements for which f yields the least value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#57
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=all-least-by+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===greatest===
-====function====
-<pre>
-Usage: *(_greatest_ & args)*
-</pre>
-<pre> Return the greatest argument.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#18
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=greatest+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===greatest-by===
-====function====
-<pre>
-Usage: *(_greatest-by_ f & args)*
-</pre>
-<pre> Return the argument for which f yields the greatest value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#13
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=greatest-by+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===least===
-====function====
-<pre>
-Usage: *(_least_ & args)*
-</pre>
-<pre> Return the smallest element.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#28
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=least+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===least-by===
-====function====
-<pre>
-Usage: *(_least-by_ f & args)*
-</pre>
-<pre> Return the argument for which f yields the smallest value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/greatest_least.clj#23
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=least-by+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/HttpAgentApiDoc.wiki Tue Jun 9 10:55:43 2009
+++ /dev/null
@@ -1,77 +0,0 @@
-#summary http.agent API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for http.agent=
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.http.agent))
-}}}
-==Overview==
-<pre> Agent-based asynchronous HTTP client.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#http-agent http-agent] [#response-headers-seq response-headers-seq]
-
-----
-===http-agent===
-====function====
-<pre>
-Usage: *(_http-agent_ url & options)*
-</pre>
-<pre> Creates (and immediately returns) an Agent representing an HTTP
-request running in a new thread.
-
-options are key/value pairs:
-
-:method string
-
-The HTTP method name. Default is "GET".
-
-:headers h
-
-HTTP headers, as a Map or a sequence of pairs like
-(`[`key1,value1`]`, `[`key2,value2`]`) Default is nil.
-
-:body b
-
-HTTP request entity body, one of nil, String, byte`[``]`, InputStream,
-Reader, or File. Default is nil.
-
-:connect-timeout int
-
-Timeout value, in milliseconds, when opening a connection to the
-URL. Default is zero, meaning no timeout.
-
-:read-timeout int
-
-Timeout value, in milliseconds, when reading data from the
-connection. Default is zero, meaning no timeout.
-
-:follow-redirects boolean
-
-If true, HTTP 3xx redirects will be followed automatically. Default
-is true.
-</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/agent.clj#51
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=http-agent+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===response-headers-seq===
-====function====
-<pre>
-Usage: *(_response-headers-seq_ http-agnt)*
-</pre>
-<pre> Returns the HTTP response headers in order as a sequence of
-`[`String,String`]` pairs. The first 'header' name may be null for the
-HTTP status line.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/agent.clj#114
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=response-headers-seq+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/HttpConnectionApiDoc.wiki Mon Jun 8 07:46:10 2009
+++ /dev/null
@@ -1,40 +0,0 @@
-#summary http.connection API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for http.connection=
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.http.connection))
-}}}
-==Overview==
-<pre> Low-level HTTP client API around HttpURLConnection</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#http-connection http-connection] [#send-request-entity
send-request-entity]
-
-----
-===http-connection===
-====function====
-<pre>
-Usage: *(_http-connection_ url)*
-</pre>
-<pre> Opens an HttpURLConnection at the URL, handled by as-url.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/connection.clj#21
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=http-connection+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===send-request-entity===
-====multimethod====
-_No usage documentation available_
-<pre> Transmits a request entity body.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/connection.clj#26
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=send-request-entity+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/ImportStaticApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,48 +0,0 @@
-#summary import-static API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for import-static=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.import-static))
-}}}
-==Overview==
-<pre> Import static Java methods/fields into Clojure</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#import-static import-static]
-
-----
-===import-static===
-====macro====
-<pre>
-Usage: *(_import-static_ class & fields-and-methods)*
-</pre>
-<pre> Imports the named static fields and/or static methods of the class
-as (private) symbols in the current namespace.
-
-Example:
- user`=`> (import-static java.lang.Math PI sqrt)
- nil
- user`=`> PI
- 3.141592653589793
- user`=`> (sqrt 16)
- 4.0
-
-Note: The class name must be fully qualified, even if it has already
-been imported. Static methods are defined as MACROS, not
-first-class fns.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/import_static.clj#22
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=import-static+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/JarApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,45 +0,0 @@
-#summary jar API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for jar=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.jar))
-}}}
-==Overview==
-<pre> Utilities for working with Java JAR files</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#filenames-in-jar filenames-in-jar] [#jar-file? jar-file?]
-
-----
-===filenames-in-jar===
-====function====
-<pre>
-Usage: *(_filenames-in-jar_ jar-file)*
-</pre>
-<pre> Returns a sequence of Strings naming the non-directory entries in
-the JAR file.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/jar.clj#29
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=filenames-in-jar+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===jar-file?===
-====function====
-<pre>
-Usage: *(_jar-file?_ file)*
-</pre>
-<pre> Returns true if file is a normal file with a .jar or .JAR
extension.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/jar.clj#22
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=jar-file?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/JavaUtilsApiDoc.wiki Mon Jun 8 07:46:10 2009
+++ /dev/null
@@ -1,151 +0,0 @@
-#summary java-utils API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for java-utils=
-by Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard,
Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.java-utils))
-}}}
-==Overview==
-<pre> A set of utilties for dealing with Java stuff like files and
properties.
-
-Design goals:
-
-(1) Ease-of-use. These APIs should be convenient. Performance is secondary.
-
-(2) Duck typing. I hate having to think about the difference between
- a string that names a file, and a File. Ditto for a ton of other
- wrapper classes in the Java world (URL, InternetAddress). With these
- APIs you should be able to think about domain equivalence, not type
- equivalence.
-
-(3) No bossiness. I am not marking any of these functions as private
- the docstrings will tell you the intended usage but do what works for
you.
-
-Feedback welcome!
-
-If something in this module violates the principle of least surprise,
please
-let me (Stu) and the Clojure community know via the mailing list.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#as-file as-file] [#as-properties as-properties] [#as-str as-str]
[#as-url as-url] [#file file] [#get-system-property get-system-property]
[#read-properties read-properties] [#relative-path-string
relative-path-string] [#set-system-properties set-system-properties]
[#with-system-properties with-system-properties] [#write-properties
write-properties]
-
-----
-===as-file===
-====multimethod====
-_No usage documentation available_
-<pre> Interpret a String or a java.io.File as a File. Building block
-for clojure.contrib.java-utils/file, which you should prefer
-in most cases.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#75
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=as-file+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===as-properties===
-====function====
-<pre>
-Usage: *(_as-properties_ m)*
-</pre>
-<pre> Convert any seq of pairs to a java.utils.Properties instance.
-Uses as-str to convert both keys and values into strings.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#134
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=as-properties+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===as-str===
-====function====
-<pre>
-Usage: *(_as-str_ x)*
-</pre>
-<pre> Returns the name or string representation of x</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#92
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=as-str+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===as-url===
-====multimethod====
-<pre>
-Usage: *(_as-url_ arg)*
-</pre>
-<pre> Coerces argument (URL, URI, or String) to a java.net.URL.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#160
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=as-url+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===file===
-====function====
-<pre>
-Usage: *(_file_ arg)
- (_file_ parent child)
- (_file_ parent child & more)*
-</pre>
-<pre> Returns a java.io.File from string or file args.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#83
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=file+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-system-property===
-====function====
-<pre>
-Usage: *(_get-system-property_ stringable)
- (_get-system-property_ stringable default)*
-</pre>
-<pre> Get a system property.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#99
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-system-property+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===read-properties===
-====function====
-<pre>
-Usage: *(_read-properties_ file-able)*
-</pre>
-<pre> Read properties from file-able.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#144
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=read-properties+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===relative-path-string===
-====multimethod====
-_No usage documentation available_
-<pre> Interpret a String or java.io.File as a relative path string.
-Building block for clojure.contrib.java-utils/file.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#62
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=relative-path-string+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===set-system-properties===
-====function====
-<pre>
-Usage: *(_set-system-properties_ settings)*
-</pre>
-<pre> Set some system properties. Nil clears a property.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#106
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=set-system-properties+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-system-properties===
-====macro====
-<pre>
-Usage: *(_with-system-properties_ settings & body)*
-</pre>
-<pre> setting `=`> property-name value
-
-Sets the system properties to the supplied values, executes the body, and
-sets the properties back to their original values. Values of nil are
-translated to a clearing of the property.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#114
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-system-properties+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===write-properties===
-====function====
-<pre>
-Usage: *(_write-properties_ m file-able)
- (_write-properties_ m file-able comments)*
-</pre>
-<pre> Write properties to file-able.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/java_utils.clj#151
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=write-properties+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/JavadocBrowseApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,46 +0,0 @@
-#summary javadoc.browse API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for javadoc.browse=
-by Christophe Grand
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.javadoc.browse))
-}}}
-==Overview==
-<pre> Start a web browser from Clojure</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#open-url-in-browser open-url-in-browser] [#open-url-in-swing
open-url-in-swing]
-
-----
-===open-url-in-browser===
-====function====
-<pre>
-Usage: *(_open-url-in-browser_ url)*
-</pre>
-<pre> Opens url (a string) in the default system web browser. May not
-work on all platforms. Returns url on success, nil if not
-supported.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/javadoc/browse.clj#25
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=open-url-in-browser+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===open-url-in-swing===
-====function====
-<pre>
-Usage: *(_open-url-in-swing_ url)*
-</pre>
-<pre> Opens url (a string) in a Swing window.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/javadoc/browse.clj#40
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=open-url-in-swing+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/JsonReadApiDoc.wiki Fri Jun 5 15:30:52 2009
+++ /dev/null
@@ -1,59 +0,0 @@
-#summary json.read API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for json.read=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.json.read))
-}}}
-==Overview==
-<pre> JavaScript Object Notation (JSON) parser
-
-For more information on JSON, see http://www.json.org/
-
-This library parses data in JSON format. This is a fairly strict
-implementation of JSON as described at json.org, not a full-fledged
-JavaScript parser. JavaScript functions and object constructors
-are not supported. Object field names must be quoted strings; they
-may not be bare symbols.
-
-If you want to convert map keys from strings to keywords, use
-clojure.contrib.walk/keywordize-keys</pre>
-See also: [http://www.json.org JSON Home Page]
-
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#*_json-keyword-keys_* *json-keyword-keys*] [#read-json read-json]
-
-----
-===`*`json-keyword-keys`*`===
-====var====
-<pre> If true, JSON object keys will be converted to keywords
-instead of strings. Defaults to false. There are no checks that
-the strings form valid keywords.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/json/read.clj#55
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*json-keyword-keys*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===read-json===
-====function====
-<pre>
-Usage: *(_read-json_)
- (_read-json_ s)
- (_read-json_ stream eof-error? eof-value)*
-</pre>
-<pre> Read one JSON record from s, which may be a String or a
-java.io.PushbackReader.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/json/read.clj#143
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=read-json+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/JsonWriteApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,76 +0,0 @@
-#summary json.write API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for json.write=
-by Stuart Sierra
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.json.write))
-}}}
-==Overview==
-<pre> JavaScript Object Notation (JSON) generator.
-
-This library will generate JSON from the following types:
- `*` nil
- `*` all primitives (Boolean, Byte, Short, Integer, Long, Float, Double)
- `*` String (actually any CharSequence)
- `*` java.util.Map (including Clojure maps)
- `*` java.util.Collection (including Clojure vectors, lists, and sets)
- `*` Java arrays
-
-You can extend this library to handle new types by adding methods to
-print-json.
-
-This library does NOT attempt to preserve round-trip equality between
-JSON and Clojure data types. That is, if you write a JSON string with
-this library, then read it back with clojure.contrib.json.read, you
-won't necessarily get the exact same data structure. For example,
-Clojure sets are written as JSON arrays, which will be read back as
-Clojure vectors.
-
-If you want indented output, try the clojure-json library at
-http://github.com/danlarkin/clojure-json
-
-This implementation attempts to follow the description of JSON at
-<http://json.org/>. Maps become JSON objects, all other collections
-become JSON arrays. JSON object keys are always converted to strings.
-Within strings, all non-ASCII characters are hexadecimal escaped.</pre>
-See also: [http://json.org/ JSON Home Page]
-
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#json-str json-str] [#print-json print-json]
-
-----
-===json-str===
-====function====
-<pre>
-Usage: *(_json-str_ x)*
-</pre>
-<pre> Converts x to a JSON-formatted string.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/json/write.clj#138
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=json-str+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===print-json===
-====multimethod====
-<pre>
-Usage: *(_print-json_ x)*
-</pre>
-<pre> Prints x as JSON. Nil becomes JSON null. Keywords become
-strings, without the leading colon. Maps become JSON objects, all
-other collection types become JSON arrays. Java arrays become JSON
-arrays. Unicode characters in strings are escaped as \uXXXX.
-Numbers print as with pr.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/json/write.clj#50
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-json+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/LazySeqsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,68 +0,0 @@
-#summary lazy-seqs API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for lazy-seqs=
-by Stephen C. Gilardi
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.lazy-seqs))
-}}}
-==Overview==
-<pre>
-`=``=``=``=` Lazy sequences `=``=``=``=`
-
- primes - based on the "naive" implemention described in `[`1`]` plus a
- small "wheel" which eliminates multiples of 2, 3, 5, and
- 7 from consideration by incrementing past them. Also inspired
- by code from Christophe Grand in `[`2`]`.
-
- fibs - all the Fibonacci numbers
-
- powers-of-2 - all the powers of 2
-
- `=``=``=``=` Lazy sequence functions `=``=``=``=`
-
- (rotations, partition-all, shuffle, rand-elt moved to seq`_`utils.clj)
- (permutations and combinations moved to combinatorics.clj)
-
- `[`1`]` http://www.cs.hmc.edu/~oneill/papers/Sieve-JFP.pdf
- `[`2`]` http://clj-me.blogspot.com/2008/06/primes.html</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#fibs fibs] [#powers-of-2 powers-of-2] [#primes primes]
-
-----
-===fibs===
-====function====
-<pre>
-Usage: *(_fibs_)*
-</pre>
-<pre> Returns a lazy sequence of all the Fibonacci numbers.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_seqs.clj#78
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=fibs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===powers-of-2===
-====function====
-<pre>
-Usage: *(_powers-of-2_)*
-</pre>
-<pre> Returns a lazy sequence of all the powers of 2</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_seqs.clj#83
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=powers-of-2+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===primes===
-====var====
-<pre> Lazy sequence of all the prime numbers.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_seqs.clj#62
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=primes+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/LazyXmlApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,87 +0,0 @@
-#summary lazy-xml API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for lazy-xml=
-by Chris Houser
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.lazy-xml))
-}}}
-==Overview==
-<pre> Functions to parse xml lazily and emit back to text.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#emit emit] [#emit-element emit-element] [#parse-seq parse-seq]
[#parse-trim parse-trim]
-
-----
-===emit===
-====function====
-<pre>
-Usage: *(_emit_ x & opts)*
-</pre>
-<pre> Prints an <?xml?> declaration line, and then calls emit-element</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_xml.clj#158
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=emit+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===emit-element===
-====function====
-<pre>
-Usage: *(_emit-element_ e & opts)*
-</pre>
-<pre> Recursively prints as XML text the element struct e. To have it
-print extra whitespace like clojure.xml/emit, use the :pad true
-option.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_xml.clj#135
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=emit-element+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===parse-seq===
-====function====
-<pre>
-Usage: *(_parse-seq_ s)
- (_parse-seq_ s startparse)
- (_parse-seq_ s startparse queue-size)*
-</pre>
-<pre> Parses the source s, which can be a File, InputStream or String
-naming a URI. Returns a lazy sequence of maps with two or more of
-the keys :type, :name, :attrs, and :str. Other SAX-compatible
-parsers can be supplied by passing startparse, a fn taking a source
-and a ContentHandler and returning a parser. If a parser is
-specified, it will be run in a separate thread and be allowed to get
-ahead by queue-size items, which defaults to maxing. If no parser
-is specified and org.xmlpull.v1.XmlPullParser is in the classpath,
-this superior pull parser will be used.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_xml.clj#37
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=parse-seq+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===parse-trim===
-====function====
-<pre>
-Usage: *(_parse-trim_ s)
- (_parse-trim_ s startparse queue-size)*
-</pre>
-<pre> Parses the source s, which can be a File, InputStream or String
-naming a URI. Returns a lazy tree of the clojure.xml/element
-struct-map, which has the keys :tag, :attrs, and :content and
-accessor fns tag, attrs, and content, with the whitespace trimmed
-from around each content string. This format is compatible with what
-clojure.xml/parse produces, except :content is a lazy seq instead of
-a vector. Other SAX-compatible parsers can be supplied by passing
-startparse, a fn taking a source and a ContentHandler and returning
-a parser. If a parser is specified, it will be run in a separate
-thread and be allowed to get ahead by queue-size items, which
-defaults to maxing. If no parser is specified and
-org.xmlpull.v1.XmlPullParser is in the classpath, this superior pull
-parser will be used.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/lazy_xml.clj#112
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=parse-trim+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/MacroUtilsApiDoc.wiki Mon May 25 10:21:44 2009
+++ /dev/null
@@ -1,115 +0,0 @@
-#summary macro-utils API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for macro-utils=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.macro-utils))
-}}}
-==Overview==
-<pre> Local macros and symbol macros
-
-Local macros are defined by a macrolet form. They are usable only
-inside its body. Symbol macros can be defined globally
-(defsymbolmacro) or locally (symbol-macrolet). A symbol
-macro defines a form that replaces a symbol during macro
-expansion. Function arguments and symbols bound in let
-forms are not subject to symbol macro expansion.
-
-Local macros are most useful in the definition of the expansion
-of another macro, they may be used anywhere. Global symbol
-macros can be used only inside a with-symbol-macros form.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#defsymbolmacro defsymbolmacro] [#deftemplate deftemplate] [#macrolet
macrolet] [#mexpand mexpand] [#mexpand-1 mexpand-1] [#mexpand-all
mexpand-all] [#symbol-macrolet symbol-macrolet] [#with-symbol-macros
with-symbol-macros]
-
-----
-===defsymbolmacro===
-====macro====
-<pre>
-Usage: *(_defsymbolmacro_ symbol expansion)*
-</pre>
-<pre> Define a symbol macro. Because symbol macros are not part of
-Clojure's built-in macro expansion system, they can be used only
-inside a with-symbol-macros form.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#200
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defsymbolmacro+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===deftemplate===
-====macro====
-<pre>
-Usage: *(_deftemplate_ name params & forms)*
-</pre>
-<pre> Define a macro that expands into forms after replacing the
-symbols in params (a vector) by the corresponding parameters
-given in the macro call.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#214
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=deftemplate+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===macrolet===
-====macro====
-<pre>
-Usage: *(_macrolet_ fn-bindings & exprs)*
-</pre>
-<pre> Define local macros that are used in the expansion of exprs. The
-syntax is the same as for letfn forms.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#179
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=macrolet+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===mexpand===
-====function====
-<pre>
-Usage: *(_mexpand_ form)*
-</pre>
-<pre> Like clojure.core/macroexpand, but takes into account symbol
macros.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#234
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=mexpand+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===mexpand-1===
-====function====
-<pre>
-Usage: *(_mexpand-1_ form)*
-</pre>
-<pre> Like clojure.core/macroexpand-1, but takes into account symbol
macros.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#226
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=mexpand-1+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===mexpand-all===
-====function====
-<pre>
-Usage: *(_mexpand-all_ form)*
-</pre>
-<pre> Perform a full recursive macro expansion of a form.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#242
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=mexpand-all+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===symbol-macrolet===
-====macro====
-<pre>
-Usage: *(_symbol-macrolet_ symbol-bindings & exprs)*
-</pre>
-<pre> Define local symbol macros that are used in the expansion of exprs.
-The syntax is the same as for let forms.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#190
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=symbol-macrolet+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-symbol-macros===
-====macro====
-<pre>
-Usage: *(_with-symbol-macros_ & exprs)*
-</pre>
-<pre> Fully expand exprs, including symbol macros.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macro_utils.clj#209
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-symbol-macros+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/MacrosApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,47 +0,0 @@
-#summary macros API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for macros=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.macros))
-}}}
-==Overview==
-<pre> Various small macros</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#const const] [#letfn- letfn-]
-
-----
-===const===
-====macro====
-<pre>
-Usage: *(_const_ expr)*
-</pre>
-<pre> Evaluate the constant expression expr at compile time.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macros.clj#18
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=const+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===letfn-===
-====macro====
-<pre>
-Usage: *(_letfn-_ fn-bindings & exprs)*
-</pre>
-<pre> OBSOLETE: use clojure.core/letfn
-A variant of let for local function definitions. fn-bindings consists
-of name/args/body triples, with (letfn `[`name args body`]` ...)
-being equivalent to (let `[`name (fn name args body)`]` ...).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/macros.clj#28
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=letfn-+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/MapUtilsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,67 +0,0 @@
-#summary map-utils API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for map-utils=
-by Jason Wolfe, Chris Houser
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.map-utils))
-}}}
-==Overview==
-<pre> Utilities for operating on Clojure maps.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#deep-merge-with deep-merge-with] [#lazy-get lazy-get] [#safe-get
safe-get] [#safe-get-in safe-get-in]
-
-----
-===deep-merge-with===
-====function====
-<pre>
-Usage: *(_deep-merge-with_ f & maps)*
-</pre>
-<pre> Like merge-with, but merges maps recursively, applying the given fn
-only when there's a non-map at a particular level.
-
-(deepmerge + {:a {:b {:c 1 :d {:x 1 :y 2}} :e 3} :f 4}
- {:a {:b {:c 2 :d {:z 9} :z 3} :e 100}})
--> {:a {:b {:z 3, :c 3, :d {:z 9, :x 1, :y 2}}, :e 103}, :f 4}</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/map_utils.clj#41
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=deep-merge-with+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===lazy-get===
-====macro====
-<pre>
-Usage: *(_lazy-get_ map key not-found)*
-</pre>
-<pre> Like get, but doesn't evaluate not-found unless it is needed.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/map_utils.clj#22
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=lazy-get+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===safe-get===
-====function====
-<pre>
-Usage: *(_safe-get_ map key)*
-</pre>
-<pre> Like get, but throws an exception if the key is not found.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/map_utils.clj#29
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=safe-get+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===safe-get-in===
-====function====
-<pre>
-Usage: *(_safe-get-in_ map ks)*
-</pre>
-<pre> Like get-in, but throws an exception if any key is not found.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/map_utils.clj#35
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=safe-get-in+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/MathApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,152 +0,0 @@
-#summary math API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for math=
-by Mark Engelberg
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.math))
-}}}
-==Overview==
-<pre> Math functions that deal intelligently with the various
-types in Clojure's numeric tower, as well as math functions
-commonly found in Scheme implementations.
-
-expt - (expt x y) is x to the yth power, returns an exact number
- if the base is an exact number, and the power is an integer,
- otherwise returns a double.
-abs - (abs n) is the absolute value of n
-gcd - (gcd m n) returns the greatest common divisor of m and n
-lcm - (lcm m n) returns the least common multiple of m and n
-
-The behavior of the next three functions on doubles is consistent
-with the behavior of the corresponding functions
-in Java's Math library, but on exact numbers, returns an integer.
-
-floor - (floor n) returns the greatest integer less than or equal to n.
- If n is an exact number, floor returns an integer,
- otherwise a double.
-ceil - (ceil n) returns the least integer greater than or equal to n.
- If n is an exact number, ceil returns an integer,
- otherwise a double.
-round - (round n) rounds to the nearest integer.
- round always returns an integer. round rounds up for values
- exactly in between two integers.
-
-
-sqrt - Implements the sqrt behavior I'm accustomed to from PLT Scheme,
- specifically, if the input is an exact number, and is a square
- of an exact number, the output will be exact. The downside
- is that for the common case (inexact square root), some extra
- computation is done to look for an exact square root first.
- So if you need blazingly fast square root performance, and you
- know you're just going to need a double result, you're better
- off calling java's Math/sqrt, or alternatively, you could just
- convert your input to a double before calling this sqrt function.
- If Clojure ever gets complex numbers, then this function will
- need to be updated (so negative inputs yield complex outputs).
-exact-integer-sqrt - Implements a math function from the R6RS Scheme
- standard. (exact-integer-sqrt k) where k is a non-negative integer,
- returns `[`s r`]` where k `=` s^2+r and k < (s+1)^2. In other words, it
- returns the floor of the square root and the </pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#abs abs] [#ceil ceil] [#exact-integer-sqrt exact-integer-sqrt] [#expt
expt] [#floor floor] [#gcd gcd] [#lcm lcm] [#round round] [#sqrt sqrt]
-
-----
-===abs===
-====function====
-<pre>
-Usage: *(_abs_ n)*
-</pre>
-<pre> (abs n) is the absolute value of n</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#122
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=abs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===ceil===
-====multimethod====
-<pre>
-Usage: *(_ceil_ n)*
-</pre>
-<pre> (ceil n) returns the least integer greater than or equal to n.
-If n is an exact number, ceil returns an integer, otherwise a double.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#141
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=ceil+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===exact-integer-sqrt===
-====function====
-<pre>
-Usage: *(_exact-integer-sqrt_ n)*
-</pre>
-<pre> (exact-integer-sqrt n) expects a non-negative integer n, and returns
`[`s r`]` where n `=` s^2+r and n < (s+1)^2. In other words, it returns
the floor of the square root and the 'remainder'.
-For example, (exact-integer-sqrt 15) is `[`3 6`]` because 15 `=`
3^2+6.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#206
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=exact-integer-sqrt+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===expt===
-====multimethod====
-<pre>
-Usage: *(_expt_ base pow)*
-</pre>
-<pre> (expt base pow) is base to the pow power.
-Returns an exact number if the base is an exact number and the power is an
integer, otherwise returns a double.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#101
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=expt+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===floor===
-====multimethod====
-<pre>
-Usage: *(_floor_ n)*
-</pre>
-<pre> (floor n) returns the greatest integer less than or equal to n.
-If n is an exact number, floor returns an integer, otherwise a
double.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#129
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=floor+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===gcd===
-====function====
-<pre>
-Usage: *(_gcd_ a b)*
-</pre>
-<pre> (gcd a b) returns the greatest common divisor of a and b</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#162
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=gcd+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===lcm===
-====function====
-<pre>
-Usage: *(_lcm_ a b)*
-</pre>
-<pre> (lcm a b) returns the least common multiple of a and b</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#169
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=lcm+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===round===
-====multimethod====
-<pre>
-Usage: *(_round_ n)*
-</pre>
-<pre> (round n) rounds to the nearest integer.
-round always returns an integer. Rounds up for values exactly in between
two integers.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#153
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=round+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sqrt===
-====multimethod====
-<pre>
-Usage: *(_sqrt_ n)*
-</pre>
-<pre> Square root, but returns exact number if possible.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/math.clj#215
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sqrt+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/MiglayoutApiDoc.wiki Tue Jun 2 08:36:10 2009
+++ /dev/null
@@ -1,237 +0,0 @@
-#summary miglayout API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for miglayout=
-by Stephen C. Gilardi
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.miglayout))
-}}}
-==Overview==
-<pre> Clojure support for the MiGLayout layout manager
-http://www.miglayout.com/
-
-Example:
-
- (use '`[`clojure.contrib.miglayout.test :as mlt :only ()`]`)
- (dotimes `[`i 5`]` (mlt/run-test i))</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#components components] [#miglayout miglayout]
-
-Variables and Functions in miglayout.example:
-[MiglayoutApiDoc#converter-ui converter-ui] [MiglayoutApiDoc#fahrenheit
fahrenheit] [MiglayoutApiDoc#main main]
-
-Variables and Functions in miglayout.internal:
-[MiglayoutApiDoc#add-components add-components]
[MiglayoutApiDoc#component? component?] [MiglayoutApiDoc#constraint?
constraint?] [MiglayoutApiDoc#do-layout do-layout]
[MiglayoutApiDoc#format-constraint format-constraint]
[MiglayoutApiDoc#format-constraints format-constraints]
[MiglayoutApiDoc#get-components get-components]
[MiglayoutApiDoc#parse-component-constraint parse-component-constraint]
[MiglayoutApiDoc#parse-item-constraints parse-item-constraints]
-
-Variables and Functions in miglayout.test:
-[MiglayoutApiDoc#label label] [MiglayoutApiDoc#sep sep]
[MiglayoutApiDoc#text-field text-field]
-
-----
-===components===
-====function====
-<pre>
-Usage: *(_components_ container)*
-</pre>
-<pre> Returns a map from id (a keyword) to component for all components
with
-an id constraint set</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout.clj#75
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=components+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===miglayout===
-====function====
-<pre>
-Usage: *(_miglayout_ container & args)*
-</pre>
-<pre> Adds java.awt.Components to a javax.swing.JComponent with constraints
-formatted for the MiGLayout layout manager.
-
-Arguments: container `[`item constraint`*``]``*`
-
- - container: the container for the specified components, its layout
- manager will be set to a new instance of MigLayout
-
- - an inline series of items and constraints--each item may be followed
- by zero or more constraints.
-
-Item:
-
- - An item is either a Component or one of the keywords :layout
- :column or :row. Constraints for a keyword item affect the entire
- layout.
-
-Constraint: string, keyword, vector, map, or set
-
- - A string specifies one or more constraints each with zero or more
- arguments.
- - A keyword specifies a single constraint without arguments
- - A vector specifies a single constraint with one or more arguments
- - A map specifies one or more constraints as keys, each mapped to a
- single argument
- - A set groups two or more constraints, each a string, keyword,
- vector, map, or set
-
-Any items marked with an "id" constraint will be included in a map from
-id to component attached to the container. The map can be retrieved using
-clojure.contrib.miglayout/components.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout.clj#37
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=miglayout+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.miglayout.example==
-----
-===converter-ui===
-====function====
-<pre>
-Usage: *(_converter-ui_)*
-</pre>
-<pre> Lays out and shows a Temperature Converter UI</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/example.clj#40
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=converter-ui+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===fahrenheit===
-====function====
-<pre>
-Usage: *(_fahrenheit_ celsius)*
-</pre>
-<pre> Converts a Celsius temperature to Fahrenheit. Input and output are
-strings. Returns "input?" if the input can't be parsed as a Double.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/example.clj#24
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=fahrenheit+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===main===
-====function====
-<pre>
-Usage: *(_main_)*
-</pre>
-<pre> Invokes converter-ui in the AWT Event thread</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/example.clj#57
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=main+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.miglayout.internal==
-----
-===add-components===
-====function====
-<pre>
-Usage: *(_add-components_ container components)*
-</pre>
-<pre> Adds components with constraints to a container</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#94
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=add-components+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===component?===
-====function====
-<pre>
-Usage: *(_component?_ x)*
-</pre>
-<pre> Returns true if x is a java.awt.Component</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#59
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=component?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===constraint?===
-====function====
-<pre>
-Usage: *(_constraint?_ x)*
-</pre>
-<pre> Returns true if x is not a keyword-item or component</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#64
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=constraint?+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===do-layout===
-====function====
-<pre>
-Usage: *(_do-layout_ container layout column row components)*
-</pre>
-<pre> Attaches a MigLayout layout manager to container and adds components
-with constraints</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#114
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=do-layout+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===format-constraint===
-====function====
-<pre>
-Usage: *(_format-constraint_ c)*
-</pre>
-<pre> Returns a vector of vectors representing one or more constraints
-separated by commas. Constraints may be specified in Clojure using
-strings, keywords, vectors, maps, and/or sets.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#32
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=format-constraint+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===format-constraints===
-====function====
-<pre>
-Usage: *(_format-constraints_ & constraints)*
-</pre>
-<pre> Returns a string representing all the constraints for one
keyword-item
-or component formatted for miglayout.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#47
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=format-constraints+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-components===
-====function====
-<pre>
-Usage: *(_get-components_ container)*
-</pre>
-<pre> Returns a map from id to component for all components with an
id</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#109
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-components+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===parse-component-constraint===
-====function====
-<pre>
-Usage: *(_parse-component-constraint_ constraint)*
-</pre>
-<pre> Parses a component constraint string returning a CC object</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#88
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=parse-component-constraint+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===parse-item-constraints===
-====function====
-<pre>
-Usage: *(_parse-item-constraints_ & args)*
-</pre>
-<pre> Iterates over args and builds a map containing values associated with
-:keywords and :components. The value for :keywords is a map from keyword
-items to constraints strings. The value for :components is a vector of
-vectors each associating a component with its constraints string.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/internal.clj#71
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=parse-item-constraints+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.miglayout.test==
-----
-===label===
-====function====
-<pre>
-Usage: *(_label_ text)*
-</pre>
-<pre> Returns a swing label</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/test.clj#32
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=label+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sep===
-====function====
-<pre>
-Usage: *(_sep_)*
-</pre>
-<pre> Returns a swing separator</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/test.clj#43
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sep+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===text-field===
-====function====
-<pre>
-Usage: *(_text-field_)
- (_text-field_ width)*
-</pre>
-<pre> Returns a swing text field</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/miglayout/test.clj#37
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=text-field+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/MmapApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,54 +0,0 @@
-#summary mmap API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for mmap=
-by Chris Houser
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.mmap))
-}}}
-==Overview==
-<pre> Functions for memory-mapping files, plus some functions that use a
-mmaped file for "normal" activies -- slurp, load-file, etc.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#buffer-stream buffer-stream] [#mmap mmap] [#slurp slurp]
-
-----
-===buffer-stream===
-====function====
-<pre>
-Usage: *(_buffer-stream_ buf)*
-</pre>
-<pre> Returns an InputStream for a ByteBuffer, such as returned by
mmap.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/mmap.clj#39
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=buffer-stream+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===mmap===
-====function====
-<pre>
-Usage: *(_mmap_ f)*
-</pre>
-<pre> Memory-map the file named f. Returns a ByteBuffer.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/mmap.clj#27
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=mmap+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===slurp===
-====function====
-<pre>
-Usage: *(_slurp_ f)*
-</pre>
-<pre> Reads the file named by f and returns it as a string.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/mmap.clj#33
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=slurp+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/MonadsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,300 +0,0 @@
-#summary monads API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for monads=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.monads))
-}}}
-==Overview==
-<pre> This library contains the most commonly used monads as well
-as macros for defining and using monads and useful monadic
-functions.</pre>
-See also:
[http://onclojure.com/2009/03/05/a-monad-tutorial-for-clojure-programmers-part-1/
Monad tutorial part 1],
[http://onclojure.com/2009/03/06/a-monad-tutorial-for-clojure-programmers-part-2/
Monad tutorial part 2],
[http://onclojure.com/2009/03/23/a-monad-tutorial-for-clojure-programmers-part-3/
Monad tutorial part 3],
[http://onclojure.com/2009/04/24/a-monad-tutorial-for-clojure-programmers-part-4/
Monad tutorial part 4],
[http://intensivesystems.net/tutorials/monads_101.html Monads in Clojure
part 1], [http://intensivesystems.net/tutorials/monads_201.html Monads in
Clojure part 2]
-
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#call-cc call-cc] [#cont-m cont-m] [#defmonad defmonad] [#defmonadfn
defmonadfn] [#domonad domonad] [#identity-m identity-m] [#m-chain m-chain]
[#m-fmap m-fmap] [#m-join m-join] [#m-lift m-lift] [#m-map m-map]
[#m-reduce m-reduce] [#m-seq m-seq] [#m-when m-when] [#m-when-not
m-when-not] [#maybe-m maybe-m] [#maybe-t maybe-t] [#monad monad]
[#monad-transformer monad-transformer] [#run-cont run-cont] [#sequence-m
sequence-m] [#sequence-t sequence-t] [#set-m set-m] [#state-m state-m]
[#state-t state-t] [#with-monad with-monad] [#writer-m writer-m]
-
-----
-===call-cc===
-====function====
-<pre>
-Usage: *(_call-cc_ f)*
-</pre>
-<pre> A computation in the cont monad that calls function f with a single
-argument representing the current continuation. The function f should
-return a continuation (which becomes the return value of call-cc),
-or call the passed-in current continuation to terminate.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#415
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=call-cc+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===cont-m===
-====var====
-<pre> Monad describing computations in continuation-passing style. The
monadic
-values are functions that are called with a single argument representing
-the continuation of the computation, to which they pass their result.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#399
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cont-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defmonad===
-====macro====
-<pre>
-Usage: *(_defmonad_ name doc-string operations)
- (_defmonad_ name operations)*
-</pre>
-<pre> Define a named monad by defining the monad operations. The
definitions
-are written like bindings to the monad operations m-bind and
-m-result (required) and m-zero and m-plus (optional).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#51
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defmonad+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===defmonadfn===
-====macro====
-<pre>
-Usage: *(_defmonadfn_ name docstring? attr-map? args expr)
- (_defmonadfn_ name docstring? attr-map? (args expr) ...)*
-</pre>
-<pre> Like defn, but for functions that use monad operations and are used
inside
-a with-monad block.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#137
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=defmonadfn+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===domonad===
-====macro====
-<pre>
-Usage: *(_domonad_ steps expr)
- (_domonad_ name steps expr)*
-</pre>
-<pre> Monad comprehension. Takes the name of a monad, a vector of steps
-given as binding-form/monadic-expression pairs, and a result value
-specified by expr. The monadic-expression terms can use the binding
-variables of the previous steps.
-If the monad contains a definition of m-zero, the step list can also
-contain conditions of the form :when p, where the predicate p can
-contain the binding variables from all previous steps.
-A clause of the form :let `[`binding-form expr ...`]`, where the bindings
-are given as a vector as for the use in let, establishes additional
-bindings that can be used in the following steps.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#114
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=domonad+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===identity-m===
-====var====
-<pre> Monad describing plain computations. This monad does in fact nothing
-at all. It is useful for testing, for combination with monad
-transformers, and for code that is parameterized with a monad.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#274
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=identity-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-chain===
-====var====
-<pre> Chains together monadic computation steps that are each functions
-of one parameter. Each step is called with the result of the previous
-step as its argument. (m-chain (step1 step2)) is equivalent to
-(fn `[`x`]` (domonad `[`r1 (step1 x) r2 (step2 r1)`]` r2)).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#217
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-chain+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-fmap===
-====var====
-<pre> Bind the monadic value m to the function returning (f x) for
argument x</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#195
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-fmap+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-join===
-====var====
-<pre> Converts a monadic value containing a monadic value into a 'simple'
-monadic value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#189
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-join+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-lift===
-====macro====
-<pre>
-Usage: *(_m-lift_ n f)*
-</pre>
-<pre> Converts a function f of n arguments into a function of n
-monadic arguments returning a monadic value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#180
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-lift+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-map===
-====var====
-<pre> 'Executes' the sequence of monadic values resulting from mapping
-f onto the values xs. f must return a monadic value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#211
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-map+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-reduce===
-====var====
-<pre> Return the reduction of (m-lift 2 f) over the list of monadic values
mvs
-with initial value (m-result val).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#228
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-reduce+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-seq===
-====var====
-<pre> 'Executes' the monadic values in ms and returns a sequence of the
-basic values contained in them.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#200
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-seq+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-when===
-====macro====
-<pre>
-Usage: *(_m-when_ test m-expr)*
-</pre>
-<pre> If test if logical true, return monadic value m-expr, else return
-(m-result nil).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#241
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-when+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===m-when-not===
-====macro====
-<pre>
-Usage: *(_m-when-not_ test m-expr)*
-</pre>
-<pre> If test if logical false, return monadic value m-expr, else return
-(m-result nil).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#247
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=m-when-not+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===maybe-m===
-====var====
-<pre> Monad describing computations with possible failures. Failure is
-represented by nil, any other value is considered valid. As soon as
-a step returns nil, the whole computation will yield nil as well.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#284
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=maybe-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===maybe-t===
-====function====
-<pre>
-Usage: *(_maybe-t_ m)
- (_maybe-t_ m nothing)
- (_maybe-t_ m nothing which-m-plus)*
-</pre>
-<pre> Monad transformer that transforms a monad m into a monad in which
-the base values can be invalid (represented by nothing, which defaults
-to nil). The third argument chooses if m-zero and m-plus are inherited
-from the base monad (use :m-plus-from-base) or adopt maybe-like
-behaviour (use :m-plus-from-transformer). The default is :m-plus-from-base
-if the base monad m has a definition for m-plus, and
-:m-plus-from-transformer otherwise.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#455
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=maybe-t+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===monad===
-====macro====
-<pre>
-Usage: *(_monad_ operations)*
-</pre>
-<pre> Define a monad by defining the monad operations. The definitions
-are written like bindings to the monad operations m-bind and
-m-result (required) and m-zero and m-plus (optional).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#36
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=monad+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===monad-transformer===
-====macro====
-<pre>
-Usage: *(_monad-transformer_ base which-m-plus operations)*
-</pre>
-<pre> Define a monad transforer in terms of the monad operations and the
base
-monad. The argument which-m-plus chooses if m-zero and m-plus are taken
-from the base monad or from the transformer.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#433
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=monad-transformer+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===run-cont===
-====function====
-<pre>
-Usage: *(_run-cont_ c)*
-</pre>
-<pre> Execute the computation c in the cont monad and return its
result.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#410
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=run-cont+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sequence-m===
-====var====
-<pre> Monad describing multi-valued computations, i.e. computations
-that can yield multiple values. Any object implementing the seq
-protocol can be used as a monadic value.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#297
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sequence-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===sequence-t===
-====function====
-<pre>
-Usage: *(_sequence-t_ m)
- (_sequence-t_ m which-m-plus)*
-</pre>
-<pre> Monad transformer that transforms a monad m into a monad in which
-the base values are sequences. The argument which-m-plus chooses
-if m-zero and m-plus are inherited from the base monad
-(use :m-plus-from-base) or adopt sequence-like
-behaviour (use :m-plus-from-transformer). The default is :m-plus-from-base
-if the base monad m has a definition for m-plus, and
-:m-plus-from-transformer otherwise.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#487
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=sequence-t+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===set-m===
-====var====
-<pre> Monad describing multi-valued computations, like sequence-m,
-but returning sets of results instead of sequences of results.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#311
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=set-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===state-m===
-====var====
-<pre> Monad describing stateful computations. The monadic values have the
-structure (fn `[`old-state`]` (list result new-state)).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#324
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=state-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===state-t===
-====function====
-<pre>
-Usage: *(_state-t_ m)*
-</pre>
-<pre> Monad transformer that transforms a monad m into a monad of stateful
-computations that have the base monad type as their result.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#514
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=state-t+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-monad===
-====macro====
-<pre>
-Usage: *(_with-monad_ monad & exprs)*
-</pre>
-<pre> Evaluates an expression after replacing the keywords defining the
-monad operations by the functions associated with these keywords
-in the monad definition given by name.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#102
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-monad+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===writer-m===
-====function====
-<pre>
-Usage: *(_writer-m_ empty-accumulator)*
-</pre>
-<pre> Monad describing computations that accumulate data on the side, e.g.
for
-logging. The monadic values have the structure `[`value log`]`. Any of the
-accumulators from clojure.contrib.accumulators can be used for storing the
-log data. Its empty value is passed as a parameter.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/monads.clj#372
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=writer-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/NsUtilsApiDoc.wiki Sun May 24 20:54:25 2009
+++ /dev/null
@@ -1,92 +0,0 @@
-#summary ns-utils API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for ns-utils=
-by Stephen C. Gilardi
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.ns-utils))
-}}}
-==Overview==
-<pre> Namespace utilities</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#dir dir] [#docs docs] [#get-ns get-ns] [#ns-vars ns-vars] [#print-dir
print-dir] [#print-docs print-docs] [#vars vars]
-
-----
-===dir===
-====macro====
-<pre>
-Usage: *(_dir_ nsname)*
-</pre>
-<pre> Prints a sorted directory of public vars in a namespace</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj#81
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=dir+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===docs===
-====macro====
-<pre>
-Usage: *(_docs_ nsname)*
-</pre>
-<pre> Prints documentation for the public vars in a namespace</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj#86
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=docs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===get-ns===
-====function====
-<pre>
-Usage: *(_get-ns_ ns-sym)*
-</pre>
-<pre> Returns the namespace named by ns-sym or throws if the
-namespace does not exist</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj#47
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=get-ns+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===ns-vars===
-====function====
-<pre>
-Usage: *(_ns-vars_ ns)*
-</pre>
-<pre> Returns a sorted seq of symbols naming public vars in
-a namespace</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj#55
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=ns-vars+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===print-dir===
-====function====
-<pre>
-Usage: *(_print-dir_ ns)*
-</pre>
-<pre> Prints a sorted directory of public vars in a namespace</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj#61
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-dir+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===print-docs===
-====function====
-<pre>
-Usage: *(_print-docs_ ns)*
-</pre>
-<pre> Prints documentation for the public vars in a namespace</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj#67
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-docs+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===vars===
-====macro====
-<pre>
-Usage: *(_vars_ nsname)*
-</pre>
-<pre> Returns a sorted seq of symbols naming public vars in
-a namespace</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/ns_utils.clj#75
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=vars+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/PprintApiDoc.wiki Sat Jun 13 20:43:16 2009
+++ /dev/null
@@ -1,432 +0,0 @@
-#summary pprint API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for pprint=
-by Tom Faulhaber
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.pprint))
-}}}
-==Overview==
-<pre> This module comprises two elements:
-1) A pretty printer for Clojure data structures, implemented in the
function "pprint"
-2) A Common Lisp compatible format function, implemented as "cl-format"
because
- Clojure is using the name "format" for its own format.
-
-Complete documentation is available on the wiki at the contrib google code
site.</pre>
-See also: [PrettyPrinting Documentation for the pretty printer],
[CommonLispFormat Documentation for Common Lisp format function]
-
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#*_code-dispatch_* *code-dispatch*] [#*_print-circle_* *print-circle*]
[#*_print-lines_* *print-lines*] [#*_print-miser-width_*
*print-miser-width*] [#*_print-pprint-dispatch_* *print-pprint-dispatch*]
[#*_print-pretty_* *print-pretty*] [#*_print-right-margin_*
*print-right-margin*] [#*_print-shared_* *print-shared*]
[#*_print-suppress-namespaces_* *print-suppress-namespaces*]
[#*_simple-dispatch_* *simple-dispatch*] [#cl-format cl-format]
[#compile-format compile-format] [#formatter formatter] [#formatter-out
formatter-out] [#fresh-line fresh-line] [#pp pp] [#pprint pprint]
[#pprint-indent pprint-indent] [#pprint-logical-block pprint-logical-block]
[#pprint-newline pprint-newline] [#pprint-tab pprint-tab]
[#set-pprint-dispatch set-pprint-dispatch] [#use-method use-method]
[#with-pprint-dispatch with-pprint-dispatch] [#write write] [#write-out
write-out]
-
-Variables and Functions in pprint.examples.json:
-[PprintApiDoc#dispatch-json dispatch-json] [PprintApiDoc#json-str
json-str] [PprintApiDoc#print-json print-json]
-
-Variables and Functions in pprint.examples.xml:
-[PprintApiDoc#*_html-compatible_* *html-compatible*]
[PprintApiDoc#*_prxml-indent_* *prxml-indent*] [PprintApiDoc#prxml prxml]
-
-----
-===`*`code-dispatch`*`===
-====multimethod====
-<pre>
-Usage: *(_`*`code-dispatch`*`_ object)*
-</pre>
-<pre> The pretty print dispatch function for pretty printing Clojure
code.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/dispatch.clj#353
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*code-dispatch*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-circle`*`===
-====var====
-<pre> Mark circular structures (N.B. This is not yet used)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#56
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-circle*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-lines`*`===
-====var====
-<pre> Maximum number of lines to print in a pretty print instance (N.B.
This is not yet used)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#51
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-lines*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-miser-width`*`===
-====var====
-<pre> The column at which to enter miser style. Depending on the dispatch
table,
-miser style add newlines in more places to try to keep lines short
allowing for further
-levels of nesting.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#44
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-miser-width*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-pprint-dispatch`*`===
-====var====
-<pre> The pretty print dispatch function. Use with-pprint-dispatch or
set-pprint-dispatch
-to modify.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#33
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-pprint-dispatch*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-pretty`*`===
-====var====
-<pre> Bind to true if you want write to use pretty printing</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#29
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-pretty*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-right-margin`*`===
-====var====
-<pre> Pretty printing will try to avoid anything going beyond this column.
-Set it to nil to have pprint let the line be arbitrarily long. This will
ignore all
-non-mandatory newlines.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#38
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-right-margin*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-shared`*`===
-====var====
-<pre> Mark repeated structures rather than repeat them (N.B. This is not
yet used)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#61
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-shared*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`print-suppress-namespaces`*`===
-====var====
-<pre> Don't print namespaces with symbols. This is particularly useful when
-pretty printing the results of macro expansions</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#65
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*print-suppress-namespaces*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`simple-dispatch`*`===
-====multimethod====
-<pre>
-Usage: *(_`*`simple-dispatch`*`_ object)*
-</pre>
-<pre> The pretty print dispatch function for simple data structure
format.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/dispatch.clj#124
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*simple-dispatch*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===cl-format===
-====function====
-<pre>
-Usage: *(_cl-format_ writer format-in & args)*
-</pre>
-<pre> An implementation of a Common Lisp compatible format function.
cl-format formats its
-arguments to an output stream or string based on the format control string
given. It
-supports sophisticated formatting of structured data.
-
-Writer is an instance of java.io.Writer, true to output to `*`out`*` or
nil to output
-to a string, format-in is the format control string and the remaining
arguments
-are the data to be formatted.
-
-The format control string is a string to be output with embedded 'format
directives'
-describing how to format the various arguments passed in.
-
-If writer is nil, cl-format returns the formatted result string.
Otherwise, cl-format
-returns nil.
-
-For example:
- (let `[`results `[`46 38 22`]``]`
- (cl-format true "There ~`[`are~;is~:;are~`]`~:`*` ~d result~:p:
~{~d~^, ~}~%"
- (count results) results))
-
-Prints to `*`out`*`:
- There are 3 results: 46, 38, 22
-
-Detailed documentation on format control strings is available in
the "Common Lisp the
-Language, 2nd edition", Chapter 22 (available online at:
-http://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000)
-and in the Common Lisp HyperSpec at
-http://www.lispworks.com/documentation/HyperSpec/Body/22`_`c.htm</pre>
-
-See also:
[http://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000
Common Lisp the Language],
[http://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm Common Lisp
HyperSpec]
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/cl-format.clj#26
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cl-format+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===compile-format===
-====function====
-<pre>
-Usage: *(_compile-format_ format-str)*
-</pre>
-<pre> Compiles format-str into a compiled format which can be used as an
argument
-to cl-format just like a plain format string. Use this function for
improved
-performance when you're using the same format string repeatedly</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/cl-format.clj#1724
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=compile-format+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===formatter===
-====macro====
-<pre>
-Usage: *(_formatter_ format-in)*
-</pre>
-<pre> Makes a function which can directly run format-in. The function is
-fn `[`stream & args`]` ... and returns nil unless the stream is nil
(meaning
-output to a string) in which case it returns the resulting string.
-
-format-in can be either a control string or a previously compiled
format.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/cl-format.clj#1792
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=formatter+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===formatter-out===
-====macro====
-<pre>
-Usage: *(_formatter-out_ format-in)*
-</pre>
-<pre> Makes a function which can directly run format-in. The function is
-fn `[`& args`]` ... and returns nil. This version of the formatter macro is
-designed to be used with `*`out`*` set to an appropriate Writer. In
particular,
-this is meant to be used as part of a pretty printer dispatch method.
-
-format-in can be either a control string or a previously compiled
format.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/cl-format.clj#1806
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=formatter-out+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===fresh-line===
-====function====
-<pre>
-Usage: *(_fresh-line_)*
-</pre>
-<pre> Make a newline if the Writer is not already at the beginning of the
line.
-N.B. Only works on ColumnWriters right now.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/cl-format.clj#1128
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=fresh-line+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pp===
-====macro====
-<pre>
-Usage: *(_pp_)*
-</pre>
-<pre> A convenience macro that pretty prints the last thing output. This is
-exactly equivalent to (pprint `*`1).</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#211
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pp+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pprint===
-====function====
-<pre>
-Usage: *(_pprint_ object)
- (_pprint_ object writer)*
-</pre>
-<pre> Pretty print object to the optional output writer. If the writer is
not provided,
-print the object to the currently bound value of `*`out`*`.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#200
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pprint+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pprint-indent===
-====function====
-<pre>
-Usage: *(_pprint-indent_ relative-to n)*
-</pre>
-<pre> Create an indent at this point in the pretty printing stream. This
defines how
-following lines are indented. relative-to can be either :block or :current
depending
-whether the indent should be computed relative to the start of the logical
block or
-the current column position. n is an offset.
-
-Output is sent to `*`out`*` which must be a pretty printing writer.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#280
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pprint-indent+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pprint-logical-block===
-====macro====
-<pre>
-Usage: *(_pprint-logical-block_ options`*` body)*
-</pre>
-<pre> Execute the body as a pretty printing logical block with output to
`*`out`*` which
-must be a pretty printing writer. When used from pprint or cl-format, this
can be
-assumed.
-
-Before the body, the caller can optionally specify
options: :prefix, :per-line-prefix,
-and :suffix.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#251
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pprint-logical-block+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pprint-newline===
-====function====
-<pre>
-Usage: *(_pprint-newline_ kind)*
-</pre>
-<pre> Print a conditional newline to a pretty printing stream. kind
specifies if the
-newline is :linear, :miser, :fill, or :mandatory.
-
-Output is sent to `*`out`*` which must be a pretty printing writer.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#271
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pprint-newline+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===pprint-tab===
-====function====
-<pre>
-Usage: *(_pprint-tab_ kind colnum colinc)*
-</pre>
-<pre> Tab at this point in the pretty printing stream. kind specifies
whether the tab
-is :line, :section, :line-relative, or :section-relative.
-
-Colnum and colinc specify the target column and the increment to move the
target
-forward if the output is already past the original target.
-
-Output is sent to `*`out`*` which must be a pretty printing writer.
-
-THIS FUNCTION IS NOT YET IMPLEMENTED.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#292
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=pprint-tab+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===set-pprint-dispatch===
-====function====
-<pre>
-Usage: *(_set-pprint-dispatch_ function)*
-</pre>
-<pre> Set the pretty print dispatch function to a function matching (fn
`[`obj`]` ...)
-where obj is the object to pretty print. That function will be called with
`*`out`*` set
-to a pretty printing writer to which it should do its printing.
-
-For example functions, see `*`simple-dispatch`*` and `*`code-dispatch`*` in
-clojure.contrib.pprint.dispatch.clj.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#216
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=set-pprint-dispatch+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===use-method===
-====function====
-<pre>
-Usage: *(_use-method_ multifn dispatch-val func)*
-</pre>
-<pre> Installs a function as a new method of multimethod associated with
dispatch-value. </pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/dispatch.clj#19
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=use-method+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===with-pprint-dispatch===
-====macro====
-<pre>
-Usage: *(_with-pprint-dispatch_ function & body)*
-</pre>
-<pre> Execute body with the pretty print dispatch function bound to
function.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#227
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=with-pprint-dispatch+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===write===
-====function====
-<pre>
-Usage: *(_write_ object & kw-args)*
-</pre>
-<pre> Write an object subject to the current bindings of the printer
control variables.
-Use the kw-args argument to override individual variables for this call
(and any
-recursive calls). Returns the string result if :stream is nil or nil
otherwise.
-
-The following keyword arguments can be passed with values:
- Keyword Meaning Default value
- :stream Writer for output or nil true
(indicates `*`out`*`)
- :circle`*` If true, mark circular structures Current
value of `*`print-circle`*`
- :length Maximum elements to show in sublists Current value
of `*`print-length`*`
- :level Maximum depth Current value
of `*`print-level`*`
- :lines`*` Maximum lines of output Current
value of `*`print-lines`*`
- :miser-width Width to enter miser mode Current value
of `*`print-miser-width`*`
- :dispatch The pretty print dispatch function Current value
of `*`print-pprint-dispatch`*`
- :pretty If true, do pretty printing Current value
of `*`print-pretty`*`
- :readably`*` If true, print readably Current
value of `*`print-readably`*`
- :right-margin The column for the right margin Current value
of `*`print-right-margin`*`
- :suppress-namespaces If true, no namespaces in symbols Current value
of `*`print-suppress-namespaces`*`
-
- `*` `=` not yet supported</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#160
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=write+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===write-out===
-====function====
-<pre>
-Usage: *(_write-out_ object)*
-</pre>
-<pre> Write an object to `*`out`*` subject to the current bindings of the
printer control
-variables. Use the kw-args argument to override individual variables for
this call (and
-any recursive calls).
-
-`*`out`*` must be a PrettyWriter if pretty printing is enabled. This is
the responsibility
-of the caller.
-
-This method is primarily intended for use by pretty print dispatch
functions that
-already know that the pretty printer will have set up their environment
appropriately.
-Normal library clients should use the standard "write" interface. </pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/pprint_base.clj#135
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=write-out+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.pprint.examples.json==
-<pre> Pretty printing JavaScript Object Notation (JSON) generator.
-
-This is an example of using a pretty printer dispatch function to generate
JSON output</pre>
-See also: [http://json.org/ JSON Home Page]
-
-----
-===dispatch-json===
-====multimethod====
-<pre>
-Usage: *(_dispatch-json_ x)*
-</pre>
-<pre> The dispatch function for printing objects as JSON</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/json.clj#28
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=dispatch-json+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===json-str===
-====function====
-<pre>
-Usage: *(_json-str_ x)*
-</pre>
-<pre> Converts x to a JSON-formatted string.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/json.clj#97
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=json-str+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===print-json===
-====function====
-<pre>
-Usage: *(_print-json_ x)*
-</pre>
-<pre> Prints x as JSON. Nil becomes JSON null. Keywords become
-strings, without the leading colon. Maps become JSON objects, all
-other collection types become JSON arrays. Java arrays become JSON
-arrays. Unicode characters in strings are escaped as \uXXXX.
-Numbers print as with pr.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/json.clj#88
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-json+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-==Namespace clojure.contrib.pprint.examples.xml==
-<pre> A version of prxml that uses a pretty print dispatch function.</pre>
-----
-===`*`html-compatible`*`===
-====var====
-<pre> If true, empty tags will have a space before the closing /></pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/xml.clj#27
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*html-compatible*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===`*`prxml-indent`*`===
-====var====
-<pre> The number of spaces to indent sub-tags.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/xml.clj#31
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*prxml-indent*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===prxml===
-====function====
-<pre>
-Usage: *(_prxml_ & args)*
-</pre>
-<pre> Print XML to `*`out`*`. Vectors become XML tags: the first item is
the
-tag name; optional second item is a map of attributes.
-
-Sequences are processed recursively, so you can use map and other
-sequence functions inside prxml.
-
- (prxml `[`:p {:class "greet"} `[`:i "Ladies & gentlemen"`]``]`)
- ; `=`> <p class`=`"greet"><i>Ladies &amp; gentlemen</i></p>
-
-PSEUDO-TAGS: some keywords have special meaning:
-
- :raw! do not XML-escape contents
- :comment! create an XML comment
- :decl! create an XML declaration, with attributes
- :cdata! create a CDATA section
- :doctype! create a DOCTYPE!
-
- (prxml `[`:p `[`:raw! "<i>here & gone</i>"`]``]`)
- ; `=`> <p><i>here & gone</i></p>
-
- (prxml `[`:decl! {:version "1.1"}`]`)
- ; `=`> <?xml version`=`"1.1" encoding`=`"UTF-8"?></pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/pprint/examples/xml.clj#92
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=prxml+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
--- /wiki/ProbabilitiesFiniteDistributionsApiDoc.wiki Sun May 24 20:54:25
2009
+++ /dev/null
@@ -1,136 +0,0 @@
-#summary probabilities.finite-distributions API Reference
-#sidebar ApiDocSidebar
-
-<wiki:comment>
-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.
-</wiki:comment>
-=API for probabilities.finite-distributions=
-by Konrad Hinsen
-
-Usage:
-{{{
-(ns <your-namespace>
- (:require clojure.contrib.probabilities.finite-distributions))
-}}}
-==Overview==
-<pre> Finite probability distributions
-This library defines a monad for combining finite probability
-distributions.</pre>
-
-
-==Public Variables and Functions==
-Shortcuts:
-[#certainly certainly] [#choose choose] [#cond-dist-m cond-dist-m]
[#cond-prob cond-prob] [#dist-m dist-m] [#join-with join-with]
[#make-distribution make-distribution] [#normalize normalize] [#prob prob]
[#uniform uniform] [#zipf zipf]
-
-----
-===certainly===
-====function====
-<pre>
-Usage: *(_certainly_ v)*
-</pre>
-<pre> Returns a distribution in which the single value v has probability
1.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#148
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=certainly+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===choose===
-====function====
-<pre>
-Usage: *(_choose_ & choices)*
-</pre>
-<pre> Construct a distribution from an explicit list of probabilities
-and values. They are given in the form of a vector of probability-value
-pairs. In the last pair, the probability can be given by the keyword
-:else, which stands for 1 minus the total of the other probabilities.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#94
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=choose+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===cond-dist-m===
-====var====
-<pre> Variant of the dist monad that can handle undefined values.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#48
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cond-dist-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===cond-prob===
-====function====
-<pre>
-Usage: *(_cond-prob_ pred dist)*
-</pre>
-<pre> Returns the conditional probability for the values in dist that
satisfy
-the predicate pred.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#162
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=cond-prob+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===dist-m===
-====var====
-<pre> Monad describing computations on fuzzy quantities, represented by a
finite
-probability distribution for the possible values. A distribution is
-represented by a map from values to probabilities.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#28
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=dist-m+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===join-with===
-====function====
-<pre>
-Usage: *(_join-with_ f dist1 dist2)*
-</pre>
-<pre> Returns the distribution of (f x y) with x from dist1 and y from
dist2.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#153
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=join-with+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===make-distribution===
-====function====
-<pre>
-Usage: *(_make-distribution_ coll f)*
-</pre>
-<pre> Returns the distribution in which each element x of the collection
-has a probability proportional to (f x)</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#136
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=make-distribution+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===normalize===
-====function====
-<pre>
-Usage: *(_normalize_ weights)*
-</pre>
-<pre> Convert a weight map (e.g. a map of counter values) to a distribution
-by multiplying with a normalization factor. If the map has a key
-:total, its value is assumed to be the sum over all the other values and
-it is used for normalization. Otherwise, the sum is calculated
-explicitly. The :total key is removed from the resulting
distribution.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#72
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=normalize+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===prob===
-====function====
-<pre>
-Usage: *(_prob_ pred dist)*
-</pre>
-<pre> Return the probability that the predicate pred is satisfied in the
-distribution dist, i.e. the sum of the probabilities of the values
-that satisfy pred.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#199
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=prob+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===uniform===
-====function====
-<pre>
-Usage: *(_uniform_ coll)*
-</pre>
-<pre> Return a distribution in which each of the elements of coll
-has the same probability.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#86
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=uniform+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
-----
-===zipf===
-====function====
-<pre>
-Usage: *(_zipf_ s n)*
-</pre>
-<pre> Returns the Zipf distribution in which the numbers k`=`1..n have
-probabilities proportional to 1/k^s.</pre>
-
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/probabilities/finite_distributions.clj#142
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=zipf+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
=======================================
***Additional files exist in this changeset.***