From f9f9c9242b61ed3ac1edf3d8db51e3f7d54b9778 Mon Sep 17 00:00:00 2001 From: Tom Faulhaber Date: Tue, 27 Jul 2010 00:58:52 -0700 Subject: Autodoc commit for 1.2.x/25d33167, master/e7930c85, 1.1.x/d132c5f1 --- accumulators-api.html | 61 +- agent-utils-api.html | 27 +- api-index.html | 29 +- apply-macro-api.html | 27 +- base64-api.html | 29 +- branch-1.1.x/accumulators-api.html | 25 +- branch-1.1.x/agent-utils-api.html | 25 +- branch-1.1.x/api-index.html | 27 +- branch-1.1.x/apply-macro-api.html | 25 +- branch-1.1.x/base64-api.html | 25 +- branch-1.1.x/classpath-api.html | 25 +- branch-1.1.x/combinatorics-api.html | 25 +- branch-1.1.x/command-line-api.html | 25 +- branch-1.1.x/complex-numbers-api.html | 25 +- branch-1.1.x/cond-api.html | 25 +- branch-1.1.x/condition-api.html | 25 +- branch-1.1.x/core-api.html | 25 +- branch-1.1.x/dataflow-api.html | 25 +- branch-1.1.x/datalog-api.html | 25 +- branch-1.1.x/def-api.html | 25 +- branch-1.1.x/doc/datalog.html | 20 +- branch-1.1.x/doc/pprint/CommonLispFormat.html | 20 +- branch-1.1.x/doc/pprint/PrettyPrinting.html | 20 +- branch-1.1.x/duck-streams-api.html | 25 +- branch-1.1.x/error-kit-api.html | 25 +- branch-1.1.x/except-api.html | 25 +- branch-1.1.x/fcase-api.html | 25 +- branch-1.1.x/find-namespaces-api.html | 25 +- branch-1.1.x/fnmap-api.html | 25 +- branch-1.1.x/gen-html-docs-api.html | 25 +- branch-1.1.x/generic.arithmetic-api.html | 25 +- branch-1.1.x/generic.collection-api.html | 25 +- branch-1.1.x/generic.comparison-api.html | 25 +- branch-1.1.x/generic.functor-api.html | 25 +- branch-1.1.x/generic.math-functions-api.html | 25 +- branch-1.1.x/graph-api.html | 25 +- branch-1.1.x/greatest-least-api.html | 25 +- branch-1.1.x/http.agent-api.html | 25 +- branch-1.1.x/http.connection-api.html | 25 +- branch-1.1.x/import-static-api.html | 25 +- branch-1.1.x/index.html | 25 +- branch-1.1.x/jar-api.html | 25 +- branch-1.1.x/java-utils-api.html | 25 +- branch-1.1.x/javadoc.browse-api.html | 25 +- branch-1.1.x/jmx-api.html | 25 +- branch-1.1.x/json.read-api.html | 25 +- branch-1.1.x/json.write-api.html | 25 +- branch-1.1.x/lazy-seqs-api.html | 25 +- branch-1.1.x/lazy-xml-api.html | 25 +- branch-1.1.x/logging-api.html | 25 +- branch-1.1.x/macro-utils-api.html | 25 +- branch-1.1.x/macros-api.html | 25 +- branch-1.1.x/map-utils-api.html | 25 +- branch-1.1.x/math-api.html | 25 +- branch-1.1.x/miglayout-api.html | 25 +- branch-1.1.x/mmap-api.html | 25 +- branch-1.1.x/mock-api.html | 25 +- branch-1.1.x/monadic-io-streams-api.html | 25 +- branch-1.1.x/monads-api.html | 25 +- branch-1.1.x/ns-utils-api.html | 25 +- branch-1.1.x/pprint-api.html | 25 +- .../probabilities.finite-distributions-api.html | 25 +- branch-1.1.x/probabilities.monte-carlo-api.html | 25 +- branch-1.1.x/probabilities.random-numbers-api.html | 25 +- branch-1.1.x/profile-api.html | 25 +- branch-1.1.x/prxml-api.html | 25 +- branch-1.1.x/repl-ln-api.html | 25 +- branch-1.1.x/repl-utils-api.html | 25 +- branch-1.1.x/seq-utils-api.html | 25 +- branch-1.1.x/server-socket-api.html | 25 +- branch-1.1.x/set-api.html | 25 +- branch-1.1.x/shell-out-api.html | 25 +- branch-1.1.x/singleton-api.html | 25 +- branch-1.1.x/sql-api.html | 25 +- branch-1.1.x/str-utils-api.html | 25 +- branch-1.1.x/str-utils2-api.html | 25 +- branch-1.1.x/stream-utils-api.html | 25 +- branch-1.1.x/swing-utils-api.html | 25 +- branch-1.1.x/test-is-api.html | 25 +- branch-1.1.x/trace-api.html | 25 +- branch-1.1.x/types-api.html | 25 +- branch-1.1.x/with-ns-api.html | 25 +- branch-1.1.x/zip-filter-api.html | 25 +- branch-master/accumulators-api.html | 330 +++ branch-master/agent-utils-api.html | 116 + branch-master/api-index.html | 939 ++++++++ branch-master/apply-macro-api.html | 119 + branch-master/base64-api.html | 132 ++ branch-master/classpath-api.html | 137 ++ branch-master/combinatorics-api.html | 178 ++ branch-master/command-line-api.html | 111 + branch-master/complex-numbers-api.html | 100 + branch-master/cond-api.html | 118 + branch-master/condition-api.html | 257 +++ branch-master/core-api.html | 194 ++ branch-master/dataflow-api.html | 388 ++++ branch-master/datalog-api.html | 1052 +++++++++ branch-master/def-api.html | 276 +++ branch-master/doc/datalog.html | 225 ++ branch-master/doc/pprint/CommonLispFormat.html | 306 +++ branch-master/doc/pprint/PrettyPrinting.html | 363 ++++ branch-master/duck-streams-api.html | 402 ++++ branch-master/error-kit-api.html | 238 ++ branch-master/except-api.html | 171 ++ branch-master/fcase-api.html | 200 ++ branch-master/find-namespaces-api.html | 297 +++ branch-master/fnmap-api.html | 124 ++ branch-master/gen-html-docs-api.html | 128 ++ branch-master/generic.arithmetic-api.html | 199 ++ branch-master/generic.collection-api.html | 199 ++ branch-master/generic.comparison-api.html | 259 +++ branch-master/generic.functor-api.html | 112 + branch-master/generic.math-functions-api.html | 362 ++++ branch-master/graph-api.html | 306 +++ branch-master/greatest-least-api.html | 202 ++ branch-master/http.agent-api.html | 481 +++++ branch-master/http.connection-api.html | 123 ++ branch-master/import-static-api.html | 124 ++ branch-master/index.html | 2281 ++++++++++++++++++++ branch-master/io-api.html | 553 +++++ branch-master/jar-api.html | 125 ++ branch-master/java-utils-api.html | 346 +++ branch-master/javadoc.browse-api.html | 126 ++ branch-master/jmx-api.html | 455 ++++ branch-master/json-api.html | 187 ++ branch-master/lazy-seqs-api.html | 156 ++ branch-master/lazy-xml-api.html | 147 ++ branch-master/logging-api.html | 394 ++++ branch-master/macro-utils-api.html | 219 ++ branch-master/macros-api.html | 147 ++ branch-master/map-utils-api.html | 155 ++ branch-master/math-api.html | 260 +++ branch-master/miglayout-api.html | 333 +++ branch-master/mmap-api.html | 138 ++ branch-master/mock-api.html | 454 ++++ branch-master/monadic-io-streams-api.html | 262 +++ branch-master/monads-api.html | 645 ++++++ branch-master/ns-utils-api.html | 208 ++ branch-master/pprint-api.html | 694 ++++++ branch-master/priority-map-api.html | 126 ++ .../probabilities.finite-distributions-api.html | 256 +++ branch-master/probabilities.monte-carlo-api.html | 300 +++ .../probabilities.random-numbers-api.html | 134 ++ branch-master/profile-api.html | 212 ++ branch-master/properties-api.html | 183 ++ branch-master/prxml-api.html | 158 ++ branch-master/reflect-api.html | 132 ++ branch-master/repl-ln-api.html | 225 ++ branch-master/repl-utils-api.html | 348 +++ branch-master/seq-api.html | 367 ++++ branch-master/seq-utils-api.html | 367 ++++ branch-master/server-socket-api.html | 134 ++ branch-master/set-api.html | 150 ++ branch-master/shell-api.html | 137 ++ branch-master/shell-out-api.html | 137 ++ branch-master/singleton-api.html | 139 ++ branch-master/sql-api.html | 549 +++++ branch-master/str-utils-api.html | 212 ++ branch-master/str-utils2-api.html | 578 +++++ branch-master/stream-utils-api.html | 310 +++ branch-master/string-api.html | 616 ++++++ branch-master/strint-api.html | 130 ++ branch-master/swing-utils-api.html | 249 +++ branch-master/test-is-api.html | 663 ++++++ branch-master/trace-api.html | 199 ++ branch-master/types-api.html | 178 ++ branch-master/with-ns-api.html | 127 ++ branch-master/zip-filter-api.html | 336 +++ classpath-api.html | 31 +- combinatorics-api.html | 37 +- command-line-api.html | 27 +- complex-numbers-api.html | 25 +- cond-api.html | 27 +- condition-api.html | 35 +- core-api.html | 37 +- dataflow-api.html | 65 +- datalog-api.html | 87 +- def-api.html | 49 +- doc/datalog.html | 20 +- doc/pprint/CommonLispFormat.html | 20 +- doc/pprint/PrettyPrinting.html | 20 +- duck-streams-api.html | 65 +- error-kit-api.html | 43 +- except-api.html | 33 +- fcase-api.html | 35 +- find-namespaces-api.html | 53 +- fnmap-api.html | 27 +- gen-html-docs-api.html | 29 +- generic.arithmetic-api.html | 37 +- generic.collection-api.html | 39 +- generic.comparison-api.html | 45 +- generic.functor-api.html | 27 +- generic.math-functions-api.html | 65 +- graph-api.html | 53 +- greatest-least-api.html | 41 +- http.agent-api.html | 65 +- http.connection-api.html | 29 +- import-static-api.html | 27 +- index.html | 68 +- io-api.html | 75 +- jar-api.html | 29 +- java-utils-api.html | 55 +- javadoc.browse-api.html | 29 +- jmx-api.html | 35 +- json-api.html | 33 +- lazy-seqs-api.html | 31 +- lazy-xml-api.html | 29 +- logging-api.html | 63 +- macro-utils-api.html | 41 +- macros-api.html | 31 +- map-utils-api.html | 33 +- math-api.html | 43 +- miglayout-api.html | 47 +- mmap-api.html | 31 +- mock-api.html | 63 +- monadic-io-streams-api.html | 47 +- monads-api.html | 97 +- ns-utils-api.html | 66 +- pprint-api.html | 86 +- priority-map-api.html | 121 -- probabilities.finite-distributions-api.html | 47 +- probabilities.monte-carlo-api.html | 51 +- probabilities.random-numbers-api.html | 29 +- profile-api.html | 37 +- properties-api.html | 37 +- prxml-api.html | 31 +- reflect-api.html | 25 +- repl-ln-api.html | 39 +- repl-utils-api.html | 57 +- seq-api.html | 61 +- seq-utils-api.html | 61 +- server-socket-api.html | 29 +- set-api.html | 33 +- shell-api.html | 27 +- shell-out-api.html | 27 +- singleton-api.html | 29 +- sql-api.html | 59 +- static/clojure.css | 4 +- str-utils-api.html | 39 +- str-utils2-api.html | 87 +- stream-utils-api.html | 49 +- string-api.html | 97 +- strint-api.html | 27 +- swing-utils-api.html | 25 +- test-is-api.html | 41 +- trace-api.html | 39 +- types-api.html | 33 +- with-ns-api.html | 29 +- zip-filter-api.html | 57 +- 249 files changed, 28380 insertions(+), 2487 deletions(-) create mode 100644 branch-master/accumulators-api.html create mode 100644 branch-master/agent-utils-api.html create mode 100644 branch-master/api-index.html create mode 100644 branch-master/apply-macro-api.html create mode 100644 branch-master/base64-api.html create mode 100644 branch-master/classpath-api.html create mode 100644 branch-master/combinatorics-api.html create mode 100644 branch-master/command-line-api.html create mode 100644 branch-master/complex-numbers-api.html create mode 100644 branch-master/cond-api.html create mode 100644 branch-master/condition-api.html create mode 100644 branch-master/core-api.html create mode 100644 branch-master/dataflow-api.html create mode 100644 branch-master/datalog-api.html create mode 100644 branch-master/def-api.html create mode 100644 branch-master/doc/datalog.html create mode 100644 branch-master/doc/pprint/CommonLispFormat.html create mode 100644 branch-master/doc/pprint/PrettyPrinting.html create mode 100644 branch-master/duck-streams-api.html create mode 100644 branch-master/error-kit-api.html create mode 100644 branch-master/except-api.html create mode 100644 branch-master/fcase-api.html create mode 100644 branch-master/find-namespaces-api.html create mode 100644 branch-master/fnmap-api.html create mode 100644 branch-master/gen-html-docs-api.html create mode 100644 branch-master/generic.arithmetic-api.html create mode 100644 branch-master/generic.collection-api.html create mode 100644 branch-master/generic.comparison-api.html create mode 100644 branch-master/generic.functor-api.html create mode 100644 branch-master/generic.math-functions-api.html create mode 100644 branch-master/graph-api.html create mode 100644 branch-master/greatest-least-api.html create mode 100644 branch-master/http.agent-api.html create mode 100644 branch-master/http.connection-api.html create mode 100644 branch-master/import-static-api.html create mode 100644 branch-master/index.html create mode 100644 branch-master/io-api.html create mode 100644 branch-master/jar-api.html create mode 100644 branch-master/java-utils-api.html create mode 100644 branch-master/javadoc.browse-api.html create mode 100644 branch-master/jmx-api.html create mode 100644 branch-master/json-api.html create mode 100644 branch-master/lazy-seqs-api.html create mode 100644 branch-master/lazy-xml-api.html create mode 100644 branch-master/logging-api.html create mode 100644 branch-master/macro-utils-api.html create mode 100644 branch-master/macros-api.html create mode 100644 branch-master/map-utils-api.html create mode 100644 branch-master/math-api.html create mode 100644 branch-master/miglayout-api.html create mode 100644 branch-master/mmap-api.html create mode 100644 branch-master/mock-api.html create mode 100644 branch-master/monadic-io-streams-api.html create mode 100644 branch-master/monads-api.html create mode 100644 branch-master/ns-utils-api.html create mode 100644 branch-master/pprint-api.html create mode 100644 branch-master/priority-map-api.html create mode 100644 branch-master/probabilities.finite-distributions-api.html create mode 100644 branch-master/probabilities.monte-carlo-api.html create mode 100644 branch-master/probabilities.random-numbers-api.html create mode 100644 branch-master/profile-api.html create mode 100644 branch-master/properties-api.html create mode 100644 branch-master/prxml-api.html create mode 100644 branch-master/reflect-api.html create mode 100644 branch-master/repl-ln-api.html create mode 100644 branch-master/repl-utils-api.html create mode 100644 branch-master/seq-api.html create mode 100644 branch-master/seq-utils-api.html create mode 100644 branch-master/server-socket-api.html create mode 100644 branch-master/set-api.html create mode 100644 branch-master/shell-api.html create mode 100644 branch-master/shell-out-api.html create mode 100644 branch-master/singleton-api.html create mode 100644 branch-master/sql-api.html create mode 100644 branch-master/str-utils-api.html create mode 100644 branch-master/str-utils2-api.html create mode 100644 branch-master/stream-utils-api.html create mode 100644 branch-master/string-api.html create mode 100644 branch-master/strint-api.html create mode 100644 branch-master/swing-utils-api.html create mode 100644 branch-master/test-is-api.html create mode 100644 branch-master/trace-api.html create mode 100644 branch-master/types-api.html create mode 100644 branch-master/with-ns-api.html create mode 100644 branch-master/zip-filter-api.html delete mode 100644 priority-map-api.html diff --git a/accumulators-api.html b/accumulators-api.html index e4caa377..a5d6faa9 100644 --- a/accumulators-api.html +++ b/accumulators-api.html @@ -1,6 +1,6 @@ - accumulators API reference (clojure-contrib) + accumulators - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -95,7 +99,8 @@ namespace.

API for accumulators - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -120,7 +125,7 @@ accumulators.
an item depends on the type of the accumulator. - Source + Source


@@ -131,7 +136,7 @@ an item depends on the type of the accumulator.
Add all elements of a collection coll to the accumulator acc.
- Source + Source


@@ -143,7 +148,7 @@ an item depends on the type of the accumulator. single accumulator of the same type. - Source + Source


@@ -154,7 +159,7 @@ single accumulator of the same type. every item the number of times it was added. - Source + Source


@@ -166,7 +171,7 @@ accumulator, except that the total number of items added is stored as the value of the key :total. - Source + Source


@@ -176,7 +181,7 @@ value of the key :total.
An empty list accumulator. Adding an item appends it at the beginning.
- Source + Source


@@ -186,7 +191,7 @@ value of the key :total.
An empty map accumulator. Items to be added must be [key value] pairs.
- Source + Source


@@ -196,7 +201,7 @@ value of the key :total.
An empty maximum accumulator. Only numbers can be added.
- Source + Source


@@ -207,7 +212,7 @@ value of the key :total. sample variance. Only numbers can be added. - Source + Source


@@ -218,7 +223,7 @@ sample variance. Only numbers can be added. Only numbers can be added. - Source + Source


@@ -228,7 +233,7 @@ Only numbers can be added.
An empty minimum accumulator. Only numbers can be added.
- Source + Source


@@ -238,7 +243,7 @@ Only numbers can be added.
An empty sum accumulator. Only numbers can be added.
- Source + Source


@@ -248,7 +253,7 @@ Only numbers can be added.
An empty queue accumulator. Adding an item appends it at the end.
- Source + Source


@@ -258,7 +263,7 @@ Only numbers can be added.
An empty set accumulator.
- Source + Source


@@ -269,7 +274,7 @@ Only numbers can be added. appends it at the end. - Source + Source


@@ -279,7 +284,7 @@ appends it at the end.
An empty sum accumulator. Only numbers can be added.
- Source + Source


@@ -293,7 +298,7 @@ work in parallel. Added items must be sequences whose number of elements matches the number of sub-accumulators. - Source + Source


@@ -303,7 +308,7 @@ matches the number of sub-accumulators.
An empty vector accumulator. Adding an item appends it at the end.
- Source + Source
diff --git a/agent-utils-api.html b/agent-utils-api.html index 6f68ab46..ad75d239 100644 --- a/agent-utils-api.html +++ b/agent-utils-api.html @@ -1,6 +1,6 @@ - agent-utils API reference (clojure-contrib) + agent-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for agent-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Christophe Grande

Usage:
@@ -89,7 +94,7 @@ Example:
   (capture-and-send [*out*] a f b c)
- Source + Source
diff --git a/api-index.html b/api-index.html index c6dbaa7f..e9b27da2 100644 --- a/api-index.html +++ b/api-index.html @@ -1,6 +1,6 @@ - clojure-contrib - Index + Index - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -50,10 +54,9 @@ namespace.
-

Index of Public Functions and Variables in clojure-contrib - (master branch)

+

Index of Public Functions and Variables - clojure-contrib v1.2 (beta 1)

This page has an alphabetical index of all the documented functions and variables -in clojure-contrib. +in no project name specified. + + + + + + + +
+ + +
+
+
+
+ +

API for accumulators + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.accumulators))
+
+

Overview

+
A generic accumulator interface and implementations of various
+accumulators.
+ + +
+

Public Variables and Functions

+
+
+
+

add

+ multimethod
+
Usage: (add acc item)
+
+
Add item to the accumulator acc. The exact meaning of adding an
+an item depends on the type of the accumulator.
+ + + Source +
+
+
+

add-items

+ function
+
Usage: (add-items acc items)
+
+
Add all elements of a collection coll to the accumulator acc.
+ + + Source +
+
+
+

combine

+ multimethod
+
Usage: (combine & accs)
+
+
Combine the values of the accumulators acc1 and acc2 into a
+single accumulator of the same type.
+ + + Source +
+
+
+

empty-counter

+ var
+

+  
An empty counter accumulator. Its value is a map that stores for
+every item the number of times it was added.
+ + + Source +
+
+
+

empty-counter-with-total

+ var
+

+  
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.
+ + + Source +
+
+
+

empty-list

+ var
+

+  
An empty list accumulator. Adding an item appends it at the beginning.
+ + + Source +
+
+
+

empty-map

+ var
+

+  
An empty map accumulator. Items to be added must be [key value] pairs.
+ + + Source +
+
+
+

empty-maximum

+ var
+

+  
An empty maximum accumulator. Only numbers can be added.
+ + + Source +
+
+
+

empty-mean-variance

+ var
+

+  
An empty mean-variance accumulator, combining sample mean and
+sample variance. Only numbers can be added.
+ + + Source +
+
+
+

empty-min-max

+ var
+

+  
An empty min-max accumulator, combining minimum and maximum.
+Only numbers can be added.
+ + + Source +
+
+
+

empty-minimum

+ var
+

+  
An empty minimum accumulator. Only numbers can be added.
+ + + Source +
+
+
+

empty-product

+ var
+

+  
An empty sum accumulator. Only numbers can be added.
+ + + Source +
+
+
+

empty-queue

+ var
+

+  
An empty queue accumulator. Adding an item appends it at the end.
+ + + Source +
+
+
+

empty-set

+ var
+

+  
An empty set accumulator.
+ + + Source +
+
+
+

empty-string

+ var
+

+  
An empty string accumulator. Adding an item (string or character)
+appends it at the end.
+ + + Source +
+
+
+

empty-sum

+ var
+

+  
An empty sum accumulator. Only numbers can be added.
+ + + Source +
+
+
+

empty-tuple

+ function
+
Usage: (empty-tuple empty-accumulators)
+
+
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.
+ + + Source +
+
+
+

empty-vector

+ var
+

+  
An empty vector accumulator. Adding an item appends it at the end.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/agent-utils-api.html b/branch-master/agent-utils-api.html new file mode 100644 index 00000000..6821c415 --- /dev/null +++ b/branch-master/agent-utils-api.html @@ -0,0 +1,116 @@ + + + agent-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for agent-utils + - clojure-contrib next (in development) +

+by Christophe Grande
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.agent-utils))
+
+

Overview

+
Miscellaneous agent utilities
+(note to other contrib members: feel free to add to this lib)
+ + +
+

Public Variables and Functions

+
+
+
+

capture-and-send

+ macro
+
Usage: (capture-and-send vars agent action & args)
+
+
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)
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/api-index.html b/branch-master/api-index.html new file mode 100644 index 00000000..84b40924 --- /dev/null +++ b/branch-master/api-index.html @@ -0,0 +1,939 @@ + + + Index - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

Index of Public Functions and Variables - clojure-contrib next (in development)

+This page has an alphabetical index of all the documented functions and variables +in no project name specified. + + + +
+Shortcuts:
+A B C D + E F G H + I J K L + M +
+N O P Q + R S T U + V W X Y + Z +
+Other +
+
+ +
+

A

+
+ *allow-direct-logging*       var           logging            A boolean indicating whether direct logging (as op...
+ *append*                     var           io                 If true, writer, output-stream and spit will open ...
+ *append-to-writer*           var           duck-streams       If true, writer and spit will open files in append...
+ abs                          multimethod   generic.math-functions Return the abs of x..
+ abs                          function      math               (abs n) is the absolute value of n.
+ acos                         multimethod   generic.math-functions Return the acos of x..
+ action-translation-table     var           swing-utils        Translation table for the make-action constructor..
+ add                          multimethod   accumulators       Add item to the accumulator acc. The exact meaning...
+ add-action-listener          function      swing-utils        Adds an ActionLister to component. When the action...
+ add-break-thread!            function      repl-utils         Add the given thread to break-threads so that it w...
+ add-cell-watcher             function      dataflow           Adds a watcher to a cell to respond to changes of ...
+ add-cells                    function      dataflow           Given a collection of cells, add them to the dataf...
+ add-items                    function      accumulators       Add all elements of a collection coll to the accum...
+ add-key-typed-listener       function      swing-utils        Adds a KeyListener to component that only responds...
+ add-local-javadoc            function      repl-utils         Adds to the list of local Javadoc paths..
+ add-loops                    function      graph              For each node n, add the edge n->n if not already ...
+ add-menu-item                multimethod   swing-utils        Adds a menu item to the parent according to the it...
+ add-remote-javadoc           function      repl-utils         Adds to the list of remote Javadoc URLs.  package-...
+ all-greatest                 function      greatest-least     Returns all the greatest elements..
+ all-greatest-by              function      greatest-least     Return all the elements for which f yields the gre...
+ all-least                    function      greatest-least     Returns all the least elements..
+ all-least-by                 function      greatest-least     Return all the elements for which f yields the lea...
+ ancestors                    function      zip-filter         Returns a lazy sequence of all ancestors of locati...
+ append-output-stream         function      io                 Like output-stream but opens file for appending.  ...
+ append-spit                  function      duck-streams       Like spit but appends to file..
+ append-spit                  function      io                 Like spit but appends to file..
+ append-writer                function      duck-streams       Like writer but opens file for appending.  Does no...
+ append-writer                function      io                 Like writer but opens file for appending.  Does no...
+ apply-macro                  macro         apply-macro        This is evil.  Don't ever use it.  It makes a macr...
+ apply-template               function      test-is            Replaces _1, _2, _3, etc. in expr with correspondi...
+ approx=                      function      generic.math-functions Return true if the absolute value of the diffe...
+ apropos                      function      repl-utils         Given a regular expression or stringable thing, re...
+ are                          macro         test-is            Checks multiple assertions with a template express...
+ as-file                      multimethod   java-utils         Interpret a String or a java.io.File as a File. Bu...
+ as-object-name               multimethod   jmx                Interpret an object as a JMX ObjectName..
+ as-properties                function      java-utils         Convert any seq of pairs to a java.utils.Propertie...
+ as-properties                function      properties         Convert any seq of pairs to a java.utils.Propertie...
+ as-str                       function      java-utils         Like clojure.core/str, but if an argument is a key...
+ as-str                       function      string             Like clojure.core/str, but if an argument is a key...
+ as-url                       function      io                 Coerces argument (URL, URI, or String) to a java.n...
+ as-url                       multimethod   java-utils         Coerces argument (URL, URI, or String) to a java.n...
+ asin                         multimethod   generic.math-functions Return the asin of x..
+ assert-any                   function      test-is            Returns generic assertion code for any test, inclu...
+ assert-predicate             function      test-is            Returns generic assertion code for any functional ...
+ assoc                        multimethod   generic.collection Returns a new collection in which the values corre...
+ atan                         multimethod   generic.math-functions Return the atan of x..
+ atan2                        multimethod   generic.math-functions Return the atan2 of x and y..
+ attribute-info               function      jmx                Get the MBeanAttributeInfo for an attribute..
+ attribute-names              function      jmx                All attribute names available on an MBean..
+
+
+

B

+
+ *buffer-size*                var           duck-streams       Size, in bytes or characters, of the buffer used w...
+ *buffer-size*                var           io                 Size, in bytes or characters, of the buffer used w...
+ *byte-array-type*            var           duck-streams       Type object for a Java primitive byte array..
+ *byte-array-type*            var           io                 Type object for a Java primitive byte array..
+ bind-continue                function      error-kit          Special form to be used inside a 'with-handler'. C...
+ blank?                       function      str-utils2         True if s is nil, empty, or contains only whitespa...
+ blank?                       function      string             True if s is nil, empty, or contains only whitespa...
+ break-threads                var           repl-utils         Threads to stop when Ctrl-C is pressed.  See 'add-...
+ buffer-bytes                 function      http.agent         The default HTTP agent result handler; it collects...
+ buffer-stream                function      mmap               Returns an InputStream for a ByteBuffer, such as r...
+ build-attribute-info         function      jmx                Construct an MBeanAttributeInfo. Normally called w...
+ build-dataflow               function      dataflow           Given a collection of cells, build and return a da...
+ build-source-cell            function      dataflow           Builds a source cell.
+ build-standard-cell          function      dataflow           Builds a standard cell.
+ build-validator-cell         function      dataflow           Builds a validator cell.
+ build-work-plan              function      datalog            Given a list of rules and a query, build a work pl...
+ butlast                      function      str-utils2         Returns s without the last n characters.  Returns ...
+ butlast                      function      string             Returns s without the last n characters.  Returns ...
+ bytes                        function      http.agent         Returns a Java byte array of the content returned ...
+
+
+

C

+
+ *char-array-type*            var           io                 Type object for a Java primitive char array..
+ *code-dispatch*              multimethod   pprint             The pretty print dispatch function for pretty prin...
+ *connection*                 var           jmx                The connection to be used for JMX ops. Defaults to...
+ call-cc                      function      monads             A computation in the cont monad that calls functio...
+ call-method                  function      reflect            Calls a private or protected method.  params is a ...
+ calls                        function      mock               Creates or associates to an existing expectation h...
+ capitalize                   function      str-utils2         Converts first character of the string to upper-ca...
+ capitalize                   function      string             Converts first character of the string to upper-ca...
+ capture-and-send             macro         agent-utils        Capture the current value of the specified vars an...
+ cartesian-product            function      combinatorics      All the ways to take one item from each sequence.
+ case                         macro         fcase              Like cond, but test-value is compared against the ...
+ ceil                         multimethod   generic.math-functions Return the ceil of x..
+ ceil                         multimethod   math               (ceil n) returns the least integer greater than or...
+ cell                         macro         dataflow           Build a standard cell, like this:  (cell fred ...
+ certainly                    function      probabilities.finite-distributions Returns a distribution in which th...
+ children                     function      zip-filter         Returns a lazy sequence of all immediate children ...
+ children-auto                function      zip-filter         Returns a lazy sequence of all immediate children ...
+ chomp                        function      str-utils          Removes all trailing newline \n or return \r chara...
+ chomp                        function      str-utils2         Removes all trailing newline \n or return \r chara...
+ chomp                        function      string             Removes all trailing newline \n or return \r chara...
+ choose                       function      probabilities.finite-distributions Construct a distribution from an e...
+ chop                         function      str-utils          Removes the last character of string..
+ chop                         function      str-utils2         Removes the last character of string, does nothing...
+ chop                         function      string             Removes the last character of string, does nothing...
+ cl-format                    function      pprint             An implementation of a Common Lisp compatible form...
+ classpath                    function      classpath          Returns a sequence of File objects of the elements...
+ classpath-directories        function      classpath          Returns a sequence of File objects for the directo...
+ classpath-jarfiles           function      classpath          Returns a sequence of JarFile objects for the JAR ...
+ client-error?                function      http.agent         Returns true if the HTTP response code was in the ...
+ clojure-source-file?         function      find-namespaces    Returns true if file is a normal file with a .clj ...
+ clojure-sources-in-jar       function      find-namespaces    Returns a sequence of filenames ending in .clj fou...
+ codepoints                   function      str-utils2         Returns a sequence of integer Unicode code points ...
+ codepoints                   function      string             Returns a sequence of integer Unicode code points ...
+ combinations                 function      combinatorics      All the unique ways of taking n different elements...
+ combine                      multimethod   accumulators       Combine the values of the accumulators acc1 and ac...
+ comment?                     function      find-namespaces    Returns true if form is a (comment ...).
+ compile-format               function      pprint             Compiles format-str into a compiled format which c...
+ component-graph              function      graph              Given a graph, perhaps with cycles, return a reduc...
+ components                   function      miglayout          Returns a map from id (a keyword) to component for...
+ compose-fixtures             function      test-is            Composes two fixture functions, creating a new fix...
+ cond-dist-m                  var           probabilities.finite-distributions Variant of the dist monad that can...
+ cond-let                     macro         cond               Takes a binding-form and a set of test/expr pairs....
+ cond-prob                    function      probabilities.finite-distributions Returns the conditional probabilit...
+ conj                         multimethod   generic.collection Returns a new collection resulting from adding all...
+ conjugate                    multimethod   generic.math-functions Return the conjugate of x..
+ connection                   function      sql                Returns the current database connection (or throws...
+ const                        macro         macros             Evaluate the constant expression expr at compile t...
+ cont-m                       var           monads             Monad describing computations in continuation-pass...
+ contains?                    function      str-utils2         True if s contains the substring..
+ copy                         multimethod   duck-streams       Copies input to output.  Returns nil. Input may be...
+ copy                         function      io                 Copies input to output.  Returns nil. Input may be...
+ cos                          multimethod   generic.math-functions Return the cos of x..
+ create-repl-server           function      server-socket      create a repl on a socket.
+ create-server                function      server-socket      Creates a server socket on port. Upon accept, a ne...
+ create-table                 function      sql                Creates a table on the open database connection gi...
+
+
+

D

+
+ *default-encoding*           var           duck-streams       Name of the default encoding to use when reading &...
+ *default-encoding*           var           io                 Name of the default encoding to use when reading &...
+ debug                        macro         logging            Logs a message at the debug level..
+ deep-merge-with              function      map-utils          Like merge-with, but merges maps recursively, appl...
+ defadt                       macro         types              Define an algebraic data type name by an exhaustiv...
+ defalias                     macro         def                Defines an alias for a var: a new var with the sam...
+ deferror                     macro         error-kit          Define a new error type.
+ defhinted                    macro         def                Defines a var with a type hint matching the class ...
+ defmacro-                    macro         def                Same as defmacro but yields a private definition.
+ defmethod*                   macro         generic.arithmetic Define a method implementation for the multimethod...
+ defmonad                     macro         monads             Define a named monad by defining the monad operati...
+ defmonadfn                   macro         monads             Like defn, but for functions that use monad operat...
+ defn-memo                    macro         def                Just like defn, but memoizes the function using cl...
+ defnk                        macro         def                Define a function accepting keyword arguments. Sym...
+ defonce-                     macro         def                Same as defonce but yields a private definition.
+ defst                        macro         stream-utils       Define the stream transformer name by body. The no...
+ defstream                    macro         stream-utils       Define object of the given type as a stream whose ...
+ defstruct-                   macro         def                Same as defstruct but yields a private definition.
+ defsymbolmacro               macro         macro-utils        Define a symbol macro. Because symbol macros are n...
+ deftemplate                  macro         macro-utils        Define a macro that expands into forms after repla...
+ deftest                      macro         test-is            Defines a test function with no arguments.  Test f...
+ deftest-                     macro         test-is            Like deftest but creates a private var..
+ deftrace                     macro         trace              Use in place of defn; traces each call/return of t...
+ deftype                      macro         types              Define a data type by a type tag (a namespace-qual...
+ deftype-                     macro         types              Same as deftype but the constructor is private..
+ defunbound                   macro         def                Defines an unbound var with optional doc string.
+ defunbound-                  macro         def                Same as defunbound but yields a private definition.
+ defvar                       macro         def                Defines a var with an optional intializer and doc ...
+ defvar-                      macro         def                Same as defvar but yields a private definition.
+ delete-file                  function      io                 Delete file f. Raise an exception if it fails unle...
+ delete-file                  function      java-utils         Delete file f. Raise an exception if it fails unle...
+ delete-file-recursively      function      io                 Delete file f. If it's a directory, recursively de...
+ delete-file-recursively      function      java-utils         Delete file f. If it's a directory, recursively de...
+ delete-rows                  function      sql                Deletes rows from a table. where-params is a vecto...
+ dependency-list              function      graph              Similar to a topological sort, this returns a vect...
+ descendants                  function      zip-filter         Returns a lazy sequence of all descendants of loca...
+ dir                          macro         ns-utils           Prints a sorted directory of public vars in a name...
+ discrete                     function      probabilities.monte-carlo A discrete distribution, defined by a map d...
+ display-cell                 multimethod   dataflow           A 'readable' form of the cell.
+ dissoc                       multimethod   generic.collection Returns a new collection in which the entries corr...
+ dissoc-in                    function      core               Dissociates an entry from a nested associative str...
+ dist-m                       var           probabilities.finite-distributions Monad describing computations on f...
+ do-commands                  function      sql                Executes SQL commands on the open database connect...
+ do-not-handle                macro         error-kit          Use in a tail position of a 'handle' form to indic...
+ do-prepared                  function      sql                Executes an (optionally parameterized) SQL prepare...
+ do-swing                     macro         swing-utils        Executes body in the Swing event thread asynchrono...
+ do-swing*                    function      swing-utils        Runs thunk in the Swing event thread according to ...
+ do-swing-and-wait            macro         swing-utils        Executes body in the Swing event thread synchronou...
+ do-template                  macro         test-is            Repeatedly evaluates template expr (in a do block)...
+ dochars                      macro         str-utils2         bindings => [name string]  Repeatedly executes bod...
+ dochars                      macro         string             bindings => [name string]  Repeatedly executes bod...
+ docodepoints                 macro         str-utils2         bindings => [name string]  Repeatedly executes bod...
+ docodepoints                 macro         string             bindings => [name string]  Repeatedly executes bod...
+ docs                         macro         ns-utils           Prints documentation for the public vars in a name...
+ domonad                      macro         monads             Monad comprehension. Takes the name of a monad, a ...
+ done?                        function      http.agent         Returns true if the HTTP request/response has comp...
+ dotrace                      macro         trace              Given a sequence of function identifiers, evaluate...
+ drop                         function      str-utils2         Drops first n characters from s.  Returns an empty...
+ drop                         function      string             Drops first n characters from s.  Returns an empty...
+ drop-table                   function      sql                Drops a table on the open database connection give...
+
+
+

E

+
+ *enable-profiling*           var           profile            Set this to false before loading/compiling to omit...
+ empty                        multimethod   generic.collection Returns an empty collection of the same kind as th...
+ empty-counter                var           accumulators       An empty counter accumulator. Its value is a map t...
+ empty-counter-with-total     var           accumulators       An empty counter-with-total accumulator. It works ...
+ empty-list                   var           accumulators       An empty list accumulator. Adding an item appends ...
+ empty-map                    var           accumulators       An empty map accumulator. Items to be added must b...
+ empty-maximum                var           accumulators       An empty maximum accumulator. Only numbers can be ...
+ empty-mean-variance          var           accumulators       An empty mean-variance accumulator, combining samp...
+ empty-min-max                var           accumulators       An empty min-max accumulator, combining minimum an...
+ empty-minimum                var           accumulators       An empty minimum accumulator. Only numbers can be ...
+ empty-product                var           accumulators       An empty sum accumulator. Only numbers can be adde...
+ empty-queue                  var           accumulators       An empty queue accumulator. Adding an item appends...
+ empty-set                    var           accumulators       An empty set accumulator..
+ empty-string                 var           accumulators       An empty string accumulator. Adding an item (strin...
+ empty-sum                    var           accumulators       An empty sum accumulator. Only numbers can be adde...
+ empty-tuple                  function      accumulators       Returns an accumulator tuple with the supplied emp...
+ empty-vector                 var           accumulators       An empty vector accumulator. Adding an item append...
+ enabled?                     macro         logging            Returns true if the specific logging level is enab...
+ encode                       function      base64             Encodes bytes of input, writing Base 64 text on ou...
+ encode-str                   function      base64             Encodes String in base 64; returns a String.  If n...
+ error                        function      error-kit          Base type for all error-kit errors.
+ error                        macro         logging            Logs a message at the error level..
+ error?                       function      http.agent         Returns true if the HTTP response code was in the ...
+ escape                       function      str-utils2         Returns a new String by applying cmap (a function ...
+ escape                       function      string             Returns a new String by applying cmap (a function ...
+ eval-cell                    multimethod   dataflow           Evaluate a dataflow cell.  Return [changed, old va...
+ exact-integer-sqrt           function      math               (exact-integer-sqrt n) expects a non-negative inte...
+ exp                          multimethod   generic.math-functions Return the exp of x..
+ expect                       macro         mock               Use expect to redirect calls to dependent function...
+ exponential                  function      probabilities.monte-carlo Transform a sequence of uniform random numb...
+ expression-info              function      repl-utils         Uses the Clojure compiler to analyze the given s-e...
+ expt                         multimethod   math               (expt base pow) is base to the pow power. Returns ...
+
+
+

F

+
+ *full-stack-traces*          var           condition          Bind to true to include clojure.{core,lang,main} f...
+ fatal                        macro         logging            Logs a message at the fatal level..
+ fcase                        macro         fcase              Generic switch/case macro.  'fcase' is short for '...
+ fetch-state                  function      monads             Return a state-monad function that returns the cur...
+ fetch-val                    function      monads             Return a state-monad function that assumes the sta...
+ fibs                         function      lazy-seqs          Returns a lazy sequence of all the Fibonacci numbe...
+ file                         function      io                 Returns a java.io.File from string or file args..
+ file                         function      java-utils         Returns a java.io.File from string or file args..
+ file-position                function      test-is            Returns a vector [filename line-number] for the nt...
+ file-str                     function      duck-streams       Concatenates args as strings and returns a java.io...
+ file-str                     function      io                 Concatenates args as strings and returns a java.io...
+ filenames-in-jar             function      jar                Returns a sequence of Strings naming the non-direc...
+ fill-queue                   function      seq                filler-func will be called in another thread with ...
+ fill-queue                   function      seq-utils          filler-func will be called in another thread with ...
+ find-clojure-sources-in-dir  function      find-namespaces    Searches recursively under dir for Clojure source ...
+ find-connection              function      sql                Returns the current database connection (or nil if...
+ find-first                   function      seq                Returns the first item of coll for which (pred ite...
+ find-first                   function      seq-utils          Returns the first item of coll for which (pred ite...
+ find-holes                   function      test-is            Recursively finds all symbols starting with _ in f...
+ find-javadoc-url             function      repl-utils         Searches for a URL for the given class name.  Trie...
+ find-namespaces-in-dir       function      find-namespaces    Searches dir recursively for (ns ...) declarations...
+ find-namespaces-in-jarfile   function      find-namespaces    Searches the JAR file for Clojure source files con...
+ find-namespaces-on-classpath function      find-namespaces    Searches CLASSPATH (both directories and JAR files...
+ find-ns-decls-in-dir         function      find-namespaces    Searches dir recursively for (ns ...) declarations...
+ find-ns-decls-in-jarfile     function      find-namespaces    Searches the JAR file for Clojure source files con...
+ find-ns-decls-on-classpath   function      find-namespaces    Searches CLASSPATH (both directories and JAR files...
+ find-pure-exprs              function      test-is            Recursively finds all sub-expressions in form that...
+ find-symbols                 function      test-is            Recursively finds all symbols in form..
+ fixed-point                  function      graph              Repeatedly apply fun to data until (equal old-data...
+ flatten                      function      seq                DEPRECATED. Prefer clojure.core version. Takes any...
+ flatten                      function      seq-utils          DEPRECATED. Prefer clojure.core version. Takes any...
+ flatten-map                  function      test-is            Transforms a map into a vector like [key value key...
+ floor                        multimethod   generic.math-functions Return the floor of x..
+ floor                        multimethod   math               (floor n) returns the greatest integer less than o...
+ flush                        function      monadic-io-streams Flush.
+ fmap                         multimethod   generic.functor    Applies function f to each item in the data struct...
+ fnmap                        function      fnmap              Creates a fnmap, or functional map.  A fnmap behav...
+ formatter                    macro         pprint             Makes a function which can directly run format-in....
+ formatter-out                macro         pprint             Makes a function which can directly run format-in....
+ frequencies                  function      seq                DEPRECATED. Prefer clojure.core version. Returns a...
+ frequencies                  function      seq-utils          DEPRECATED. Prefer clojure.core version. Returns a...
+ fresh-line                   function      pprint             Make a newline if the Writer is not already at the...
+ function?                    function      test-is            Returns true if argument is a function or a symbol...
+
+
+

G

+
+ gcd                          function      math               (gcd a b) returns the greatest common divisor of a...
+ generate-documentation       function      gen-html-docs      Returns a string which is the HTML documentation f...
+ generate-documentation-to-file function    gen-html-docs      Calls generate-documentation on the libraries name...
+ get                          multimethod   generic.collection Returns the element of coll referred to by key. Ea...
+ get                          function      str-utils2         Gets the i'th character in string..
+ get                          function      string             Gets the i'th character in string..
+ get-cell                     function      dataflow           Get the single cell named by name.
+ get-cells                    function      dataflow           Get all the cells named by name.
+ get-field                    function      reflect            Access to private or protected field.  field-name ...
+ get-neighbors                function      graph              Get the neighbors of a node..
+ get-ns                       function      ns-utils           Returns the namespace named by ns-sym or throws if...
+ get-old-value                function      dataflow           Looks up an old value.
+ get-possibly-unbound-var     function      test-is            Like var-get but returns nil if the var is unbound...
+ get-source                   function      repl-utils         Returns a string of the source code for the given ...
+ get-source-cells             function      dataflow           Returns a collection of source cells from the data...
+ get-system-property          function      java-utils         Get a system property..
+ get-system-property          function      properties         Get a system property..
+ get-value                    function      dataflow           Gets a value from the df matching the passed symbo...
+ get-value-from-cell          function      dataflow           Given a cell, get its value.
+ get-values                   function      dataflow           Gets a collection of values from the df by name.
+ global-singleton             function      singleton          Returns a global singleton function.  f is a funct...
+ greatest                     function      greatest-least     Return the greatest argument..
+ greatest-by                  function      greatest-least     Return the argument for which f yields the greates...
+ grep                         function      str-utils2         Filters elements of coll by a regular expression. ...
+ grep                         function      string             Filters elements of coll by a regular expression. ...
+ group-by                     function      seq                DEPRECATED. Prefer clojure.core version. Returns ...
+ group-by                     function      seq-utils          DEPRECATED. Prefer clojure.core version. Returns ...
+ guess-attribute-typename     function      jmx                Guess the attribute typename for MBeanAttributeInf...
+
+
+

H

+
+ *html-compatible*            var           prxml              If true, empty tags will have a space before the c...
+ handle                       function      error-kit          Special form to be used inside a 'with-handler'.  ...
+ handler-case                 macro         condition          Executes body in a context where raised conditions...
+ has-args                     macro         mock               Creates or associates to an existing expectation h...
+ has-matching-signature?      function      mock               Calls no-matching-function-signature if no match i...
+ headers                      function      http.agent         Returns a map of HTTP response headers.  Header na...
+ headers-seq                  function      http.agent         Returns the HTTP response headers in order as a se...
+ http-agent                   function      http.agent         Creates (and immediately returns) an Agent represe...
+ http-connection              function      http.connection    Opens an HttpURLConnection at the URL, handled by ...
+
+
+

I

+
+ *impl-name*                  var           logging            The name of the logging implementation used..
+ identity-m                   var           monads             Monad describing plain computations. This monad do...
+ immigrate                    function      ns-utils           Create a public var in this namespace for each pub...
+ impl-enabled?                var           logging            Implementation-specific check if a particular leve...
+ impl-get-log                 var           logging            Returns an implementation-specific log by string n...
+ impl-write!                  var           logging            Implementation-specific write of a log message. En...
+ import-static                macro         import-static      Imports the named static fields and/or static meth...
+ in-case                      macro         fcase              Like case, but test expressions are sequences.  Th...
+ inc-report-counter           function      test-is            Increments the named counter in *report-counters*,...
+ includes?                    function      seq                Returns true if coll contains something equal (wit...
+ includes?                    function      seq-utils          Returns true if coll contains something equal (wit...
+ indexed                      function      seq                Returns a lazy sequence of [index, item] pairs, wh...
+ indexed                      function      seq-utils          Returns a lazy sequence of [index, item] pairs, wh...
+ info                         macro         logging            Logs a message at the info level..
+ input-stream                 function      io                 Attempts to coerce its argument into an open java....
+ insert-records               function      sql                Inserts records into a table. records are maps fro...
+ insert-rows                  function      sql                Inserts complete rows into a table. Each row is a ...
+ insert-values                function      sql                Inserts rows into a table with values for specifie...
+ instance-case                macro         fcase              Like case, but the test expressions are Java class...
+ into                         multimethod   generic.collection Returns a new coll consisting of to-coll with all ...
+ is                           macro         test-is            Generic assertion macro.  'form' is any predicate ...
+ is-rollback-only             function      sql                Returns true if the outermost transaction will rol...
+
+
+

J

+
+ jar-file?                    function      jar                Returns true if file is a normal file with a .jar ...
+ javadoc                      function      repl-utils         Opens a browser window displaying the javadoc for ...
+ jmx->clj                     multimethod   jmx                Coerce JMX data structures into Clojure data. Hand...
+ jmx-url                      function      jmx                Build a JMX URL from options..
+ join                         function      str-utils2         Returns a string of all elements in coll, separate...
+ join                         function      string             Returns a string of all elements in coll, separate...
+ join-fixtures                function      test-is            Composes a collection of fixtures, in order.  Alwa...
+ join-with                    function      probabilities.finite-distributions Returns the distribution of (f x y...
+ json-str                     function      json               Converts x to a JSON-formatted string..
+
+
+

K

+
+
+
+

L

+
+ *load-tests*                 var           test-is            True by default.  If set to false, no test functio...
+ *local-javadocs*             var           repl-utils         Ref to a list of local paths for Javadoc-generated...
+ *logging-agent*              var           logging            The default agent used for performing logging durn...
+ lazy-get                     macro         map-utils          Like get, but doesn't evaluate not-found unless it...
+ lazy-walk                    function      graph              Return a lazy sequence of the nodes of a graph sta...
+ lcg                          function      probabilities.random-numbers Create a linear congruential generator.
+ lcm                          function      math               (lcm a b) returns the least common multiple of a a...
+ least                        function      greatest-least     Return the smallest element..
+ least-by                     function      greatest-least     Return the argument for which f yields the smalles...
+ left-locs                    function      zip-filter         Returns a lazy sequence of locations to the left o...
+ leftmost?                    function      zip-filter         Returns true if there are no more nodes to the lef...
+ letfn-                       macro         macros             OBSOLETE: use clojure.core/letfn A variant of let ...
+ lex-permutations             function      combinatorics      Fast lexicographic permutation generator for a seq...
+ log                          multimethod   generic.math-functions Return the log of x..
+ log                          macro         logging            Logs a message, either directly or via an agent. A...
+ log-capture!                 function      logging            Captures System.out and System.err, redirecting al...
+ log-stream                   function      logging            Creates a PrintStream that will output to the log....
+ log-uncapture!               function      logging            Restores System.out and System.err to their origin...
+ lognormal                    function      probabilities.monte-carlo Transform a sequence of uniform random numb...
+ lower-case                   function      str-utils2         Converts string to all lower-case..
+ lower-case                   function      string             Converts string to all lower-case..
+ ltrim                        function      str-utils2         Removes whitespace from the left side of string..
+ ltrim                        function      string             Removes whitespace from the left side of string. D...
+
+
+

M

+
+ m-chain                      var           monads             Chains together monadic computation steps that are...
+ m-fmap                       var           monads             Bind the monadic value m to the function returning...
+ m-join                       var           monads             Converts a monadic value containing a monadic valu...
+ m-lift                       macro         monads             Converts a function f of n arguments into a functi...
+ m-map                        var           monads             'Executes' the sequence of monadic values resultin...
+ m-reduce                     var           monads             Return the reduction of (m-lift 2 f) over the list...
+ m-seq                        var           monads             'Executes' the monadic values in ms and returns a ...
+ m-until                      var           monads             While (p x) is false, replace x by the value retur...
+ m-when                       macro         monads             If test is logical true, return monadic value m-ex...
+ m-when-not                   macro         monads             If test if logical false, return monadic value m-e...
+ macrolet                     macro         macro-utils        Define local macros that are used in the expansion...
+ make-action                  function      swing-utils        Create an Action proxy from the given action spec....
+ make-arg-checker             function      mock               Creates the argument verifying function for a repl...
+ make-count-checker           function      mock               creates the count checker that is invoked at the e...
+ make-distribution            function      probabilities.finite-distributions Returns the distribution in which ...
+ make-menubar                 function      swing-utils        Create a menubar containing the given sequence of ...
+ make-mock                    function      mock               creates a vector containing the following informat...
+ make-parents                 function      duck-streams       Creates all parent directories of file..
+ make-parents                 function      io                 Creates all parent directories of file..
+ map->attribute-infos         function      jmx                Construct an MBeanAttributeInfo[] from a Clojure a...
+ map-str                      function      str-utils2         Apply f to each element of coll, concatenate all r...
+ map-str                      function      string             Apply f to each element of coll, concatenate all r...
+ match                        macro         types              Given a value and a list of template-expr clauses,...
+ max                          function      generic.comparison Returns the greatest of its arguments. Like clojur...
+ maybe-atomize                function      jmx                Convert a list of length 1 into its contents, leav...
+ maybe-keywordize             function      jmx                Convert a string key to a keyword, leaving other t...
+ maybe-m                      var           monads             Monad describing computations with possible failur...
+ maybe-t                      function      monads             Monad transformer that transforms a monad m into a...
+ mbean                        function      jmx                Like clojure.core/bean, but for JMX beans. Returns...
+ mbean-names                  function      jmx                Finds all MBeans matching a name on the current *c...
+ menu-constructor-dispatch    var           swing-utils        An atom containing the dispatch set for the add-me...
+ message                      function      http.agent         Returns the HTTP response message (e.g. 'Not Found...
+ method                       function      http.agent         Returns the HTTP method name used by this HTTP age...
+ mexpand                      function      macro-utils        Like clojure.core/macroexpand, but takes into acco...
+ mexpand-1                    function      macro-utils        Like clojure.core/macroexpand-1, but takes into ac...
+ mexpand-all                  function      macro-utils        Perform a full recursive macro expansion of a form...
+ miglayout                    function      miglayout          Adds java.awt.Components to a javax.swing.JCompone...
+ min                          function      generic.comparison Returns the least of its arguments. Like clojure.c...
+ mmap                         function      mmap               Memory-map the file named f.  Returns a ByteBuffer...
+ monad                        macro         monads             Define a monad by defining the monad operations. T...
+ monad-transformer            macro         monads             Define a monad transforer in terms of the monad op...
+
+
+

N

+
+ n-sphere                     function      probabilities.monte-carlo Return a uniform distribution of n-dimensio...
+ name-with-attributes         function      def                To be used in macro definitions. Handles optional ...
+ neg?                         multimethod   generic.comparison Return true of x is negative..
+ new-by-name                  function      core               Constructs a Java object whose class is specified ...
+ normal                       function      probabilities.monte-carlo Transform a sequence urs of uniform random ...
+ normal-box-muller            function      probabilities.monte-carlo Transform a sequence of uniform random numb...
+ normalize                    function      probabilities.finite-distributions Convert a weight map (e.g. a map o...
+ ns-decl?                     function      find-namespaces    Returns true if form is a (ns ...) declaration..
+ ns-vars                      function      ns-utils           Returns a sorted seq of symbols naming public vars...
+
+
+

O

+
+ op-param-types               function      jmx                The parameter types (as class name strings) for op...
+ open-url-in-browser          function      javadoc.browse     Opens url (a string) in the default system web bro...
+ open-url-in-swing            function      javadoc.browse     Opens url (a string) in a Swing window..
+ operation                    function      jmx                The MBeanOperationInfo for operation op on mbean n...
+ operation-names              function      jmx                All operation names available on an MBean..
+ operations                   function      jmx                All oeprations available on an MBean..
+ output-stream                function      io                 Attempts to coerce its argument into an open java....
+
+
+

P

+
+ *print-base*                 var           pprint             The base to use for printing integers and rational...
+ *print-circle*               var           pprint             Mark circular structures (N.B. This is not yet use...
+ *print-lines*                var           pprint             Maximum number of lines to print in a pretty print...
+ *print-miser-width*          var           pprint             The column at which to enter miser style. Dependin...
+ *print-pprint-dispatch*      var           pprint             The pretty print dispatch function. Use with-pprin...
+ *print-pretty*               var           pprint             Bind to true if you want write to use pretty print...
+ *print-radix*                var           pprint             Print a radix specifier in front of integers and r...
+ *print-right-margin*         var           pprint             Pretty printing will try to avoid anything going b...
+ *print-shared*               var           pprint             Mark repeated structures rather than repeat them (...
+ *print-suppress-namespaces*  var           pprint             Don't print namespaces with symbols. This is parti...
+ *prxml-indent*               var           prxml              The number of spaces to indent sub-tags.  nil for ...
+ parse-seq                    function      lazy-xml           Parses the source s, which can be a File, InputStr...
+ parse-trim                   function      lazy-xml           Parses the source s, which can be a File, InputStr...
+ partial                      function      str-utils2         Like clojure.core/partial for functions that take ...
+ partition                    function      str-utils2         Splits the string into a lazy sequence of substrin...
+ partition                    function      string             Splits the string into a lazy sequence of substrin...
+ partition-all                function      seq                DEPRECATED. Prefer clojure.core version. Returns a...
+ partition-all                function      seq-utils          DEPRECATED. Prefer clojure.core version. Returns a...
+ partition-by                 function      seq                DEPRECATED. Prefer clojure.core version. Applies f...
+ partition-by                 function      seq-utils          DEPRECATED. Prefer clojure.core version. Applies f...
+ per-thread-singleton         function      singleton          Returns a per-thread singleton function.  f is a f...
+ permutations                 function      combinatorics      All the permutations of items, lexicographic by in...
+ pick                         function      stream-utils       Return the next value of stream argument n inside ...
+ pick-all                     function      stream-utils       Return a vector containing the next value of each ...
+ pos?                         multimethod   generic.comparison Return true of x is positive..
+ positions                    function      seq                Returns a lazy sequence containing the positions a...
+ positions                    function      seq-utils          Returns a lazy sequence containing the positions a...
+ post-ordered-nodes           function      graph              Return a sequence of indexes of a post-ordered wal...
+ pow                          multimethod   generic.math-functions Return the pow of x and y..
+ powers-of-2                  function      lazy-seqs          Returns a lazy sequence of all the powers of 2.
+ pp                           macro         pprint             A convenience macro that pretty prints the last th...
+ pprint                       function      pprint             Pretty print object to the optional output writer....
+ pprint-indent                function      pprint             Create an indent at this point in the pretty print...
+ pprint-json                  function      json               Pretty-prints JSON representation of x to *out*.
+ pprint-logical-block         macro         pprint             Execute the body as a pretty printing logical bloc...
+ pprint-newline               function      pprint             Print a conditional newline to a pretty printing s...
+ pprint-tab                   function      pprint             Tab at this point in the pretty printing stream. k...
+ primes                       var           lazy-seqs          Lazy sequence of all the prime numbers..
+ print                        function      monadic-io-streams Print obj.
+ print-dataflow               function      dataflow           Prints a dataflow, one cell per line.
+ print-dir                    function      ns-utils           Prints a sorted directory of public vars in a name...
+ print-docs                   function      ns-utils           Prints documentation for the public vars in a name...
+ print-json                   function      json               Write JSON-formatted output to *out*.
+ print-repl-info              function      repl-ln            Prints info about the current repl.
+ print-stack-trace            function      condition          Prints a stack trace for a condition or Throwable....
+ print-summary                function      profile            Prints a table of the results returned by summariz...
+ println                      function      monadic-io-streams Print obj followed by a newline.
+ priority-map                 function      priority-map       keyval => key val Returns a new priority map with ...
+ priority-map-by              function      priority-map       keyval => key val Returns a new priority map with ...
+ prob                         function      probabilities.finite-distributions Return the probability that the pr...
+ prof                         macro         profile            If *enable-profiling* is true, wraps body in profi...
+ profile                      macro         profile            Runs body with profiling enabled, then prints a su...
+ proper-subset?               function      set                Is s1 a proper subset of s2?.
+ proper-superset?             function      set                Is s1 a proper superset of s2?.
+ prxml                        function      prxml              Print XML to *out*.  Vectors become XML tags: the ...
+ pwd                          function      duck-streams       Returns current working directory as a String.  (L...
+ pwd                          function      io                 Returns current working directory as a String.  (L...
+
+
+

Q

+
+ qsym                         macro         generic.arithmetic Create the qualified symbol corresponding to sym i...
+
+
+

R

+
+ *remote-javadocs*            var           repl-utils         Ref to a map from package name prefixes to URLs fo...
+ raise                        macro         condition          Raises a condition. With no arguments, re-raises t...
+ raise                        macro         error-kit          Raise an error of the type err-name, constructed w...
+ raise*                       function      error-kit          Raise the given error object, best if created by a...
+ rand-elt                     function      seq                DEPRECATED. Prefer clojure.core/rand-nth. Return a...
+ rand-elt                     function      seq-utils          DEPRECATED. Prefer clojure.core/rand-nth. Return a...
+ rand-stream                  var           probabilities.random-numbers A random number stream based on clojure....
+ random-stream                function      probabilities.monte-carlo Define a random stream by a distribution an...
+ raw-read                     function      jmx                Read an mbean property. Returns low-level Java obj...
+ re-case                      macro         fcase              Like case, but the test expressions are regular ex...
+ re-gsub                      function      str-utils          Replaces all instances of 'pattern' in 'string' wi...
+ re-partition                 function      str-utils          Splits the string into a lazy sequence of substrin...
+ re-split                     function      str-utils          Splits the string on instances of 'pattern'.  Retu...
+ re-sub                       function      str-utils          Replaces the first instance of 'pattern' in 'strin...
+ read                         var           jmx                Read an mbean property..
+ read-char                    function      monadic-io-streams Read a single character.
+ read-file-ns-decl            function      find-namespaces    Attempts to read a (ns ...) declaration from file,...
+ read-json                    function      json               Reads one JSON value from input String or Reader. ...
+ read-json-from               function      json               Reads one JSON value from input String or Reader. ...
+ read-line                    function      monadic-io-streams Read a single line.
+ read-lines                   function      duck-streams       Like clojure.core/line-seq but opens f with reader...
+ read-lines                   function      io                 Like clojure.core/line-seq but opens f with reader...
+ read-lines                   function      monadic-io-streams Read all lines and return them in a vector.
+ read-ns-decl                 function      find-namespaces    Attempts to read a (ns ...) declaration from rdr, ...
+ read-ns-decl-from-jarfile-entry function   find-namespaces    Attempts to read a (ns ...) declaration from the n...
+ read-properties              function      java-utils         Read properties from file-able..
+ read-properties              function      properties         Read properties from file-able..
+ read-supported               function      jmx                Calls read to read an mbean property, *returning* ...
+ readable?                    function      jmx                Is attribute readable?.
+ reader                       multimethod   duck-streams       Attempts to coerce its argument into an open java....
+ reader                       function      io                 Attempts to coerce its argument into an open java....
+ rec-cat                      macro         seq                Similar to lazy-cat but binds the resulting sequen...
+ rec-cat                      macro         seq-utils          Similar to lazy-cat but binds the resulting sequen...
+ rec-seq                      macro         seq                Similar to lazy-seq but binds the resulting seq to...
+ rec-seq                      macro         seq-utils          Similar to lazy-seq but binds the resulting seq to...
+ recursive-component?         function      graph              Is the component (recieved from scc) self recursiv...
+ redirect?                    function      http.agent         Returns true if the HTTP response code was in the ...
+ reductions                   function      seq                DEPRECATED. Prefer clojure.core version. Returns a...
+ reductions                   function      seq-utils          DEPRECATED. Prefer clojure.core version. Returns a...
+ reject                       function      probabilities.monte-carlo Return the distribution that results from r...
+ relative-path-string         multimethod   io                 Interpret a String or java.io.File as a relative p...
+ relative-path-string         multimethod   java-utils         Interpret a String or java.io.File as a relative p...
+ remove-cells                 function      dataflow           Given a collection of cells, remove them from the ...
+ remove-loops                 function      graph              For each node n, remove any edges n->n..
+ repeat                       function      str-utils2         Returns a new String containing s repeated n times...
+ repeat                       function      string             Returns a new String containing s repeated n times...
+ repl                         function      repl-ln            A repl that supports line numbers. For definitions...
+ repl-info                    function      repl-ln            Returns a map of info about the current repl.
+ repl-prompt                  function      repl-ln            Returns the current repl prompt based on this repl...
+ replace                      multimethod   str-utils2         Replaces all instances of pattern in string with r...
+ replace-by                   function      string             Replaces all matches of re in s with the result of...
+ replace-char                 function      string             Replaces all instances of character a with charact...
+ replace-first                multimethod   str-utils2         Replaces the first instance of pattern in s with r...
+ replace-first-by             function      string             Replace first match of re in s with the result of ...
+ replace-first-re             function      string             Replace first match of re in s..
+ replace-first-str            function      string             Replace first occurance of substring a with b in s...
+ replace-re                   function      string             Replaces all matches of re with replacement in s..
+ replace-str                  function      string             Replaces all instances of substring a with b in s..
+ report                       multimethod   test-is            Generic reporting function, may be overridden to p...
+ request-body                 function      http.agent         Returns the HTTP request body given to this HTTP a...
+ request-headers              function      http.agent         Returns the request headers specified for this HTT...
+ request-uri                  function      http.agent         Returns the URI/URL requested by this HTTP agent, ...
+ result                       function      http.agent         Returns the value returned by the :handler functio...
+ returns                      function      mock               Creates or associates to an existing expectation h...
+ reverse                      function      str-utils2         Returns s with its characters reversed..
+ reverse                      function      string             Returns s with its characters reversed..
+ reverse-graph                function      graph              Given a directed graph, return another directed gr...
+ right-locs                   function      zip-filter         Returns a lazy sequence of locations to the right ...
+ rightmost?                   function      zip-filter         Returns true if there are no more nodes to the rig...
+ rint                         multimethod   generic.math-functions Return the rint of x..
+ rotations                    function      seq                Returns a lazy seq of all rotations of a seq.
+ rotations                    function      seq-utils          Returns a lazy seq of all rotations of a seq.
+ round                        multimethod   generic.math-functions Return the round of x..
+ round                        multimethod   math               (round n) rounds to the nearest integer. round alw...
+ rtrim                        function      str-utils2         Removes whitespace from the right side of string..
+ rtrim                        function      string             Removes whitespace from the right side of string. ...
+ run                          macro         repl-utils         Loads the specified namespace and invokes its "mai...
+ run*                         function      repl-utils         Loads the specified namespace and invokes its "mai...
+ run-all-tests                function      test-is            Runs all tests in all namespaces; prints results. ...
+ run-cont                     function      monads             Execute the computation c in the cont monad and re...
+ run-tests                    function      test-is            Runs all tests in the given namespaces; prints res...
+ run-work-plan                function      datalog            Given a work plan, a database, and some query bind...
+
+
+

S

+
+ *simple-dispatch*            multimethod   pprint             The pretty print dispatch function for simple data...
+ *stack-trace-depth*          var           test-is            The maximum depth of stack traces to print when an...
+ safe-get                     function      map-utils          Like get, but throws an exception if the key is no...
+ safe-get-in                  function      map-utils          Like get-in, but throws an exception if any key is...
+ sample                       function      probabilities.monte-carlo Return the distribution of samples of lengt...
+ sample-mean                  function      probabilities.monte-carlo Return the distribution of the mean over n ...
+ sample-mean-variance         function      probabilities.monte-carlo Return the distribution of the mean-and-var...
+ sample-reduce                function      probabilities.monte-carlo Returns the distribution of the reduction o...
+ sample-sum                   function      probabilities.monte-carlo Return the distribution of the sum over n s...
+ scc                          function      graph              Returns, as a sequence of sets, the strongly conne...
+ selections                   function      combinatorics      All the ways of taking n (possibly the same) eleme...
+ self-recursive-sets          function      graph              Returns, as a sequence of sets, the components of ...
+ send-request-entity          var           http.connection    Transmits a request entity body..
+ separate                     function      seq                Returns a vector: [ (filter f s), (filter (complem...
+ separate                     function      seq-utils          Returns a vector: [ (filter f s), (filter (complem...
+ seq                          multimethod   generic.collection Returns a seq on the object s..
+ seq-on                       multimethod   seq                Returns a seq on the object s. Works like the buil...
+ seq-on                       multimethod   seq-utils          Returns a seq on the object s. Works like the buil...
+ seqable?                     function      core               Returns true if (seq x) will succeed, false otherw...
+ sequence-m                   var           monads             Monad describing multi-valued computations, i.e. c...
+ sequence-t                   function      monads             Monad transformer that transforms a monad m into a...
+ server-error?                function      http.agent         Returns true if the HTTP response code was in the ...
+ set-m                        var           monads             Monad describing multi-valued computations, like s...
+ set-pprint-dispatch          function      pprint             Set the pretty print dispatch function to a functi...
+ set-repl-name                function      repl-ln            Sets the repl name format to the string name-fmt. ...
+ set-repl-prompt              function      repl-ln            Sets the repl prompt. Include the following codes ...
+ set-rollback-only            function      sql                Marks the outermost transaction such that it will ...
+ set-state                    function      monads             Return a state-monad function that replaces the cu...
+ set-system-properties        function      java-utils         Set some system properties. Nil clears a property..
+ set-system-properties        function      properties         Set some system properties. Nil clears a property..
+ set-test                     macro         test-is            Experimental. Sets :test metadata of the named var...
+ set-val                      function      monads             Return a state-monad function that assumes the sta...
+ sgn                          multimethod   generic.math-functions Return the sign of x (-1, 0, or 1)..
+ sh                           function      shell              Passes the given strings to Runtime.exec() to laun...
+ sh                           function      shell-out          Passes the given strings to Runtime.exec() to laun...
+ show                         function      repl-utils         With one arg prints all static and instance member...
+ shuffle                      function      seq                DEPRECATED. Prefer clojure.core version. Return a ...
+ shuffle                      function      seq-utils          DEPRECATED. Prefer clojure.core version. Return a ...
+ sin                          multimethod   generic.math-functions Return the sin of x..
+ skip-chars                   function      monadic-io-streams Skip n characters.
+ slurp                        function      mmap               Reads the file named by f and returns it as a stri...
+ slurp*                       function      duck-streams       Like clojure.core/slurp but opens f with reader..
+ slurp*                       function      io                 Like clojure.core/slurp but opens f with reader..
+ source                       macro         repl-utils         Prints the source code for the given symbol, if it...
+ source-cell?                 function      dataflow           Is this cell a source cell?.
+ spit                         function      duck-streams       Opposite of slurp.  Opens f with writer, writes co...
+ spit                         function      io                 Opposite of slurp.  Opens f with writer, writes co...
+ split                        function      str-utils2         Splits string on a regular expression.  Optional a...
+ split                        function      string             Splits string on a regular expression.  Optional a...
+ split-lines                  function      str-utils2         Splits s on \n or \r\n..
+ split-lines                  function      string             Splits s on \n or \r\n..
+ spy                          macro         logging            Evaluates expr and outputs the form and its result...
+ sqr                          multimethod   generic.math-functions Return the square of x..
+ sqrt                         multimethod   generic.math-functions Return the sqrt of x..
+ sqrt                         multimethod   math               Square root, but returns exact number if possible..
+ stack-trace-info             multimethod   condition          Returns header, stack-trace, and cause info from c...
+ start-handling-break         function      repl-utils         Register INT signal handler.  After calling this, ...
+ state-m                      var           monads             Monad describing stateful computations. The monadi...
+ state-m-until                function      monads             An optimized implementation of m-until for the sta...
+ state-t                      function      monads             Monad transformer that transforms a monad m into a...
+ status                       function      http.agent         Returns the HTTP response status code (e.g. 200, 4...
+ str-join                     function      str-utils          Returns a string of all elements in 'sequence', se...
+ stratification-list          function      graph              Similar to dependency-list (see doc), except two g...
+ stream                       function      http.agent         Returns an InputStream of the HTTP response body. ...
+ stream-drop                  function      stream-utils       Return a stream containing all but the first n ele...
+ stream-filter                multimethod   stream-utils       Return a new stream that contrains the elements of...
+ stream-flatten               function      stream-utils       Converts a stream of sequences into a stream of th...
+ stream-m                     var           stream-utils       Monad describing stream computations. The monadic ...
+ stream-map                   multimethod   stream-utils       Return a new stream by mapping the function f on t...
+ stream-next                  multimethod   stream-utils       Returns a vector [next-value new-state] where next...
+ stream-repl                  function      repl-ln            Repl entry point that provides convenient overridi...
+ stream-seq                   function      stream-utils       Return a lazy seq on the stream. Also accessible v...
+ stream-type                  var           stream-utils       The root type for the stream hierarchy. For each s...
+ string                       function      http.agent         Returns the HTTP response body as a string, using ...
+ subset?                      function      set                Is set1 a subset of set2?.
+ subsets                      function      combinatorics      All the subsets of items.
+ substring?                   function      string             True if s contains the substring..
+ success?                     function      http.agent         Returns true if the HTTP response code was in the ...
+ successful?                  function      test-is            Returns true if the given test summary indicates a...
+ summarize                    function      profile            Takes the raw data returned by with-profile-data a...
+ superset?                    function      set                Is set1 a superset of set2?.
+ swap-case                    function      str-utils2         Changes upper case characters to lower case and vi...
+ swap-case                    function      string             Changes upper case characters to lower case and vi...
+ symbol-macrolet              macro         macro-utils        Define local symbol macros that are used in the ex...
+
+
+

T

+
+ *trace-depth*                var           trace              Current stack depth of traced function calls..
+ tail                         function      str-utils2         Returns the last n characters of s..
+ tail                         function      string             Returns the last n characters of s..
+ take                         function      str-utils2         Take first n characters from s, up to the length o...
+ take                         function      string             Take first n characters from s, up to the length o...
+ tan                          multimethod   generic.math-functions Return the tan of x..
+ template?                    function      test-is            Returns true if form is a valid template expressio...
+ test-all-vars                function      test-is            Calls test-var on every var interned in the namesp...
+ test-ns                      function      test-is            If the namespace defines a function named test-ns-...
+ test-var                     function      test-is            If v has a function in its :test metadata, calls t...
+ testing                      macro         test-is            Adds a new string to the list of testing contexts....
+ testing-contexts-str         function      test-is            Returns a string representation of the current tes...
+ testing-vars-str             function      test-is            Returns a string representation of the current tes...
+ throw-arg                    function      except             Throws an IllegalArgumentException. All arguments ...
+ throw-if                     function      except             Throws an Exception or Error if test is true. args...
+ throw-if-not                 function      except             Throws an Exception or Error if test is false. arg...
+ throw-msg                    macro         error-kit          Returns a function that throws a Java Exception wi...
+ throwf                       function      except             Throws an Exception or Error with an optional mess...
+ times                        macro         mock               Creates or associates to an existing expectation h...
+ to-byte-array                multimethod   duck-streams       Converts argument into a Java byte array.  Argumen...
+ to-byte-array                function      io                 Converts argument into a Java byte array.  Argumen...
+ trace                        macro         logging            Logs a message at the trace level..
+ trace                        function      trace              Sends name (optional) and value to the tracer func...
+ trace-fn-call                function      trace              Traces a single call to a function f with args.  '...
+ trace-indent                 function      trace              Returns an indentation string based on *trace-dept...
+ tracer                       function      trace              This function is called by trace.  Prints to stand...
+ transaction                  macro         sql                Evaluates body as a transaction on the open databa...
+ transitive-closure           function      graph              Returns the transitive closure of a graph.  The ne...
+ trim                         function      str-utils2         Removes whitespace from both ends of string..
+ trim                         function      string             Removes whitespace from both ends of string..
+ try-expr                     macro         test-is            Used by the 'is' macro to catch unexpected excepti...
+
+
+

U

+
+ uniform                      function      probabilities.finite-distributions Return a distribution in which eac...
+ update-or-insert-values      function      sql                Updates values on selected rows in a table, or ins...
+ update-state                 function      monads             Return a state-monad function that replaces the cu...
+ update-val                   function      monads             Return a state-monad function that assumes the sta...
+ update-values                function      dataflow           Given a dataflow, and a map of name-value pairs, u...
+ update-values                function      sql                Updates values on selected rows in a table. where-...
+ upper-case                   function      str-utils2         Converts string to all upper-case..
+ upper-case                   function      string             Converts string to all upper-case..
+ use-fixtures                 multimethod   test-is            Wrap test runs in a fixture function to perform se...
+ use-method                   function      pprint             Installs a function as a new method of multimethod...
+
+
+

V

+
+ validate-counts              function      mock               given the sequence of all mock data for the expect...
+ vars                         macro         ns-utils           Returns a sorted seq of symbols naming public vars...
+
+
+

W

+
+ wall-hack-field              function      java-utils         Access to private or protected field..
+ wall-hack-method             function      java-utils         Calls a private or protected method. params is a v...
+ warn                         macro         logging            Logs a message at the warn level..
+ with-command-line            macro         command-line       Bind locals to command-line args..
+ with-connection              macro         jmx                Execute body with JMX connection specified by opts...
+ with-connection              macro         sql                Evaluates body in the context of a new connection ...
+ with-direct-linking          macro         macros             EXPERIMENTAL! Compiles the functions in body with ...
+ with-handler                 macro         error-kit          This is error-kit's dynamic scope form.  The body ...
+ with-in-reader               macro         duck-streams       Opens a PushbackReader on f, binds it to *in*, and...
+ with-in-reader               macro         io                 Opens a PushbackReader on f, binds it to *in*, and...
+ with-io-streams              function      monadic-io-streams Open one or more streams as specified by io-spec, ...
+ with-logs                    macro         logging            Evaluates exprs in a context in which *out* and *e...
+ with-monad                   macro         monads             Evaluates an expression after replacing the keywor...
+ with-ns                      macro         with-ns            Evaluates body in another namespace.  ns is either...
+ with-out-append-writer       macro         duck-streams       Like with-out-writer but appends to file..
+ with-out-append-writer       macro         io                 Like with-out-writer but appends to file..
+ with-out-writer              macro         duck-streams       Opens a writer on f, binds it to *out*, and evalut...
+ with-out-writer              macro         io                 Opens a writer on f, binds it to *out*, and evalut...
+ with-pprint-dispatch         macro         pprint             Execute body with the pretty print dispatch functi...
+ with-profile-data            macro         profile            Executes body with *profile-data* bound to an atom...
+ with-query-results           macro         sql                Executes a query, then evaluates body with results...
+ with-reader                  function      monadic-io-streams Create a reader from reader-spec, run the monadic ...
+ with-state-field             function      monads             Returns a state-monad function that expects a map ...
+ with-symbol-macros           macro         macro-utils        Fully expand exprs, including symbol macros..
+ with-system-properties       macro         java-utils         setting => property-name value  Sets the system pr...
+ with-system-properties       macro         properties         setting => property-name value  Sets the system pr...
+ with-temp-ns                 macro         with-ns            Evaluates body in an anonymous namespace, which is...
+ with-test                    macro         test-is            Takes any definition form (that returns a Var) as ...
+ with-test-out                macro         test-is            Runs body with *out* bound to the value of *test-o...
+ with-writer                  function      monadic-io-streams Create a writer from writer-spec, run the monadic ...
+ write                        function      monadic-io-streams Write text (a string).
+ write                        function      pprint             Write an object subject to the current bindings of...
+ write-json                   function      json               Print object to PrintWriter out as JSON.
+ write-lines                  function      duck-streams       Writes lines (a seq) to f, separated by newlines. ...
+ write-lines                  function      io                 Writes lines (a seq) to f, separated by newlines. ...
+ write-out                    function      pprint             Write an object to *out* subject to the current bi...
+ write-properties             function      java-utils         Write properties to file-able..
+ write-properties             function      properties         Write properties to file-able..
+ writer                       multimethod   duck-streams       Attempts to coerce its argument into an open java....
+ writer                       function      io                 Attempts to coerce its argument into an open java....
+ writer-m                     function      monads             Monad describing computations that accumulate data...
+
+
+

X

+
+
+
+

Y

+
+
+
+

Z

+
+ zero?                        multimethod   generic.comparison Return true of x is zero..
+ zipf                         function      probabilities.finite-distributions Returns the Zipf distribution in w...
+
+
+

Other

+
+ *                            multimethod   generic.arithmetic Return the product of all arguments. The minimal i...
+ +                            multimethod   generic.arithmetic Return the sum of all arguments. The minimal imple...
+ -                            multimethod   generic.arithmetic Return the difference of the first argument and th...
+ -?>                          macro         core               Same as clojure.core/-> but returns nil as soon as...
+ -?>>                         macro         core               Same as clojure.core/->> but returns nil as soon a...
+ .?.                          macro         core               Same as clojure.core/.. but returns nil as soon as...
+ /                            multimethod   generic.arithmetic Return the quotient of the first argument and the ...
+ <                            multimethod   generic.comparison Return true if each argument is smaller than the f...
+ <<                           macro         strint             Takes a single string argument and emits a str inv...
+ <=                           multimethod   generic.comparison Return true if each arguments is smaller than or e...
+ =                            multimethod   generic.comparison Return true if all arguments are equal. The minima...
+ >                            multimethod   generic.comparison Return true if each argument is larger than the fo...
+ >=                           multimethod   generic.comparison Return true if each argument is larger than or equ...
+
+
+ +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/apply-macro-api.html b/branch-master/apply-macro-api.html new file mode 100644 index 00000000..f3cebeac --- /dev/null +++ b/branch-master/apply-macro-api.html @@ -0,0 +1,119 @@ + + + apply-macro - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for apply-macro + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.apply-macro))
+
+

Overview

+

+
+Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

apply-macro

+ macro
+
Usage: (apply-macro macro & args)
+
+
This is evil.  Don't ever use it.  It makes a macro behave like a
+function.  Seriously, how messed up is that?
+
+Evaluates all args, then uses them as arguments to the macro as with
+apply.
+
+(def things [true true false])
+(apply-macro and things)
+;; Expands to:  (and true true false)
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/base64-api.html b/branch-master/base64-api.html new file mode 100644 index 00000000..26202d68 --- /dev/null +++ b/branch-master/base64-api.html @@ -0,0 +1,132 @@ + + + base64 - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for base64 + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.base64))
+
+

Overview

+
Base-64 encoding and (maybe later) decoding.  
+
+This is mainly here as an example.  It is much slower than the
+Apache Commons Codec implementation or sun.misc.BASE64Encoder.
+ + +
+

Public Variables and Functions

+
+
+
+

encode

+ function
+
Usage: (encode input output alphabet line-length)
+
+
Encodes bytes of input, writing Base 64 text on output.  alphabet
+is a 65-character String containing the 64 characters to use in the
+encoding; the 65th character is the pad character.  line-length is
+the maximum number of characters per line, nil for no line breaks.
+ + + Source +
+
+
+

encode-str

+ function
+
Usage: (encode-str s)
+       (encode-str s encoding line-length)
+
+
Encodes String in base 64; returns a String.  If not specified,
+encoding is UTF-8 and line-length is nil.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/classpath-api.html b/branch-master/classpath-api.html new file mode 100644 index 00000000..ff2f1d5a --- /dev/null +++ b/branch-master/classpath-api.html @@ -0,0 +1,137 @@ + + + classpath - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for classpath + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.classpath))
+
+

Overview

+
Utilities for dealing with the JVM's classpath
+ + +
+

Public Variables and Functions

+
+
+
+

classpath

+ function
+
Usage: (classpath)
+
+
Returns a sequence of File objects of the elements on CLASSPATH.
+ + + Source +
+
+
+

classpath-directories

+ function
+
Usage: (classpath-directories)
+
+
Returns a sequence of File objects for the directories on classpath.
+ + + Source +
+
+
+

classpath-jarfiles

+ function
+
Usage: (classpath-jarfiles)
+
+
Returns a sequence of JarFile objects for the JAR files on classpath.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/combinatorics-api.html b/branch-master/combinatorics-api.html new file mode 100644 index 00000000..c3300d21 --- /dev/null +++ b/branch-master/combinatorics-api.html @@ -0,0 +1,178 @@ + + + combinatorics - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for combinatorics + - clojure-contrib next (in development) +

+by Mark Engelberg
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.combinatorics))
+
+

Overview

+
Efficient, functional algorithms for generating lazy
+sequences for common combinatorial functions. (See the source code 
+for a longer description.)
+ + +
+

Public Variables and Functions

+
+
+
+

cartesian-product

+ function
+
Usage: (cartesian-product & seqs)
+
+
All the ways to take one item from each sequence
+ + + Source +
+
+
+

combinations

+ function
+
Usage: (combinations items n)
+
+
All the unique ways of taking n different elements from items
+ + + Source +
+
+
+

lex-permutations

+ function
+
Usage: (lex-permutations c)
+
+
Fast lexicographic permutation generator for a sequence of numbers
+ + + Source +
+
+
+

permutations

+ function
+
Usage: (permutations items)
+
+
All the permutations of items, lexicographic by index
+ + + Source +
+
+
+

selections

+ function
+
Usage: (selections items n)
+
+
All the ways of taking n (possibly the same) elements from the sequence of items
+ + + Source +
+
+
+

subsets

+ function
+
Usage: (subsets items)
+
+
All the subsets of items
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/command-line-api.html b/branch-master/command-line-api.html new file mode 100644 index 00000000..21e8a1e0 --- /dev/null +++ b/branch-master/command-line-api.html @@ -0,0 +1,111 @@ + + + command-line - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for command-line + - clojure-contrib next (in development) +

+by Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.command-line))
+
+

Overview

+
Process command-line arguments according to a given cmdspec
+ + +
+

Public Variables and Functions

+
+
+
+

with-command-line

+ macro
+
Usage: (with-command-line args desc cmdspec & body)
+
+
Bind locals to command-line args.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/complex-numbers-api.html b/branch-master/complex-numbers-api.html new file mode 100644 index 00000000..0a5347b9 --- /dev/null +++ b/branch-master/complex-numbers-api.html @@ -0,0 +1,100 @@ + + + complex-numbers - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for complex-numbers + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.complex-numbers))
+
+

Overview

+
Complex numbers
+NOTE: This library is in evolution. Most math functions are
+      not implemented yet.
+ + +
+

Public Variables and Functions

+ + + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/cond-api.html b/branch-master/cond-api.html new file mode 100644 index 00000000..e5eec1f5 --- /dev/null +++ b/branch-master/cond-api.html @@ -0,0 +1,118 @@ + + + cond - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for cond + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.cond))
+
+

Overview

+
Extensions to the basic cond function.
+ + +
+

Public Variables and Functions

+
+
+
+

cond-let

+ macro
+
Usage: (cond-let bindings & clauses)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/condition-api.html b/branch-master/condition-api.html new file mode 100644 index 00000000..97e095ea --- /dev/null +++ b/branch-master/condition-api.html @@ -0,0 +1,257 @@ + + + condition - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for condition + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.condition))
+
+

Overview

+
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
+ + +
+

Public Variables and Functions

+
+
+
+

*full-stack-traces*

+ var
+

+  
Bind to true to include clojure.{core,lang,main} frames in stack
+traces
+ + + Source +
+
+
+

handler-case

+ macro
+
Usage: (handler-case dispatch-fn & body)
+
+
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.
+ + + Source +
+
+
+

print-stack-trace

+ function
+
Usage: (print-stack-trace x)
+
+
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
+ + + Source +
+
+
+

raise

+ macro
+
Usage: (raise)
+       (raise m)
+       (raise key val & keyvals)
+
+
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.
+ + + Source +
+
+
+

stack-trace-info

+ multimethod
+
No usage documentation available
+
Returns header, stack-trace, and cause info from conditions and
+Throwables
+ + + Source +
+

condition.Condition

+

+
+
+
+
+
+

-init

+ function
+
Usage: (-init condition)
+
+
Constructs a Condition object with condition (a map) as its
+metadata. Also initializes the superclass with the values at :message
+and :cause, if any, so they are also available via .getMessage and
+.getCause.
+ + + Source +
+
+

-meta

+ function
+
Usage: (-meta this)
+
+
Returns this object's metadata, the condition
+ + + Source +
+
+

-post-init

+ function
+
Usage: (-post-init this condition)
+
+
Adds :stack-trace to the condition. Drops the bottom 3 frames because
+they are always the same: implementation details of Condition and raise.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/core-api.html b/branch-master/core-api.html new file mode 100644 index 00000000..a6d88448 --- /dev/null +++ b/branch-master/core-api.html @@ -0,0 +1,194 @@ + + + core - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for core + - clojure-contrib next (in development) +

+by Laurent Petit (and others)
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.core))
+
+

Overview

+
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)
+ + +
+

Public Variables and Functions

+
+
+
+

-?>

+ macro
+
Usage: (-?> x form)
+       (-?> x form & forms)
+
+
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
+
+ + + Source +
+
+
+

-?>>

+ macro
+
Usage: (-?>> x form)
+       (-?>> x form & forms)
+
+
Same as clojure.core/->> but returns nil as soon as the threaded value is nil itself (thus short-circuiting any pending computation).
+Examples :
+(-?>> (range 5) (map inc)) returns (1 2 3 4 5)
+(-?>> [] seq (map inc)) returns nil
+
+ + + Source +
+
+
+

.?.

+ macro
+
Usage: (.?. x form)
+       (.?. x form & forms)
+
+
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
+
+ + + Source +
+
+
+

dissoc-in

+ function
+
Usage: (dissoc-in m [k & ks :as keys])
+
+
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.
+ + + Source +
+
+
+

new-by-name

+ function
+
Usage: (new-by-name class-name & args)
+
+
Constructs a Java object whose class is specified by a String.
+ + + Source +
+
+
+

seqable?

+ function
+
Usage: (seqable? x)
+
+
Returns true if (seq x) will succeed, false otherwise.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/dataflow-api.html b/branch-master/dataflow-api.html new file mode 100644 index 00000000..8a4bec5f --- /dev/null +++ b/branch-master/dataflow-api.html @@ -0,0 +1,388 @@ + + + dataflow - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for dataflow + - clojure-contrib next (in development) +

+by Jeffrey Straszheim
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.dataflow))
+
+

Overview

+
A library to support a dataflow model of state
+ + +
+

Public Variables and Functions

+
+
+
+

add-cell-watcher

+ function
+
Usage: (add-cell-watcher cell key fun)
+
+
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
+ + + Source +
+
+
+

add-cells

+ function
+
Usage: (add-cells df cells)
+
+
Given a collection of cells, add them to the dataflow.
+ + + Source +
+
+
+

build-dataflow

+ function
+
Usage: (build-dataflow cs)
+
+
Given a collection of cells, build and return a dataflow object
+ + + Source +
+
+
+

build-source-cell

+ function
+
Usage: (build-source-cell name init)
+
+
Builds a source cell
+ + + Source +
+
+
+

build-standard-cell

+ function
+
Usage: (build-standard-cell name deps fun expr)
+
+
Builds a standard cell
+ + + Source +
+
+
+

build-validator-cell

+ function
+
Usage: (build-validator-cell deps fun expr)
+
+
Builds a validator cell
+ + + Source +
+
+
+

cell

+ macro
+
Usage: (cell type & data)
+
+
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
+ + + Source +
+
+
+

display-cell

+ multimethod
+
No usage documentation available
+
A 'readable' form of the cell
+ + + Source +
+
+
+

eval-cell

+ multimethod
+
No usage documentation available
+
Evaluate a dataflow cell.  Return [changed, old val]
+ + + Source +
+
+
+

get-cell

+ function
+
Usage: (get-cell df name)
+
+
Get the single cell named by name
+ + + Source +
+
+
+

get-cells

+ function
+
Usage: (get-cells df name)
+
+
Get all the cells named by name
+ + + Source +
+
+
+

get-old-value

+ function
+
Usage: (get-old-value df env name)
+
+
Looks up an old value
+ + + Source +
+
+
+

get-source-cells

+ function
+
Usage: (get-source-cells df)
+
+
Returns a collection of source cells from the dataflow
+ + + Source +
+
+
+

get-value

+ function
+
Usage: (get-value df name)
+
+
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.
+ + + Source +
+
+
+

get-value-from-cell

+ function
+
Usage: (get-value-from-cell cell)
+
+
Given a cell, get its value
+ + + Source +
+
+
+

get-values

+ function
+
Usage: (get-values df name)
+
+
Gets a collection of values from the df by name
+ + + Source +
+
+
+

print-dataflow

+ function
+
Usage: (print-dataflow df)
+
+
Prints a dataflow, one cell per line
+ + + Source +
+
+
+

remove-cells

+ function
+
Usage: (remove-cells df cells)
+
+
Given a collection of cells, remove them from the dataflow.
+ + + Source +
+
+
+

source-cell?

+ function
+
Usage: (source-cell? cell)
+
+
Is this cell a source cell?
+ + + Source +
+
+
+

update-values

+ function
+
Usage: (update-values df data)
+
+
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
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/datalog-api.html b/branch-master/datalog-api.html new file mode 100644 index 00000000..b75a08ca --- /dev/null +++ b/branch-master/datalog-api.html @@ -0,0 +1,1052 @@ + + + datalog - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for datalog + - clojure-contrib next (in development) +

+by Jeffrey Straszheim
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.datalog))
+
+

Overview

+
A Clojure implementation of Datalog
+ + +
+Related documentation: + +
An Overview of Datalog +

+

Public Variables and Functions

+
+
+
+

build-work-plan

+ function
+
Usage: (build-work-plan rules query)
+
+
Given a list of rules and a query, build a work plan that can be
+used to execute the query.
+ + + Source +
+
+
+

run-work-plan

+ function
+
Usage: (run-work-plan work-plan database query-bindings)
+
+
Given a work plan, a database, and some query bindings, run the
+work plan and return the results.
+ + + Source +
+

datalog.database

+

+
+
+
+
+
+

add-index

+ function
+
Usage: (add-index db name key)
+
+
Adds an index to an empty relation named name
+ + + Source +
+
+

add-relation

+ function
+
Usage: (add-relation db name keys)
+
+
Adds a relation to the database
+ + + Source +
+
+

add-tuple

+ function
+
Usage: (add-tuple db rel-name tuple)
+       (add-tuple rel tuple)
+
+
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.
+ + + Source +
+
+

add-tuples

+ function
+
Usage: (add-tuples db & tupls)
+
+
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])
+ + + Source +
+
+

any-match?

+ function
+
Usage: (any-match? db rn pt)
+
+
Finds if there are any matching records for the partial tuple
+ + + Source +
+
+

database-counts

+ function
+
Usage: (database-counts db)
+
+
Returns a map with the count of elements in each relation.
+ + + Source +
+
+

database-merge

+ function
+
Usage: (database-merge dbs)
+
+
Merges databases together
+ + + Source +
+
+

database-merge-parallel

+ function
+
Usage: (database-merge-parallel dbs)
+
+
Merges databases together in parallel
+ + + Source +
+
+

datalog-relation

+ function
+
Usage: (datalog-relation schema data indexes)
+
+
Creates a relation
+ + + Source +
+
+

ensure-relation

+ function
+
Usage: (ensure-relation db name keys indexes)
+
+
If the database lacks the named relation, add it
+ + + Source +
+
+

get-relation

+ function
+
Usage: (get-relation db rel-name)
+
+
Get a relation object by name
+ + + Source +
+
+

make-database

+ macro
+
Usage: (make-database & commands)
+
+
Makes a database, like this
+(make-database
+  (relation :fred [:mary :sue])
+  (index :fred :mary)
+  (relation :sally [:jen :becky])
+  (index :sally :jen)
+  (index :sally :becky))
+ + + Source +
+
+

merge-relations

+ function
+
Usage: (merge-relations r1 r2)
+
+
Merges two relations
+ + + Source +
+
+

remove-tuple

+ function
+
Usage: (remove-tuple db rel-name tuple)
+       (remove-tuple rel tuple)
+
+
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.
+ + + Source +
+
+

replace-relation

+ function
+
Usage: (replace-relation db rel-name rel)
+
+
Add or replace a fully constructed relation object to the database.
+ + + Source +
+
+

select

+ function
+
Usage: (select db rn pt)
+
+
finds all matching tuples to the partial tuple (pt) in the relation named (rn)
+ + + Source +
+

datalog.literals

+

+
+
+
+
+
+

adorned-literal

+ multimethod
+
No usage documentation available
+
When passed a set of bound columns, returns the adorned literal
+ + + Source +
+
+

build-atom

+ function
+
Usage: (build-atom f type)
+
+
Returns an unevaluated expression (to be used in a macro) of an
+atom.
+ + + Source +
+
+

build-literal

+ multimethod
+
No usage documentation available
+
(Returns an unevaluated expression (to be used in macros) of a
+literal.
+ + + Source +
+
+

build-seed-bindings

+ function
+
Usage: (build-seed-bindings s)
+
+
Given a seed literal, already adorned and in magic form, convert
+its bound constants to new variables.
+ + + Source +
+
+

delta-literal

+ function
+
Usage: (delta-literal l)
+
+
Given a literal l, return a delta version
+ + + Source +
+
+

display-literal

+ multimethod
+
No usage documentation available
+
Converts a struct representing a literal to a normal list
+ + + Source +
+
+

get-adorned-bindings

+ function
+
Usage: (get-adorned-bindings pred)
+
+
Get the bindings from this adorned literal.
+ + + Source +
+
+

get-base-predicate

+ function
+
Usage: (get-base-predicate pred)
+
+
Get the base predicate from this predicate.
+ + + Source +
+
+

get-cs-from-vs

+ multimethod
+
No usage documentation available
+
From a set of vars, get the columns
+ + + Source +
+
+

get-self-bound-cs

+ multimethod
+
No usage documentation available
+
Get the columns that are bound withing the literal.
+ + + Source +
+
+

get-vs-from-cs

+ multimethod
+
No usage documentation available
+
From a set of columns, return the vars
+ + + Source +
+
+

join-literal

+ multimethod
+
No usage documentation available
+
Given a database (db), a literal (lit) and a seq of bindings (bs),
+return a new seq of bindings by joining this literal.
+ + + Source +
+
+

literal-appropriate?

+ multimethod
+
No usage documentation available
+
When passed a set of bound vars, determines if this literal can be
+used during this point of a SIP computation.
+ + + Source +
+
+

literal-columns

+ multimethod
+
No usage documentation available
+
Return the column names this applies to
+ + + Source +
+
+

literal-magic?

+ function
+
Usage: (literal-magic? lit)
+
+
Is this literal magic?
+ + + Source +
+
+

literal-predicate

+ multimethod
+
No usage documentation available
+
Return the predicate/relation this conditional operates over
+ + + Source +
+
+

literal-vars

+ multimethod
+
No usage documentation available
+
Returns the logic vars used by this literal
+ + + Source +
+
+

magic-literal

+ function
+
Usage: (magic-literal l)
+
+
Create a magic version of this adorned predicate.
+ + + Source +
+
+

negated-literal

+ function
+
Usage: (negated-literal l)
+
+
Given a literal l, return a negated version
+ + + Source +
+
+

negated?

+ function
+
Usage: (negated? l)
+
+
Is this literal a negated literal?
+ + + Source +
+
+

negative-vars

+ multimethod
+
No usage documentation available
+
Returns the logic vars used in a negative position
+ + + Source +
+
+

positive-vars

+ multimethod
+
No usage documentation available
+
Returns the logic vars used in a positive position
+ + + Source +
+
+

positive?

+ function
+
Usage: (positive? l)
+
+
Is this a positive literal?
+ + + Source +
+
+

project-literal

+ function
+
Usage: (project-literal db lit bs)
+       (project-literal db lit bs var?)
+
+
Project a stream of bindings onto a literal/relation. Returns a new
+db.
+ + + Source +
+

datalog.magic

+

+
+
+
+
+
+

adorn-query

+ function
+
Usage: (adorn-query q)
+
+
Adorn a query
+ + + Source +
+
+

adorn-rules-set

+ function
+
Usage: (adorn-rules-set rs q)
+
+
Adorns the given rules-set for the given query.  (rs) is a
+rules-set, (q) is an adorned query.
+ + + Source +
+
+

build-partial-tuple

+ function
+
Usage: (build-partial-tuple q bindings)
+
+
Given a query and a set of bindings, build a partial tuple needed
+to extract the relation from the database.
+ + + Source +
+
+

magic-transform

+ function
+
Usage: (magic-transform rs)
+       (magic-transform rs i-preds)
+
+
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.
+ + + Source +
+
+

seed-predicate-for-insertion

+ function
+
Usage: (seed-predicate-for-insertion q)
+
+
Given a query, return the predicate to use for database insertion.
+ + + Source +
+
+

seed-relation

+ function
+
Usage: (seed-relation q)
+
+
Given a magic form of a query, give back the literal form of its seed
+relation
+ + + Source +
+
+

seed-rule

+ function
+
Usage: (seed-rule q)
+
+
Given an adorned query, give back its seed rule
+ + + Source +
+

datalog.rules

+

+
+
+
+
+
+

<-

+ macro
+
Usage: (<- hd & body)
+
+
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))
+ + + Source +
+
+

?-

+ macro
+
Usage: (?- & q)
+
+
Define a datalog query
+ + + Source +
+
+

all-predicates

+ function
+
Usage: (all-predicates rs)
+
+
Given a rules-set, return all defined predicates
+ + + Source +
+
+

apply-rule

+ function
+
Usage: (apply-rule db rule)
+       (apply-rule db-1 db-2 rule)
+
+
Apply the rule against db-1, adding the results to the appropriate
+relation in db-2.  The relation will be created if needed.
+ + + Source +
+
+

compute-sip

+ function
+
Usage: (compute-sip bindings i-preds rule)
+
+
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.
+ + + Source +
+
+

display-query

+ function
+
Usage: (display-query query)
+
+
Return a query in a readable format.
+ + + Source +
+
+

display-rule

+ function
+
Usage: (display-rule rule)
+
+
Return the rule in a readable format.
+ + + Source +
+
+

is-safe?

+ function
+
Usage: (is-safe? rule)
+
+
Is the rule safe according to the datalog protocol?
+ + + Source +
+
+

make-rules-set

+ function
+
Usage: (make-rules-set rs)
+
+
Given an existing set of rules, make it a 'rules-set' for
+printing.
+ + + Source +
+
+

non-base-rules

+ function
+
Usage: (non-base-rules rs)
+
+
Return a collection of rules that depend, somehow, on other rules
+ + + Source +
+
+

predicate-map

+ function
+
Usage: (predicate-map rs)
+
+
Given a rules-set, return a map of rules keyed by their predicates.
+Each value will be a set of rules.
+ + + Source +
+
+

return-rule-data

+ function
+
Usage: (return-rule-data rule)
+
+
Returns an untypted rule that will be fully printed
+ + + Source +
+
+

rules-set

+ function
+
Usage: (rules-set & rules)
+
+
Given a collection of rules return a rules set
+ + + Source +
+

datalog.softstrat

+

+
+
+
+
+
+

build-soft-strat-work-plan

+ function
+
Usage: (build-soft-strat-work-plan rs q)
+
+
Return a work plan for the given rules-set and query
+ + + Source +
+
+

get-all-relations

+ function
+
Usage: (get-all-relations ws)
+
+
Return a set of all relation names defined in this workplan
+ + + Source +
+

datalog.util

+

+
+
+
+
+
+

is-query-var?

+ function
+
Usage: (is-query-var? sym)
+
+
Is this a query variable: e.g. a symbol prefixed with ??
+ + + Source +
+
+

is-var?

+ function
+
Usage: (is-var? sym)
+
+
Is this a logic variable: e.g. a symbol prefixed with a ?
+ + + Source +
+
+

keys-to-vals

+ function
+
Usage: (keys-to-vals m ks)
+
+
Given a map and a collection of keys, return the collection of vals
+ + + Source +
+
+

map-values

+ function
+
Usage: (map-values f hash)
+
+
Like map, but works over the values of a hash map
+ + + Source +
+
+

preduce

+ function
+
Usage: (preduce f data)
+
+
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.
+ + + Source +
+
+

reverse-map

+ function
+
Usage: (reverse-map m)
+
+
Reverse the keys/values of a map
+ + + Source +
+
+

trace-datalog

+ macro
+
Usage: (trace-datalog & body)
+
+
If *test-datalog* is set to true, run the enclosed commands
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/def-api.html b/branch-master/def-api.html new file mode 100644 index 00000000..e0f66051 --- /dev/null +++ b/branch-master/def-api.html @@ -0,0 +1,276 @@ + + + def - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for def + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.def))
+
+

Overview

+

+
+
+
+

Public Variables and Functions

+
+
+
+

defalias

+ macro
+
Usage: (defalias name orig)
+       (defalias name orig doc)
+
+
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.
+ + + Source +
+
+
+

defhinted

+ macro
+
Usage: (defhinted sym init)
+
+
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
+ + + Source +
+
+
+

defmacro-

+ macro
+
Usage: (defmacro- name & decls)
+
+
Same as defmacro but yields a private definition
+ + + Source +
+
+
+

defn-memo

+ macro
+
Usage: (defn-memo fn-name & defn-stuff)
+
+
Just like defn, but memoizes the function using clojure.core/memoize
+ + + Source +
+
+
+

defnk

+ macro
+
Usage: (defnk fn-name & fn-tail)
+
+
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.
+ + + Source +
+
+
+

defonce-

+ macro
+
Usage: (defonce- name expr)
+       (defonce- name expr doc)
+
+
Same as defonce but yields a private definition
+ + + Source +
+
+
+

defstruct-

+ macro
+
Usage: (defstruct- name & decls)
+
+
Same as defstruct but yields a private definition
+ + + Source +
+
+
+

defunbound

+ macro
+
Usage: (defunbound name)
+       (defunbound name doc)
+
+
Defines an unbound var with optional doc string
+ + + Source +
+
+
+

defunbound-

+ macro
+
Usage: (defunbound- name & decls)
+
+
Same as defunbound but yields a private definition
+ + + Source +
+
+
+

defvar

+ macro
+
Usage: (defvar name)
+       (defvar name init)
+       (defvar name init doc)
+
+
Defines a var with an optional intializer and doc string
+ + + Source +
+
+
+

defvar-

+ macro
+
Usage: (defvar- name & decls)
+
+
Same as defvar but yields a private definition
+ + + Source +
+
+
+

name-with-attributes

+ function
+
Usage: (name-with-attributes name macro-args)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/doc/datalog.html b/branch-master/doc/datalog.html new file mode 100644 index 00000000..0e63dcde --- /dev/null +++ b/branch-master/doc/datalog.html @@ -0,0 +1,225 @@ + + + An Overview of Datalog + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

An Overview of Datalog

+ +

By Jeffrey Straszheim

+ +

What Datalog is, and what it can do for you.

+ +

Work in Progress

+ +

Introduction

+ +

Datalog is a logical query language. It exists somewhere between relational algebra (the formal theory behind SQL) and Prolog, but is closer in motivation to the former than the later. It was invented to apply some of the principles of logic programming to database theory. Its primary addition to the semantics of databases is recursive queries. Examples will be provided below.

+ +

The implementation of Datalog that is provided (in this library) departs a bit from the original model insofar as it supports in memory data structures only. It is intended to give developers tools to use relational modeling for their data. A good overview of why you would want to do this is Ben Mosely's Functional Relational Programming material, found here: http://web.mac.com/ben_moseley/frp/frp.html.

+ +

Details

+ +

The Database

+ +

Clojure Datalog supports an in memory relational database format, implemented in clojure.contrib.datalog.database (here). It supports relations (tables) with named columns and simple hash based indexes. At the present time it does not support any integrity constraints (perhaps later).

+ +

Tables are built with make-database, like this:

+ +
(make-database
+      (relation :employee [:id :name :position])
+      (index :employee :name)
+
+      (relation :boss [:employee-id :boss-id])
+      (index :boss :employee-id)
+
+      (relation :can-do-job [:position :job])
+      (index :can-do-job :position)
+
+      (relation :job-replacement [:job :can-be-done-by])
+
+      (relation :job-exceptions [:id :job]))
+
+ +

The schema can be modified by add-relation and add-index. Under the hood, it is standard Clojure map from relation name to relation, and can be directly modified if needed.

+ +

Data is added like this:

+ +
(add-tuples db-base
+           [:employee :id 1  :name "Bob"    :position :boss]
+           [:employee :id 2  :name "Mary"   :position :chief-accountant]
+           [:employee :id 3  :name "John"   :position :accountant]
+           [:employee :id 4  :name "Sameer" :position :chief-programmer]
+           [:employee :id 5  :name "Lilian" :position :programmer]
+           [:employee :id 6  :name "Li"     :position :technician]
+           [:employee :id 7  :name "Fred"   :position :sales]
+           [:employee :id 8  :name "Brenda" :position :sales]
+           [:employee :id 9  :name "Miki"   :position :project-management]
+           [:employee :id 10 :name "Albert" :position :technician]
+
+           [:boss :employee-id 2  :boss-id 1]
+           [:boss :employee-id 3  :boss-id 2]
+           [:boss :employee-id 4  :boss-id 1]
+           [:boss :employee-id 5  :boss-id 4]
+           [:boss :employee-id 6  :boss-id 4]
+           [:boss :employee-id 7  :boss-id 1]
+           [:boss :employee-id 8  :boss-id 7]
+           [:boss :employee-id 9  :boss-id 1]
+           [:boss :employee-id 10 :boss-id 6]
+
+           [:can-do-job :position :boss               :job :management]
+           [:can-do-job :position :accountant         :job :accounting]
+           [:can-do-job :position :chief-accountant   :job :accounting]
+           [:can-do-job :position :programmer         :job :programming]
+           [:can-do-job :position :chief-programmer   :job :programming]           
+           [:can-do-job :position :technician         :job :server-support]
+           [:can-do-job :position :sales              :job :sales]
+           [:can-do-job :position :project-management :job :project-management]
+
+           [:job-replacement :job :pc-support :can-be-done-by :server-support]
+           [:job-replacement :job :pc-support :can-be-done-by :programming]
+           [:job-replacement :job :payroll    :can-be-done-by :accounting]
+
+           [:job-exceptions :id 4 :job :pc-support])
+
+ +

The meaning is, I believe, obvious.

+ +

Functions that add/remove individual tuples are also provided. Use the source.

+ +

Rules

+ +

In addition to the database itself, Datalog lets you define a series of inference rules to apply to your data. Rules look like this:

+ +
(<- (:works-for :employee ?x :boss ?y) (:boss :employee-id ?e-id :boss-id ?b-id)
+                                       (:employee :id ?e-id :name ?x)
+                                       (:employee :id ?b-id :name ?y))
+
+ +

The <- operator represents implication. The first form is the head of the rule, the remainder the body. The meaning is that the head is true if each member of the body is true. We can read this above rule as:

+ +
    +
  • An employee (?x) works for a boss (?y) if: in the :boss relation there is an employee id (?e-id) matched to a boss id (?b-id) and in the :employee relation that (?e-id) matches the name (?x) and also in the :employee relation the id (?b-id) matches the name (?y).
  • +
+ +

Notice two things: Logic variables are prefixed by a '?', and the meaning of those variables in a rule can join together entities.

+ +

That same rule might be expressed in SQL as:

+ +
select e.name, b.name
+   from employee as e, employee as b, boss
+   where e.id = boss.employee-id and b.id = boss.boss-id
+
+ +

However, unlike SQL, Datalog rules can be recursive. Like this:

+ +
(<- (:works-for :employee ?x :boss ?y) (:works-for :employee ?x :boss ?z)
+                                       (:works-for :employee ?z :boss ?y))
+
+ +

If you combine these two rules, this builds a transitive closure of the works-for relation. It will return not only ?x's direct boss, but the boss of his boss, and so on. This cannot be done in most forms of SQL.

+ +

Negation and Conditionals

+ +

Todo

+ +

Queries

+ +

A query is how you request information from a set of rules and a database. Queries look like this:

+ +
(?- :works-for :employee ??name :boss ?y)
+
+ +

Notice the double '?'!

+ +

This asks for the name and boss columns from the works-for relation, which was defined by the two rules above. The double ?? allow you to parameterize your query.

+ +

Work Plans

+ +

A set of work rules and a query can form a work plan. It is done like this:

+ +
(build-work-plan rules (?- :works-for :employee '??name :boss ?x))
+
+ +

This takes a set of rules and a query, and performs some basic filtering an optimization. it is a fairly expensive operation, so try to build the plans you need once in your program, or perhaps cache them somehow.

+ +

In SQL, a work plan is similar to a prepared statement.

+ +

Running your Work Plan

+ +

You run a work plan like this:

+ +
(run-work-plan wp db {'??name "Albert"})
+
+ +

Where wp is the result of (build-work-plan ...) and db is a database. The last argument is a map of bindings. It provides the specific values for any ??X forms in your query. Given the rules and query defined above, it should return a sequence of tuples of all the people that "Albert" works for.

+ +

Examples

+ +

A completed example is provided at http://github.com/richhickey/clojure-contrib/blob/master/src/clojure/contrib/datalog/example.clj.

+
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/doc/pprint/CommonLispFormat.html b/branch-master/doc/pprint/CommonLispFormat.html new file mode 100644 index 00000000..e8071c85 --- /dev/null +++ b/branch-master/doc/pprint/CommonLispFormat.html @@ -0,0 +1,306 @@ + + + A Common Lisp-compatible Format Function + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

A Common Lisp-compatible Format Function

+ +

cl-format is an implementation of the incredibly baroque Common Lisp format function as specified +in Common Lisp, the Language, 2nd edition, Chapter 22.

+ +

Format gives you an easy and powerful way to format text and data for output. It supports rich +formatting of strings and numbers, loops, conditionals, embedded formats, etc. It is really a +domain-specific language for formatting.

+ +

This implementation for clojure has the following goals:

+ +
    +
  • Support the full feature set of the Common Lisp format function (including the X3J13 extensions) with the only exception being concepts that make no sense or are differently interpreted in Clojure.
  • +
  • Make porting code from Common Lisp easier.
  • +
  • Provide a more native feeling solution for Clojure programmers than the Java format method and its relatives.
  • +
  • Be fast. This includes the ability to precompile formats that are going to be used reptitively.
  • +
  • Include useful error handling and comprehensive documentation.
  • +
+ +

Why would I use cl-format?

+ +

For some people the answer to this question is that they are used to +Common Lisp and, therefore, they already know the syntax of format +strings and all the directives.

+ +

A more interesting answer is that cl-format provides a way of +rendering strings that is much more suited to Lisp and its data +structures.

+ +

Because iteration and conditionals are built into the directive +structure of cl-format, it is possible to render sequences and other +complex data structures directly without having to loop over the data +structure.

+ +

For example, to print the elements of a sequence separated by commas, +you simply say:

+ +
(cl-format true "~{~a~^, ~}" aseq)
+
+ +

(This example is taken from +Practical Common Lisp +by Peter Seibel.)

+ +

The corresponding output using Clojure's Java-based format function +would involve a nasty loop/recur with some code to figure out about +the commas. Yuck!

+ +

Current Status of cl-format

+ +

cl-format is 100% compatible with the Common Lisp standard as +specified in CLtLv2. +This includes all of the functionality of Common +Lisp's format function including iteration, conditionals, +text justification and rich +options for displaying real and integer values. It also includes the +directives to support pretty printing structured output.

+ +

If you find a bug in a directive, drop me a line +with a chunk of code that exhibits the bug and the version of +cl-format you found it in and I'll try to get it fixed.

+ +

I also intend to have good built-in documentation for the directives, +but I haven't built that yet.

+ +

The following directives are +not yet supported: ~:T and ~@:T (but all other forms of ~T work) +and extensions with ~/.

+ +

The pretty printer interface is similar, but not identical to the +interface in Common Lisp.

+ +

The custom dispatch table functionality is not fully fleshed out yet.

+ +

Next up:

+ +
    +
  • Support for ~/
  • +
  • Restructure unit tests into modular chunks.
  • +
  • Import tests from CLISP and SBCL.
  • +
  • Unit tests for exception conditions.
  • +
  • Interactive documentation
  • +
+ +

How to use cl-format

+ +

Loading cl-format in your program

+ +

Once cl-format is in your path, adding it to your code is easy:

+ +
(ns your-namespace-here
+  (:use clojure.contrib.pprint))
+
+ +

If you want to refer to the cl-format function as "format" (rather +than using the clojure function of that name), you can use this idiom:

+ +
(ns your-namespace-here
+  (:refer-clojure :exclude [format])
+  (:use clojure.contrib.pprint))
+
+(def format cl-format)
+
+ +

You might want to do this in code that you've ported from Common Lisp, +for instance, or maybe just because old habits die hard.

+ +

From the REPL, you can grab it using (use):

+ +
(use 'clojure.contrib.pprint)
+
+ +

Calling cl-format

+ +

cl-format is a standard clojure function that takes a variable number +of arguments. You call it like this:

+ +
(cl-format stream format args...)
+
+ +

stream can be any Java Writer (that is java.io.Writer) or the values +true, false, or nil. The argument true is identical to using +*out* while false or nil indicate that cl-format should return +its result as a string rather than writing it to a stream.

+ +

format is either a format string or a compiled format (see +below). The format string controls the output that's written in a way +that's similar to (but much more powerful than) the standard Clojure +API format function (which is based on Java's +java.lang.String.Format).

+ +

Format strings consist of characters that are to be written to the +output stream plus directives (which are marked by ~) as in "The +answer is ~,2f". Format strings are documented in detail in +Common Lisp the Language, 2nd edition, Chapter 22.

+ +

args is a set of arguments whose use is defined by the format.

+ +

Compiled formats

+ +

When you use a format string many times (for example, when you're outputting +in a loop), you can improve your performance by compiling the format +with compile-format. The result of compile format can be passed to +cl-format just like a format string but it doesn't need to be +parsed.

+ +

For example:

+ +
(def log-format (compile-format "~2,'0D/~2,'0D/~D ~2D:~2,'0D ~:[PM,AM]: ~A~%"))
+
+(defn log [msg]
+  (let [[m d y h min am?] (some-date-decomposition-fn)]
+    (cl-format log-format m d y h min am? msg)))
+
+ +

Using column aware streams across format invocations

+ +

Writers in Java have no real idea of current column or device page width, so the format +directives that want to work relative to the current position on the +page have nothing to work with. To deal with this, cl-format contains +an extension to writer called PrettyWriter. PrettyWriter watches the +output and keeps track of what column the current output is going to.

+ +

When you call format and your format includes a directive that cares +about what column it's in (~T, ~&, ~<...~>), cl-format will +automatically wrap the Writer you passed in with a PrettyWriter. This +means that by default all cl-format statements act like they begin on +a fresh line and have a page width of 72.

+ +

For many applications, these assumptions are fine and you need to do +nothing more. But sometimes you want to use multiple cl-format calls +that output partial lines. You may also want to mix cl-format calls +with the native clojure calls like print. If you want stay +column-aware while doingg this you need to create a PrettyWriter of +your own (and possibly bind it to *out*).

+ +

As an example of this, this function takes a nested list and prints it +as a table (returning the result as a string):

+ +
(defn list-to-table [aseq column-width]
+  (let [stream (PrettyWriter. (java.io.StringWriter.))]
+    (binding [*out* stream]
+     (doseq [row aseq]
+       (doseq [col row]
+         (cl-format true "~4D~7,vT" col column-width))
+       (prn)))
+    (.toString (.getWriter stream))))
+
+ +

(In reality, you'd probably do this as a single call to cl-format.)

+ +

The constructor to PrettyWriter takes the Writer it's wrapping and +(optionally) the page width (in columns) for use with ~<...~>.

+ +

Examples

+ +

The following function uses cl-format to dump a columnized table of the Java system properties:

+ +
(defn show-props [stream]
+  (let [p (mapcat 
+           #(vector (key %) (val %)) 
+           (sort-by key (System/getProperties)))]
+    (cl-format stream "~30A~A~%~{~20,,,'-A~10A~}~%~{~30A~S~%~}" 
+               "Property" "Value" ["" "" "" ""] p)))
+
+ +

There are some more examples in the clojure.contrib.pprint.examples +package:

+ +
    +
  • hexdump - a program that uses cl-format to create a standard formatted hexdump of the requested stream.
  • +
  • multiply - a function to show a formatted multipication table in a very "first-order" way.
  • +
  • props - the show-props example shown above.
  • +
  • show_doc - some utilities for showing documentation from various name spaces.
  • +
+ +

Differences from the Common Lisp format function

+ +

The floating point directives that show exponents (~E, ~G) show E for +the exponent character in all cases (unless overridden with an +exponentchar). Clojure does not distinguish between floats and +doubles in its printed representation and neither does cl-format.

+ +

The ~A and ~S directives accept the colon prefix, but ignore it since +() and nil are not equivalent in Clojure.

+ +

Clojure has 3 different reader syntaxes for characters. The ~@c +directive to cl-format has an argument extension to let you choose:

+ +
    +
  • ~@c (with no argument) prints "\c" (backslash followed by the printed representation of the character or \newline, \space, \tab, \backspace, \return)
  • +
  • ~'o@c prints "\oDDD" where DDD are the octal digits representing the character.
  • +
  • ~'u@c prints "\uXXXX" prints the hex Unicode representation of the character.
  • +
+
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/doc/pprint/PrettyPrinting.html b/branch-master/doc/pprint/PrettyPrinting.html new file mode 100644 index 00000000..c48ee1af --- /dev/null +++ b/branch-master/doc/pprint/PrettyPrinting.html @@ -0,0 +1,363 @@ + + + A Pretty Printer for Clojure + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

A Pretty Printer for Clojure

+ +

To use pretty printing in clojure.contrib, it is necessary to build +clojure.contrib with compiled classes. To do this, you must tell +ant where to find clojure.jar. For me, this looks like:

+ +
 ant -Dclojure.jar=../clojure/clojure.jar
+
+ +

because I keep clojure source and clojure.contrib source right next to +each other. Just point the pathname to wherever you keep clojure.jar.

+ +

Overview

+ +

This library adds a new feature to Clojure: a generalized pretty +printer.

+ +

The pretty printer is easy to use:

+ +
user=> (println (for [x (range 10)] (range x)))
+(() (0) (0 1) (0 1 2) (0 1 2 3) (0 1 2 3 4) (0 1 2 3 4 5) (0 1 2 3 4 5 6) (0 1 2 3 4 5 6 7) (0 1 2 3 4 5 6 7 8))
+nil
+user=> (use 'clojure.contrib.pprint)             
+nil
+user=> (pprint (for [x (range 10)] (range x)))         
+(()
+ (0)
+ (0 1)
+ (0 1 2)
+ (0 1 2 3)
+ (0 1 2 3 4)
+ (0 1 2 3 4 5)
+ (0 1 2 3 4 5 6)
+ (0 1 2 3 4 5 6 7)
+ (0 1 2 3 4 5 6 7 8))
+nil
+user=>
+
+ +

The pretty printer supports two modes: code which has special +formatting for special forms and core macros and simple (the +default) which formats the various Clojure data structures as +appropriate for raw data. In the future, the pretty printer will be +highly customizable, but right now it is pretty simple.

+ +

All the functions and variables described here are in the +clojure.contrib.pprint namespace. Using them is as simple as including +clojure-contrib.jar to your classpath and adding a (:use clojure.contrib.pprint) to +your namespace declarations.

+ +

pprint is being developed by Tom Faulhaber (to mail me you can use +my first name at my domain which is infolace.com).

+ +

As part of clojure.contrib, the pretty printer is licensed under the +[http://opensource.org/licenses/eclipse-1.0.php Eclipse Public License 1.0].

+ +

clojure.contrib is hosted on google code at [http://code.google.com/p/clojure-contrib/]

+ +

Future development is guided by those using it, so send feedback about +what's working and not working for you and what you'd like to see in the +pretty printer.

+ +

Pretty Printing Basics

+ +

Pretty printing is primarily implemented with the function +pprint. pprint takes a single argument and formats it according to the +settings of several special variables.

+ +

Generally, the defaults are fine for pretty printing and you can +simply use:

+ +
(pprint obj)
+
+ +

to print your object. If you wish to write to +another stream besides *out*, you can use:

+ +
(write obj :pretty true :stream foo)
+
+ +

where foo is the stream to which you wish to write. (The write +function has a lot more options which are not yet documented. Stay +tuned.)

+ +

When at the REPL, the pp macro pretty prints the last output +value. This is useful when you get something too complex to read +comfortably. Just type:

+ +
user=> (pp)
+
+ +

and you'll get a pretty printed version of the last thing output (the +magic variable *1).

+ +

Dispatch tables and code formatting

+ +

The behavior of the pretty printer can be finely controlled through +the use of dispatch tables that contain descriptions for how +different structures should be formatted.

+ +

Using custom dispatch tables, the pretty printer can create formatted +output for data structures that is customized for the +application. This allows pretty printing to be baked into any +structured output. For information and examples, see below in +[#CustomDispatchFunctions Custom Dispatch Functions].

+ +

The pretty printer comes with two pre-defined dispatch tables to cover +the most common situations:

+ +

*simple-dispatch* - supports basic representation of data in various +Clojure structures: seqs, maps, vectors, etc. in a fairly statndard +way. When structures need to be broken across lines, following lines +are indented to line up with the first element. *simple-dispatch* is +the default and is good from showing the output of most operations.

+ +

*code-dispatch* - has special representation for various structures +found in code: defn, condp, binding vectors, anonymous functions, +etc. This dispatch indents following lines of a list one more space as +appropriate for a function/argument type of list.

+ +

An example formatted with code dispatch:

+ +
user=> (def code '(defn cl-format 
+"An implementation of a Common Lisp compatible format function"
+[stream format-in & args] (let [compiled-format (if (string? format-in) 
+(compile-format format-in) format-in) navigator (init-navigator args)] 
+(execute-format stream compiled-format navigator))))
+#'user/code
+user=> (with-pprint-dispatch *code-dispatch* (pprint code))
+(defn cl-format
+  "An implementation of a Common Lisp compatible format function"
+  [stream format-in & args]
+  (let [compiled-format (if (string? format-in)
+                          (compile-format format-in)
+                          format-in)
+        navigator (init-navigator args)]
+    (execute-format stream compiled-format navigator)))
+nil
+user=>
+
+ +

There are three ways to set the current dispatch: set it to a specific +table permanantly with set-pprint-dispatch, bind it with +with-pprint-dispatch (as shown in the example above), or use the +:dispatch keyword argument to write.

+ +

Control variables

+ +

The operation of pretty printing is also controlled by a set of variables +that control general parameters of how the pretty printer makes +decisions. The current list is as follows:

+ +

*print-pretty*: Default: true

+ +

Bind to true if you want write to use pretty printing. (pprint and pp automatically +bind this to true.)

+ +

*print-right-margin*: Default: 72

+ +

Pretty printing will try to avoid anything going beyond this column.

+ +

*print-miser-width*: Default: 40

+ +

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. For example, in the code dispatch table, the pretty printer will +insert a newline between the "if" and its condition when in miser style.

+ +

*print-suppress-namespaces*: Default: false

+ +

Don't print namespaces with symbols. This is particularly useful when +pretty printing the results of macro expansions

+ +

*print-level*: Default: nil

+ +

As with the regular Clojure print function, this variable controls the +depth of structure that is printed. The argument itself is level 0, +the first level of a collection is level 1, etc. When the structure +gets deeper than the specified *print-level*, a hash sign (#) is +printed.

+ +

For example:

+ +
user=> (binding [*print-level* 2] (pprint '(a b (c d) ((e) ((f d) g)))))
+(a b (c d) (# #))
+nil
+user=>
+
+ +

*print-length*: Default: nil

+ +

As with the regular Clojure print function, this variable controls the +number of items that are printed at each layer of structure. When a +layer has too many items, elipses (...) are displayed.

+ +

For example:

+ +
user=> (defn foo [x] (for [i (range x) ] (range 1 (- x (dec i)))))
+#'user/foo
+user=> (binding [*print-length* 6] (pprint (foo 10)))
+((1 2 3 4 5 6 ...)
+ (1 2 3 4 5 6 ...)
+ (1 2 3 4 5 6 ...)
+ (1 2 3 4 5 6 ...)
+ (1 2 3 4 5 6)
+ (1 2 3 4 5)
+ ...)
+nil
+user=>
+
+ +

Custom Dispatch Functions

+ +

Using custom dispatch, you can easily create your own formatted output +for structured data. Examples included with the pretty printer show +how to use custom dispatch to translate simple Clojure structures into +nicely formatted JSON and XML.

+ +

Basic Concepts of Pretty Printing

+ +

In order to create custom dispatch functions, you need to understand +the fundamentals of pretty printing. The clojure pretty printer is +based on the XP pretty printer algorithm (used in many Lisps including +Common Lisp) which supports sophisticated decision-making about line +breaking and indentation with reasonable performance even for very +large structures. The XP algorithm is documented in the paper, +[http://dspace.mit.edu/handle/1721.1/6504 XP. A Common Lisp Pretty +Printing System].

+ +

The Clojure implementation of XP is similar in spirit to the Common +Lisp implementation, but the details of the interface are somewhat +different. The result is that writing custom dispatch in Clojure is +more "Clojure-y."

+ +

There are three key concepts to understand when creating custom pretty +printing functions: logical blocks, conditional newlines, and +indentation.

+ +

A logical block marks a set of output that should be thought about +as a single unit by the pretty printer. Logical blocks can contain +other logical blocks (that is, they nest). As a simple example, when +printing list structure, every sublist will typically be a logical +block.

+ +

Conditional newlines tell the pretty printer where it can insert +line breaks and how to make the decisions about when to do it. There +are four types of conditional newline:

+ +
    +
  • Linear newlines tell the pretty printer to insert a newline in a +place whenever the enclosing logical block won't fit on a single +line. Linear newlines are an all-or-nothing proposition; if the +logical block doesn't fit on a single line, all the linear +newlines are emitted as actual newlines.
  • +
  • Fill newlines tell the pretty printer that it should fit as many +chunks of the logical block as possible on this line and then emit +a newline.
  • +
  • Mandatory newlines tell the pretty printer to emit a newline +regardless of where it is in the output line.
  • +
  • Miser newlines tell the pretty printer to emit a newline if the +output column is in the miser region (as defined by the pretty +printer variable *pprint-miser-width*). This allows you to +define special behavior as the output gets heavily nested near the +right margin.
  • +
+ +

Indentation commands allow you to specify how wrapped lines should +be indented. Indentation can be relative to either the start column of +the current logical block or the current column position of the output.

+ +

(This section is still incomplete...)

+ +

Current limitations and future plans

+ +

This is an early version release of the pretty printer and there is +plenty that is yet to come.

+ +

Here are some examples:

+ +
    +
  • Support all the types and forms in Clojure (most of the way there now).
  • +
  • Support for limiting pretty printing based on line counts.
  • +
  • Support for circular and shared substructure detection.
  • +
  • Finishing the integration with the format function (support for ~/ and tabular pretty printing).
  • +
  • Performance! (Not much thought has been made to making this go fast, but there are a bunch of pretty obvious speedups to be had.)
  • +
  • Handle Java objects intelligently
  • +
+ +

Please let me know about anything that's not working right, anything that +should work differently, or the feature you think should be at the top +of my list.

+
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/duck-streams-api.html b/branch-master/duck-streams-api.html new file mode 100644 index 00000000..097cb452 --- /dev/null +++ b/branch-master/duck-streams-api.html @@ -0,0 +1,402 @@ + + + duck-streams - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for duck-streams + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.duck-streams))
+
+

Overview

+
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.
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

*append-to-writer*

+ var
+

+  
If true, writer and spit will open files in append mode.
+Defaults to false.  Use append-writer or append-spit.
+ + + Source +
+
+
+

*buffer-size*

+ var
+

+  
Size, in bytes or characters, of the buffer used when
+copying streams.
+ + + Source +
+
+
+

*byte-array-type*

+ var
+

+  
Type object for a Java primitive byte array.
+ + + Source +
+
+
+

*default-encoding*

+ var
+

+  
Name of the default encoding to use when reading & writing.
+Default is UTF-8.
+ + + Source +
+
+
+

append-spit

+ function
+
Usage: (append-spit f content)
+
+
Like spit but appends to file.
+ + + Source +
+
+
+

append-writer

+ function
+
Usage: (append-writer x)
+
+
Like writer but opens file for appending.  Does not work on streams
+that are already open.
+ + + Source +
+
+
+

copy

+ multimethod
+
Usage: (copy input output)
+
+
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.
+ + + Source +
+
+
+

file-str

+ function
+
Usage: (file-str & args)
+
+
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.
+ + + Source +
+
+
+

make-parents

+ function
+
Usage: (make-parents file)
+
+
Creates all parent directories of file.
+ + + Source +
+
+
+

pwd

+ function
+
Usage: (pwd)
+
+
Returns current working directory as a String.  (Like UNIX 'pwd'.)
+Note: In Java, you cannot change the current working directory.
+ + + Source +
+
+
+

read-lines

+ function
+
Usage: (read-lines f)
+
+
Like clojure.core/line-seq but opens f with reader.  Automatically
+closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE.
+ + + Source +
+
+
+

reader

+ multimethod
+
Usage: (reader x)
+
+
Attempts to coerce its argument into an open
+java.io.BufferedReader.  Argument may be an instance of Reader,
+BufferedReader, InputStream, File, URI, URL, Socket, 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.
+ + + Source +
+
+
+

slurp*

+ function
+
Usage: (slurp* f)
+
+
Like clojure.core/slurp but opens f with reader.
+ + + Source +
+
+
+

spit

+ function
+
Usage: (spit f content)
+
+
Opposite of slurp.  Opens f with writer, writes content, then
+closes f.
+ + + Source +
+
+
+

to-byte-array

+ multimethod
+
Usage: (to-byte-array arg)
+
+
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.
+ + + Source +
+
+
+

with-in-reader

+ macro
+
Usage: (with-in-reader f & body)
+
+
Opens a PushbackReader on f, binds it to *in*, and evaluates body.
+ + + Source +
+
+
+

with-out-append-writer

+ macro
+
Usage: (with-out-append-writer f & body)
+
+
Like with-out-writer but appends to file.
+ + + Source +
+
+
+

with-out-writer

+ macro
+
Usage: (with-out-writer f & body)
+
+
Opens a writer on f, binds it to *out*, and evalutes body.
+Anything printed within body will be written to f.
+ + + Source +
+
+
+

write-lines

+ function
+
Usage: (write-lines f lines)
+
+
Writes lines (a seq) to f, separated by newlines.  f is opened with
+writer, and automatically closed at the end of the sequence.
+ + + Source +
+
+
+

writer

+ multimethod
+
Usage: (writer x)
+
+
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, Socket, 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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/error-kit-api.html b/branch-master/error-kit-api.html new file mode 100644 index 00000000..df89f3c8 --- /dev/null +++ b/branch-master/error-kit-api.html @@ -0,0 +1,238 @@ + + + error-kit - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for error-kit + - clojure-contrib next (in development) +

+by Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.error-kit))
+
+

Overview

+
EXPERIMENTAL
+System for defining and using custom errors
+Please contact Chouser if you have any suggestions for better names
+or API adjustments.
+ + +
+

Public Variables and Functions

+
+
+
+

bind-continue

+ function
+
Usage: (bind-continue continue-name [args*] & body)
+
+
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.
+ + + Source +
+
+
+

deferror

+ macro
+
Usage: (deferror name [parent-error?] doc-string? [args*] & body)
+       (deferror name [parent-error?] doc-string? args-destruct-map & body)
+
+
Define a new error type
+ + + Source +
+
+
+

do-not-handle

+ macro
+
Usage: (do-not-handle)
+
+
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.
+ + + Source +
+
+
+

error

+ function
+
Usage: (error details)
+
+
Base type for all error-kit errors
+ + + Source +
+
+
+

handle

+ function
+
Usage: (handle error-name? [args*] & body)
+       (handle error-name? args-destruct-map-args & body)
+
+
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'.
+ + + Source +
+
+
+

raise

+ macro
+
Usage: (raise err-name & args)
+
+
Raise an error of the type err-name, constructed with the given args
+ + + Source +
+
+
+

raise*

+ function
+
Usage: (raise* err)
+
+
Raise the given error object, best if created by an error
+constructor defined with deferror.  See also 'raise' macro.
+ + + Source +
+
+
+

throw-msg

+ macro
+
Usage: (throw-msg class-name)
+
+
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.
+ + + Source +
+
+
+

with-handler

+ macro
+
Usage: (with-handler & forms)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/except-api.html b/branch-master/except-api.html new file mode 100644 index 00000000..9cadd803 --- /dev/null +++ b/branch-master/except-api.html @@ -0,0 +1,171 @@ + + + except - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for except + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.except))
+
+

Overview

+
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.
+ + +
+

Public Variables and Functions

+
+
+
+

throw-arg

+ function
+
Usage: (throw-arg & args)
+
+
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.
+ + + Source +
+
+
+

throw-if

+ function
+
Usage: (throw-if test & args)
+
+
Throws an Exception or Error if test is true. args are those documented
+for throwf.
+ + + Source +
+
+
+

throw-if-not

+ function
+
Usage: (throw-if-not test & args)
+
+
Throws an Exception or Error if test is false. args are those documented
+for throwf.
+ + + Source +
+
+
+

throwf

+ function
+
Usage: (throwf & args)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/fcase-api.html b/branch-master/fcase-api.html new file mode 100644 index 00000000..815f1c8c --- /dev/null +++ b/branch-master/fcase-api.html @@ -0,0 +1,200 @@ + + + fcase - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for fcase + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.fcase))
+
+

Overview

+
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.
+ + +
+

Public Variables and Functions

+
+
+
+

case

+ macro
+
Usage: (case test-value & clauses)
+
+
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.
+ + + Source +
+
+
+

fcase

+ macro
+
Usage: (fcase compare-fn case-value & test-expr-clauses)
+
+
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.
+ + + Source +
+
+
+

in-case

+ macro
+
Usage: (in-case test-value & clauses)
+
+
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.
+ + + Source +
+
+
+

instance-case

+ macro
+
Usage: (instance-case test-value & clauses)
+
+
Like case, but the test expressions are Java class names, tested with
+'instance?'.
+ + + Source +
+
+
+

re-case

+ macro
+
Usage: (re-case test-value & clauses)
+
+
Like case, but the test expressions are regular expressions, tested
+with re-find.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/find-namespaces-api.html b/branch-master/find-namespaces-api.html new file mode 100644 index 00000000..3f9e94e7 --- /dev/null +++ b/branch-master/find-namespaces-api.html @@ -0,0 +1,297 @@ + + + find-namespaces - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for find-namespaces + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.find-namespaces))
+
+

Overview

+
Search for ns declarations in dirs, JARs, or CLASSPATH
+ + +
+

Public Variables and Functions

+
+
+
+

clojure-source-file?

+ function
+
Usage: (clojure-source-file? file)
+
+
Returns true if file is a normal file with a .clj extension.
+ + + Source +
+
+
+

clojure-sources-in-jar

+ function
+
Usage: (clojure-sources-in-jar jar-file)
+
+
Returns a sequence of filenames ending in .clj found in the JAR file.
+ + + Source +
+
+
+

comment?

+ function
+
Usage: (comment? form)
+
+
Returns true if form is a (comment ...)
+ + + Source +
+
+
+

find-clojure-sources-in-dir

+ function
+
Usage: (find-clojure-sources-in-dir dir)
+
+
Searches recursively under dir for Clojure source files (.clj).
+Returns a sequence of File objects, in breadth-first sort order.
+ + + Source +
+
+
+

find-namespaces-in-dir

+ function
+
Usage: (find-namespaces-in-dir dir)
+
+
Searches dir recursively for (ns ...) declarations in Clojure
+source files; returns the symbol names of the declared namespaces.
+ + + Source +
+
+
+

find-namespaces-in-jarfile

+ function
+
Usage: (find-namespaces-in-jarfile jarfile)
+
+
Searches the JAR file for Clojure source files containing (ns ...)
+declarations.  Returns a sequence of the symbol names of the
+declared namespaces.
+ + + Source +
+
+
+

find-namespaces-on-classpath

+ function
+
Usage: (find-namespaces-on-classpath)
+
+
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.
+ + + Source +
+
+
+

find-ns-decls-in-dir

+ function
+
Usage: (find-ns-decls-in-dir dir)
+
+
Searches dir recursively for (ns ...) declarations in Clojure
+source files; returns the unevaluated ns declarations.
+ + + Source +
+
+
+

find-ns-decls-in-jarfile

+ function
+
Usage: (find-ns-decls-in-jarfile jarfile)
+
+
Searches the JAR file for Clojure source files containing (ns ...)
+declarations; returns the unevaluated ns declarations.
+ + + Source +
+
+
+

find-ns-decls-on-classpath

+ function
+
Usage: (find-ns-decls-on-classpath)
+
+
Searches CLASSPATH (both directories and JAR files) for Clojure
+source files containing (ns ...) declarations.  Returns a sequence
+of the unevaluated ns declaration forms.
+ + + Source +
+
+
+

ns-decl?

+ function
+
Usage: (ns-decl? form)
+
+
Returns true if form is a (ns ...) declaration.
+ + + Source +
+
+
+

read-file-ns-decl

+ function
+
Usage: (read-file-ns-decl file)
+
+
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.
+ + + Source +
+
+
+

read-ns-decl

+ function
+
Usage: (read-ns-decl rdr)
+
+
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.
+ + + Source +
+
+
+

read-ns-decl-from-jarfile-entry

+ function
+
Usage: (read-ns-decl-from-jarfile-entry jarfile entry-name)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/fnmap-api.html b/branch-master/fnmap-api.html new file mode 100644 index 00000000..66dcd3c0 --- /dev/null +++ b/branch-master/fnmap-api.html @@ -0,0 +1,124 @@ + + + fnmap - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for fnmap + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.fnmap))
+
+

Overview

+
Maps that dispatch get/assoc to user-defined functions.
+
+Note: requires AOT-compilation
+ + +
+

Public Variables and Functions

+
+
+
+

fnmap

+ function
+
Usage: (fnmap getter setter)
+       (fnmap getter setter & keyvals)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/gen-html-docs-api.html b/branch-master/gen-html-docs-api.html new file mode 100644 index 00000000..1b977a9f --- /dev/null +++ b/branch-master/gen-html-docs-api.html @@ -0,0 +1,128 @@ + + + gen-html-docs - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for gen-html-docs + - clojure-contrib next (in development) +

+by Craig Andera
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.gen-html-docs))
+
+

Overview

+
Generates a single HTML page that contains the documentation for
+one or more Clojure libraries.
+ + +
+

Public Variables and Functions

+
+
+
+

generate-documentation

+ function
+
Usage: (generate-documentation libs)
+
+
Returns a string which is the HTML documentation for the libraries
+named by libs. Libs is a vector of symbols identifying Clojure
+libraries.
+ + + Source +
+
+
+

generate-documentation-to-file

+ function
+
Usage: (generate-documentation-to-file path libs)
+
+
Calls generate-documentation on the libraries named by libs and
+emits the generated HTML to the path named by path.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/generic.arithmetic-api.html b/branch-master/generic.arithmetic-api.html new file mode 100644 index 00000000..1e719baa --- /dev/null +++ b/branch-master/generic.arithmetic-api.html @@ -0,0 +1,199 @@ + + + generic.arithmetic - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for generic.arithmetic + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.generic.arithmetic))
+
+

Overview

+
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.
+ + +
+

Public Variables and Functions

+
+
+
+

*

+ multimethod
+
Usage: (* x)
+       (* x y)
+       (* x y & more)
+
+
Return the product of all arguments. The minimal implementation for type
+::my-type is the binary form with dispatch value [::my-type ::my-type].
+ + + Source +
+
+
+

+

+ multimethod
+
Usage: (+ x)
+       (+ x y)
+       (+ x y & more)
+
+
Return the sum of all arguments. The minimal implementation for type
+::my-type is the binary form with dispatch value [::my-type ::my-type].
+ + + Source +
+
+
+

-

+ multimethod
+
Usage: (- x)
+       (- x y)
+       (- x y & more)
+
+
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].
+ + + Source +
+
+
+

/

+ multimethod
+
Usage: (/ x)
+       (/ x y)
+       (/ x y & more)
+
+
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].
+ + + Source +
+
+
+

defmethod*

+ macro
+
Usage: (defmethod* ns name & args)
+
+
Define a method implementation for the multimethod name in namespace ns.
+Required for implementing the division function from another namespace.
+ + + Source +
+
+
+

qsym

+ macro
+
Usage: (qsym ns sym)
+
+
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 /).
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/generic.collection-api.html b/branch-master/generic.collection-api.html new file mode 100644 index 00000000..d77eee61 --- /dev/null +++ b/branch-master/generic.collection-api.html @@ -0,0 +1,199 @@ + + + generic.collection - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for generic.collection + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.generic.collection))
+
+

Overview

+
Generic arithmetic interface
+This library defines generic versions of common
+collection-related functions as multimethods that can be
+defined for any type.
+ + +
+

Public Variables and Functions

+
+
+
+

assoc

+ multimethod
+
Usage: (assoc coll & key-val-pairs)
+
+
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.
+ + + Source +
+
+
+

conj

+ multimethod
+
Usage: (conj coll & xs)
+
+
Returns a new collection resulting from adding all xs to coll.
+ + + Source +
+
+
+

dissoc

+ multimethod
+
Usage: (dissoc coll & keys)
+
+
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.
+ + + Source +
+
+
+

empty

+ multimethod
+
Usage: (empty coll)
+
+
Returns an empty collection of the same kind as the argument
+ + + Source +
+
+
+

get

+ multimethod
+
Usage: (get coll key)
+       (get coll key not-found)
+
+
Returns the element of coll referred to by key. Each type of collection
+can have specific restrictions on the possible keys.
+ + + Source +
+
+
+

into

+ multimethod
+
Usage: (into to from)
+
+
Returns a new coll consisting of to-coll with all of the items of
+from-coll conjoined.
+ + + Source +
+
+
+

seq

+ multimethod
+
Usage: (seq s)
+
+
Returns a seq on the object s.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/generic.comparison-api.html b/branch-master/generic.comparison-api.html new file mode 100644 index 00000000..01c12067 --- /dev/null +++ b/branch-master/generic.comparison-api.html @@ -0,0 +1,259 @@ + + + generic.comparison - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for generic.comparison + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.generic.comparison))
+
+

Overview

+
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 >.
+ + +
+

Public Variables and Functions

+
+
+
+

<

+ multimethod
+
Usage: (< x)
+       (< x y)
+       (< x y & more)
+
+
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 >.
+ + + Source +
+
+
+

<=

+ multimethod
+
Usage: (<= x)
+       (<= x y)
+       (<= x y & more)
+
+
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 >.
+ + + Source +
+
+
+

=

+ multimethod
+
Usage: (= x)
+       (= x y)
+       (= x y & more)
+
+
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].
+ + + Source +
+
+
+

>

+ multimethod
+
Usage: (> x)
+       (> x y)
+       (> x y & more)
+
+
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].
+ + + Source +
+
+
+

>=

+ multimethod
+
Usage: (>= x)
+       (>= x y)
+       (>= x y & more)
+
+
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 <.
+ + + Source +
+
+
+

max

+ function
+
Usage: (max x)
+       (max x y)
+       (max x y & more)
+
+
Returns the greatest of its arguments. Like clojure.core/max except that
+is uses generic comparison functions implementable for any data type.
+ + + Source +
+
+
+

min

+ function
+
Usage: (min x)
+       (min x y)
+       (min x y & more)
+
+
Returns the least of its arguments. Like clojure.core/min except that
+is uses generic comparison functions implementable for any data type.
+ + + Source +
+
+
+

neg?

+ multimethod
+
Usage: (neg? x)
+
+
Return true of x is negative.
+ + + Source +
+
+
+

pos?

+ multimethod
+
Usage: (pos? x)
+
+
Return true of x is positive.
+ + + Source +
+
+
+

zero?

+ multimethod
+
Usage: (zero? x)
+
+
Return true of x is zero.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/generic.functor-api.html b/branch-master/generic.functor-api.html new file mode 100644 index 00000000..39d53330 --- /dev/null +++ b/branch-master/generic.functor-api.html @@ -0,0 +1,112 @@ + + + generic.functor - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for generic.functor + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.generic.functor))
+
+

Overview

+
Generic functor interface (fmap)
+ + +
+

Public Variables and Functions

+
+
+
+

fmap

+ multimethod
+
Usage: (fmap f s)
+
+
Applies function f to each item in the data structure s and returns
+a structure of the same kind.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/generic.math-functions-api.html b/branch-master/generic.math-functions-api.html new file mode 100644 index 00000000..ea68406c --- /dev/null +++ b/branch-master/generic.math-functions-api.html @@ -0,0 +1,362 @@ + + + generic.math-functions - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for generic.math-functions + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.generic.math-functions))
+
+

Overview

+
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.
+ + +
+

Public Variables and Functions

+
+
+
+

abs

+ multimethod
+
Usage: (abs x)
+
+
Return the abs of x.
+ + + Source +
+
+
+

acos

+ multimethod
+
Usage: (acos x)
+
+
Return the acos of x.
+ + + Source +
+
+
+

approx=

+ function
+
Usage: (approx= x y eps)
+
+
Return true if the absolute value of the difference between x and y
+is less than eps.
+ + + Source +
+
+
+

asin

+ multimethod
+
Usage: (asin x)
+
+
Return the asin of x.
+ + + Source +
+
+
+

atan

+ multimethod
+
Usage: (atan x)
+
+
Return the atan of x.
+ + + Source +
+
+
+

atan2

+ multimethod
+
Usage: (atan2 x y)
+
+
Return the atan2 of x and y.
+ + + Source +
+
+
+

ceil

+ multimethod
+
Usage: (ceil x)
+
+
Return the ceil of x.
+ + + Source +
+
+
+

conjugate

+ multimethod
+
Usage: (conjugate x)
+
+
Return the conjugate of x.
+ + + Source +
+
+
+

cos

+ multimethod
+
Usage: (cos x)
+
+
Return the cos of x.
+ + + Source +
+
+
+

exp

+ multimethod
+
Usage: (exp x)
+
+
Return the exp of x.
+ + + Source +
+
+
+

floor

+ multimethod
+
Usage: (floor x)
+
+
Return the floor of x.
+ + + Source +
+
+
+

log

+ multimethod
+
Usage: (log x)
+
+
Return the log of x.
+ + + Source +
+
+
+

pow

+ multimethod
+
Usage: (pow x y)
+
+
Return the pow of x and y.
+ + + Source +
+
+
+

rint

+ multimethod
+
Usage: (rint x)
+
+
Return the rint of x.
+ + + Source +
+
+
+

round

+ multimethod
+
Usage: (round x)
+
+
Return the round of x.
+ + + Source +
+
+
+

sgn

+ multimethod
+
Usage: (sgn x)
+
+
Return the sign of x (-1, 0, or 1).
+ + + Source +
+
+
+

sin

+ multimethod
+
Usage: (sin x)
+
+
Return the sin of x.
+ + + Source +
+
+
+

sqr

+ multimethod
+
Usage: (sqr x)
+
+
Return the square of x.
+ + + Source +
+
+
+

sqrt

+ multimethod
+
Usage: (sqrt x)
+
+
Return the sqrt of x.
+ + + Source +
+
+
+

tan

+ multimethod
+
Usage: (tan x)
+
+
Return the tan of x.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/graph-api.html b/branch-master/graph-api.html new file mode 100644 index 00000000..012f30ec --- /dev/null +++ b/branch-master/graph-api.html @@ -0,0 +1,306 @@ + + + graph - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for graph + - clojure-contrib next (in development) +

+by Jeffrey Straszheim
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.graph))
+
+

Overview

+
Basic graph theory algorithms
+ + +
+

Public Variables and Functions

+
+
+
+

add-loops

+ function
+
Usage: (add-loops g)
+
+
For each node n, add the edge n->n if not already present.
+ + + Source +
+
+
+

component-graph

+ function
+
Usage: (component-graph g)
+       (component-graph g sccs)
+
+
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.
+ + + Source +
+
+
+

dependency-list

+ function
+
Usage: (dependency-list g)
+
+
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.
+ + + Source +
+
+
+

fixed-point

+ function
+
Usage: (fixed-point data fun max equal)
+
+
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.
+ + + Source +
+
+
+

get-neighbors

+ function
+
Usage: (get-neighbors g n)
+
+
Get the neighbors of a node.
+ + + Source +
+
+
+

lazy-walk

+ function
+
Usage: (lazy-walk g n)
+       (lazy-walk g ns v)
+
+
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).
+ + + Source +
+
+
+

post-ordered-nodes

+ function
+
Usage: (post-ordered-nodes g)
+
+
Return a sequence of indexes of a post-ordered walk of the graph.
+ + + Source +
+
+
+

recursive-component?

+ function
+
Usage: (recursive-component? g ns)
+
+
Is the component (recieved from scc) self recursive?
+ + + Source +
+
+
+

remove-loops

+ function
+
Usage: (remove-loops g)
+
+
For each node n, remove any edges n->n.
+ + + Source +
+
+
+

reverse-graph

+ function
+
Usage: (reverse-graph g)
+
+
Given a directed graph, return another directed graph with the
+order of the edges reversed.
+ + + Source +
+
+
+

scc

+ function
+
Usage: (scc g)
+
+
Returns, as a sequence of sets, the strongly connected components
+of g.
+ + + Source +
+
+
+

self-recursive-sets

+ function
+
Usage: (self-recursive-sets g)
+
+
Returns, as a sequence of sets, the components of a graph that are
+self-recursive.
+ + + Source +
+
+
+

stratification-list

+ function
+
Usage: (stratification-list g1 g2)
+
+
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.
+ + + Source +
+
+
+

transitive-closure

+ function
+
Usage: (transitive-closure g)
+
+
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)
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/greatest-least-api.html b/branch-master/greatest-least-api.html new file mode 100644 index 00000000..8bca6522 --- /dev/null +++ b/branch-master/greatest-least-api.html @@ -0,0 +1,202 @@ + + + greatest-least - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for greatest-least + - clojure-contrib next (in development) +

+by Vincent Foley
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.greatest-least))
+
+

Overview

+
Various functions for finding greatest and least values in a collection
+ + +
+

Public Variables and Functions

+
+
+
+

all-greatest

+ function
+
Usage: (all-greatest & args)
+
+
Returns all the greatest elements.
+ + + Source +
+
+
+

all-greatest-by

+ function
+
Usage: (all-greatest-by f & args)
+
+
Return all the elements for which f yields the greatest value.
+ + + Source +
+
+
+

all-least

+ function
+
Usage: (all-least & args)
+
+
Returns all the least elements.
+ + + Source +
+
+
+

all-least-by

+ function
+
Usage: (all-least-by f & args)
+
+
Return all the elements for which f yields the least value.
+ + + Source +
+
+
+

greatest

+ function
+
Usage: (greatest & args)
+
+
Return the greatest argument.
+ + + Source +
+
+
+

greatest-by

+ function
+
Usage: (greatest-by f & args)
+
+
Return the argument for which f yields the greatest value.
+ + + Source +
+
+
+

least

+ function
+
Usage: (least & args)
+
+
Return the smallest element.
+ + + Source +
+
+
+

least-by

+ function
+
Usage: (least-by f & args)
+
+
Return the argument for which f yields the smallest value.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/http.agent-api.html b/branch-master/http.agent-api.html new file mode 100644 index 00000000..0974db19 --- /dev/null +++ b/branch-master/http.agent-api.html @@ -0,0 +1,481 @@ + + + http.agent - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for http.agent + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.http.agent))
+
+

Overview

+
Agent-based asynchronous HTTP client.
+
+This is a HTTP client library based on Java's HttpURLConnection
+class and Clojure's Agent system.  It allows you to make multiple
+HTTP requests in parallel.
+
+Start an HTTP request with the 'http-agent' function, which
+immediately returns a Clojure Agent.  You will never deref this
+agent; that is handled by the accessor functions.  The agent will
+execute the HTTP request on a separate thread.
+
+If you pass a :handler function to http-agent, that function will be
+called as soon as the HTTP response body is ready.  The handler
+function is called with one argument, the HTTP agent itself.  The
+handler can read the response body by calling the 'stream' function
+on the agent.
+
+The value returned by the handler function becomes part of the state
+of the agent, and you can retrieve it with the 'result' function.
+If you call 'result' before the HTTP request has finished, it will
+block until the handler function returns.
+
+If you don't provide a handler function, the default handler will
+buffer the entire response body in memory, which you can retrieve
+with the 'bytes', 'string', or 'stream' functions.  Like 'result',
+these functions will block until the HTTP request is completed.
+
+If you want to check if an HTTP request is finished without
+blocking, use the 'done?' function.
+
+A single GET request could be as simple as:
+
+  (string (http-agent "http://www.stuartsierra.com/"))
+
+A simple POST might look like:
+
+  (http-agent "http..." :method "POST" :body "foo=1")
+
+And you could write the response directly to a file like this:
+
+  (require '[clojure.contrib.io :as d])
+
+  (http-agent "http..."
+              :handler (fn [agnt] 
+                         (with-open [w (d/writer "/tmp/out")] 
+                           (d/copy (stream agnt) w))))
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

buffer-bytes

+ function
+
Usage: (buffer-bytes http-agnt)
+
+
The default HTTP agent result handler; it collects the response
+body in a java.io.ByteArrayOutputStream, which can later be
+retrieved with the 'stream', 'string', and 'bytes' functions.
+ + + Source +
+
+
+

bytes

+ function
+
Usage: (bytes http-agnt)
+
+
Returns a Java byte array of the content returned by the server;
+nil if the content is not yet available.
+ + + Source +
+
+
+

client-error?

+ function
+
Usage: (client-error? http-agnt)
+
+
Returns true if the HTTP response code was in the 400-499 range.
+ + + Source +
+
+
+

done?

+ function
+
Usage: (done? http-agnt)
+
+
Returns true if the HTTP request/response has completed.
+ + + Source +
+
+
+

error?

+ function
+
Usage: (error? http-agnt)
+
+
Returns true if the HTTP response code was in the 400-499 range OR
+the 500-599 range.
+ + + Source +
+
+
+

headers

+ function
+
Usage: (headers http-agnt)
+
+
Returns a map of HTTP response headers.  Header names are converted
+to keywords in all lower-case Header values are strings.  If a
+header appears more than once, only the last value is returned.
+ + + Source +
+
+
+

headers-seq

+ function
+
Usage: (headers-seq http-agnt)
+
+
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.
+ + + Source +
+
+
+

http-agent

+ function
+
Usage: (http-agent uri & options)
+
+
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.
+
+:handler f
+
+Function to be called when the HTTP response body is ready.  If you
+do not provide a handler function, the default is to buffer the
+entire response body in memory.
+
+The handler function will be called with the HTTP agent as its
+argument, and can use the 'stream' function to read the response
+body.  The return value of this function will be stored in the state
+of the agent and can be retrieved with the 'result' function.  Any
+exceptions thrown by this function will be added to the agent's
+error queue (see agent-errors).  The default function collects the
+response stream in a memory buffer.
+
+ + + Source +
+
+
+

message

+ function
+
Usage: (message http-agnt)
+
+
Returns the HTTP response message (e.g. 'Not Found'), for this
+request, or nil if the response has not yet been received.
+ + + Source +
+
+
+

method

+ function
+
Usage: (method http-agnt)
+
+
Returns the HTTP method name used by this HTTP agent, as a String.
+ + + Source +
+
+
+

redirect?

+ function
+
Usage: (redirect? http-agnt)
+
+
Returns true if the HTTP response code was in the 300-399 range.
+
+Note: if the :follow-redirects option was true (the default),
+redirects will be followed automatically and a the agent will never
+return a 3xx response code.
+ + + Source +
+
+
+

request-body

+ function
+
Usage: (request-body http-agnt)
+
+
Returns the HTTP request body given to this HTTP agent.  
+
+Note: if the request body was an InputStream or a Reader, it will no
+longer be usable.
+ + + Source +
+
+
+

request-headers

+ function
+
Usage: (request-headers http-agnt)
+
+
Returns the request headers specified for this HTTP agent.
+ + + Source +
+
+
+

request-uri

+ function
+
Usage: (request-uri http-agnt)
+
+
Returns the URI/URL requested by this HTTP agent, as a String.
+ + + Source +
+
+
+

result

+ function
+
Usage: (result http-agnt)
+
+
Returns the value returned by the :handler function of the HTTP
+agent; blocks until the HTTP request is completed.  The default
+handler function returns a ByteArrayOutputStream.
+ + + Source +
+
+
+

server-error?

+ function
+
Usage: (server-error? http-agnt)
+
+
Returns true if the HTTP response code was in the 500-599 range.
+ + + Source +
+
+
+

status

+ function
+
Usage: (status http-agnt)
+
+
Returns the HTTP response status code (e.g. 200, 404) for this
+request, as an Integer, or nil if the status has not yet been
+received.
+ + + Source +
+
+
+

stream

+ function
+
Usage: (stream http-agnt)
+
+
Returns an InputStream of the HTTP response body.  When called by
+the handler function passed to http-agent, this is the raw
+HttpURLConnection stream.
+
+If the default handler function was used, this function returns a
+ByteArrayInputStream on the buffered response body.
+ + + Source +
+
+
+

string

+ function
+
Usage: (string http-agnt)
+       (string http-agnt encoding)
+
+
Returns the HTTP response body as a string, using the given
+encoding.
+
+If no encoding is given, uses the encoding specified in the server
+headers, or clojure.contrib.io/*default-encoding* if it is
+not specified.
+ + + Source +
+
+
+

success?

+ function
+
Usage: (success? http-agnt)
+
+
Returns true if the HTTP response code was in the 200-299 range.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/http.connection-api.html b/branch-master/http.connection-api.html new file mode 100644 index 00000000..0c2c43ce --- /dev/null +++ b/branch-master/http.connection-api.html @@ -0,0 +1,123 @@ + + + http.connection - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for http.connection + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.http.connection))
+
+

Overview

+
Low-level HTTP client API around HttpURLConnection
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

http-connection

+ function
+
Usage: (http-connection url)
+
+
Opens an HttpURLConnection at the URL, handled by as-url.
+ + + Source +
+
+
+

send-request-entity

+ var
+

+  
Transmits a request entity body.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/import-static-api.html b/branch-master/import-static-api.html new file mode 100644 index 00000000..5bef3cfa --- /dev/null +++ b/branch-master/import-static-api.html @@ -0,0 +1,124 @@ + + + import-static - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for import-static + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.import-static))
+
+

Overview

+
Import static Java methods/fields into Clojure
+ + +
+

Public Variables and Functions

+
+
+
+

import-static

+ macro
+
Usage: (import-static class & fields-and-methods)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/index.html b/branch-master/index.html new file mode 100644 index 00000000..6bd402f0 --- /dev/null +++ b/branch-master/index.html @@ -0,0 +1,2281 @@ + + + Overview - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API Overview - clojure-contrib next (in development)

+
+
The user contributions library, clojure.contrib, is a collection +of namespaces each of which implements features that we believe may be useful to +a large part of the clojure community. +

+This library was created by Rich Hickey but has been populated and is maintained by a +group of volunteers who are excited about the success of the Clojure language and +want to do our part to help it along. The current list of contributors is available +on the +clojure-contrib GitHub source page. +

+More contributions (and contributors) are welcome. If you wish to contribute, you will need +to sign a contributor agreement (which allows Clojure and clojure.contrib to proceed +without entanglements, see contributing +for more info). +

+The best way to start is to share a project you've written with the google group and gauge +the interest in adding it to contrib. (Publishing it in an open source form on google code, +github or some other easy-to-access place in the net will also help.) After general +discussion, Rich Hickey makes the final determination about what gets added to +clojure.contrib. +

+Some parts of clojure.contrib may migrate into clojure.core if they prove to be so +generally useful that they justify being everywhere. (For example, condp started out +as an extension in contrib, but was moved to core by popular acclamation.) +

+The exact role of clojure.contrib and the future of the Clojure environment (standard +libraries, dependency models, packaging systems, etc.) +is the subject of pretty much continuous discussion +in the clojure google group and in #clojure on freenode. Feel free to join that +discussion and help shape the ways Clojure is extended. +

+Like Clojure itself, clojure.contrib is made available under the +Eclipse Public License (EPL). +clojure.contrib is copyright 2008-2009 Rich Hickey and the various contributors. +

+

Important clojure-contrib resources

+ +
+
+
+
+
+

accumulators

+ by Konrad Hinsen
+ Detailed API documentation
+
A generic accumulator interface and implementations of various
+accumulators.
+ + + + Public variables and functions: + add add-items combine empty-counter empty-counter-with-total empty-list empty-map empty-maximum empty-mean-variance empty-min-max empty-minimum empty-product empty-queue empty-set empty-string empty-sum empty-tuple empty-vector
+ +
+
+
+

agent-utils

+ by Christophe Grande
+ Detailed API documentation
+
Miscellaneous agent utilities
+(note to other contrib members: feel free to add to this lib)
+ + + + Public variables and functions: + capture-and-send
+ +
+
+
+

apply-macro

+ + Detailed API documentation
+

+  
+  Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + apply-macro
+ +
+
+
+

base64

+ by Stuart Sierra
+ Detailed API documentation
+
Base-64 encoding and (maybe later) decoding.  
+
+This is mainly here as an example.  It is much slower than the
+Apache Commons Codec implementation or sun.misc.BASE64Encoder.
+ + + + Public variables and functions: + encode encode-str
+ +
+
+
+

classpath

+ by Stuart Sierra
+ Detailed API documentation
+
Utilities for dealing with the JVM's classpath
+ + + + Public variables and functions: + classpath classpath-directories classpath-jarfiles
+ +
+
+
+

combinatorics

+ by Mark Engelberg
+ Detailed API documentation
+
Efficient, functional algorithms for generating lazy
+sequences for common combinatorial functions. (See the source code 
+for a longer description.)
+ + + + Public variables and functions: + cartesian-product combinations lex-permutations permutations selections subsets
+ +
+
+
+

command-line

+ by Chris Houser
+ Detailed API documentation
+
Process command-line arguments according to a given cmdspec
+ + + + Public variables and functions: + with-command-line
+ +
+
+
+

complex-numbers

+ by Konrad Hinsen
+ Detailed API documentation
+
Complex numbers
+NOTE: This library is in evolution. Most math functions are
+      not implemented yet.
+ + + + Public variables and functions: +
+ +
+
+
+

cond

+ by Stephen C. Gilardi
+ Detailed API documentation
+
Extensions to the basic cond function.
+ + + + Public variables and functions: + cond-let
+ +
+
+
+

condition

+ by Stephen C. Gilardi
+ Detailed API documentation
+
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
+ + + + Public variables and functions: + *full-stack-traces* handler-case print-stack-trace raise stack-trace-info
+
Variables and functions in + condition.Condition: + + -init + + -meta + + -post-init + +
+
+
+
+
+

core

+ by Laurent Petit (and others)
+ Detailed API documentation
+
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)
+ + + + Public variables and functions: + -?> -?>> .?. dissoc-in new-by-name seqable?
+ +
+
+
+

dataflow

+ by Jeffrey Straszheim
+ Detailed API documentation
+
A library to support a dataflow model of state
+ + + + Public variables and functions: + add-cell-watcher add-cells build-dataflow build-source-cell build-standard-cell build-validator-cell cell display-cell eval-cell get-cell get-cells get-old-value get-source-cells get-value get-value-from-cell get-values print-dataflow remove-cells source-cell? update-values
+ +
+
+
+

datalog

+ by Jeffrey Straszheim
+ Detailed API documentation
+
A Clojure implementation of Datalog
+ + + + Public variables and functions: + build-work-plan run-work-plan
+
Variables and functions in + datalog.database: + + add-index + + add-relation + + add-tuple + + add-tuples + + any-match? + + database-counts + + database-merge + + database-merge-parallel + + datalog-relation + + ensure-relation + + get-relation + + make-database + + merge-relations + + remove-tuple + + replace-relation + + select + +
+

Variables and functions in + datalog.literals: + + adorned-literal + + build-atom + + build-literal + + build-seed-bindings + + delta-literal + + display-literal + + get-adorned-bindings + + get-base-predicate + + get-cs-from-vs + + get-self-bound-cs + + get-vs-from-cs + + join-literal + + literal-appropriate? + + literal-columns + + literal-magic? + + literal-predicate + + literal-vars + + magic-literal + + negated-literal + + negated? + + negative-vars + + positive-vars + + positive? + + project-literal + +
+

Variables and functions in + datalog.magic: + + adorn-query + + adorn-rules-set + + build-partial-tuple + + magic-transform + + seed-predicate-for-insertion + + seed-relation + + seed-rule + +
+

Variables and functions in + datalog.rules: + + <- + + ?- + + all-predicates + + apply-rule + + compute-sip + + display-query + + display-rule + + is-safe? + + make-rules-set + + non-base-rules + + predicate-map + + return-rule-data + + rules-set + +
+

Variables and functions in + datalog.softstrat: + + build-soft-strat-work-plan + + get-all-relations + +
+

Variables and functions in + datalog.util: + + is-query-var? + + is-var? + + keys-to-vals + + map-values + + preduce + + reverse-map + + trace-datalog + +
+
+
+
+
+

def

+ + Detailed API documentation
+

+  
+  
+  
+  Public variables and functions:
+  defalias defhinted defmacro- defn-memo defnk defonce- defstruct- defunbound defunbound- defvar defvar- name-with-attributes 
+ +
+
+
+

duck-streams

+ by Stuart Sierra
+ Detailed API documentation
+
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.
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + *append-to-writer* *buffer-size* *byte-array-type* *default-encoding* append-spit append-writer copy file-str make-parents pwd read-lines reader slurp* spit to-byte-array with-in-reader with-out-append-writer with-out-writer write-lines writer
+ +
+
+
+

error-kit

+ by Chris Houser
+ Detailed API documentation
+
EXPERIMENTAL
+System for defining and using custom errors
+Please contact Chouser if you have any suggestions for better names
+or API adjustments.
+ + + + Public variables and functions: + bind-continue deferror do-not-handle error handle raise raise* throw-msg with-handler
+ +
+
+
+

except

+ by Stephen C. Gilardi
+ Detailed API documentation
+
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.
+ + + + Public variables and functions: + throw-arg throw-if throw-if-not throwf
+ +
+
+
+

fcase

+ by Stuart Sierra
+ Detailed API documentation
+
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.
+ + + + Public variables and functions: + case fcase in-case instance-case re-case
+ +
+
+
+

find-namespaces

+ by Stuart Sierra
+ Detailed API documentation
+
Search for ns declarations in dirs, JARs, or CLASSPATH
+ + + + Public variables and functions: + clojure-source-file? clojure-sources-in-jar comment? find-clojure-sources-in-dir find-namespaces-in-dir find-namespaces-in-jarfile find-namespaces-on-classpath find-ns-decls-in-dir find-ns-decls-in-jarfile find-ns-decls-on-classpath ns-decl? read-file-ns-decl read-ns-decl read-ns-decl-from-jarfile-entry
+ +
+
+
+

fnmap

+ by Stuart Sierra
+ Detailed API documentation
+
Maps that dispatch get/assoc to user-defined functions.
+
+Note: requires AOT-compilation
+ + + + Public variables and functions: + fnmap
+ +
+
+
+

gen-html-docs

+ by Craig Andera
+ Detailed API documentation
+
Generates a single HTML page that contains the documentation for
+one or more Clojure libraries.
+ + + + Public variables and functions: + generate-documentation generate-documentation-to-file
+ +
+
+
+

generic.arithmetic

+ by Konrad Hinsen
+ Detailed API documentation
+
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.
+ + + + Public variables and functions: + * + - / defmethod* qsym
+ +
+
+
+

generic.collection

+ by Konrad Hinsen
+ Detailed API documentation
+
Generic arithmetic interface
+This library defines generic versions of common
+collection-related functions as multimethods that can be
+defined for any type.
+ + + + Public variables and functions: + assoc conj dissoc empty get into seq
+ +
+
+
+

generic.comparison

+ by Konrad Hinsen
+ Detailed API documentation
+
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 >.
+ + + + Public variables and functions: + < <= = > >= max min neg? pos? zero?
+ +
+
+
+

generic.functor

+ by Konrad Hinsen
+ Detailed API documentation
+
Generic functor interface (fmap)
+ + + + Public variables and functions: + fmap
+ +
+
+
+

generic.math-functions

+ by Konrad Hinsen
+ Detailed API documentation
+
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.
+ + + + Public variables and functions: + abs acos approx= asin atan atan2 ceil conjugate cos exp floor log pow rint round sgn sin sqr sqrt tan
+ +
+
+
+

graph

+ by Jeffrey Straszheim
+ Detailed API documentation
+
Basic graph theory algorithms
+ + + + Public variables and functions: + add-loops component-graph dependency-list fixed-point get-neighbors lazy-walk post-ordered-nodes recursive-component? remove-loops reverse-graph scc self-recursive-sets stratification-list transitive-closure
+ +
+
+
+

greatest-least

+ by Vincent Foley
+ Detailed API documentation
+
Various functions for finding greatest and least values in a collection
+ + + + Public variables and functions: + all-greatest all-greatest-by all-least all-least-by greatest greatest-by least least-by
+ +
+
+
+

http.agent

+ by Stuart Sierra
+ Detailed API documentation
+
Agent-based asynchronous HTTP client.
+
+This is a HTTP client library based on Java's HttpURLConnection
+class and Clojure's Agent system.  It allows you to make multiple
+HTTP requests in parallel.
+
+Start an HTTP request with the 'http-agent' function, which
+immediately returns a Clojure Agent.  You will never deref this
+agent; that is handled by the accessor functions.  The agent will
+execute the HTTP request on a separate thread.
+
+If you pass a :handler function to http-agent, that function will be
+called as soon as the HTTP response body is ready.  The handler
+function is called with one argument, the HTTP agent itself.  The
+handler can read the response body by calling the 'stream' function
+on the agent.
+
+The value returned by the handler function becomes part of the state
+of the agent, and you can retrieve it with the 'result' function.
+If you call 'result' before the HTTP request has finished, it will
+block until the handler function returns.
+
+If you don't provide a handler function, the default handler will
+buffer the entire response body in memory, which you can retrieve
+with the 'bytes', 'string', or 'stream' functions.  Like 'result',
+these functions will block until the HTTP request is completed.
+
+If you want to check if an HTTP request is finished without
+blocking, use the 'done?' function.
+
+A single GET request could be as simple as:
+
+  (string (http-agent "http://www.stuartsierra.com/"))
+
+A simple POST might look like:
+
+  (http-agent "http..." :method "POST" :body "foo=1")
+
+And you could write the response directly to a file like this:
+
+  (require '[clojure.contrib.io :as d])
+
+  (http-agent "http..."
+              :handler (fn [agnt] 
+                         (with-open [w (d/writer "/tmp/out")] 
+                           (d/copy (stream agnt) w))))
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + buffer-bytes bytes client-error? done? error? headers headers-seq http-agent message method redirect? request-body request-headers request-uri result server-error? status stream string success?
+ +
+
+
+

http.connection

+ + Detailed API documentation
+
Low-level HTTP client API around HttpURLConnection
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + http-connection send-request-entity
+ +
+
+
+

import-static

+ by Stuart Sierra
+ Detailed API documentation
+
Import static Java methods/fields into Clojure
+ + + + Public variables and functions: + import-static
+ +
+
+
+

io

+ by Stuart Sierra
+ Detailed API documentation
+
This file defines polymorphic I/O utility functions for Clojure.
+
+The Streams protocol defines reader, writer, input-stream and
+output-stream methods that return BufferedReader, BufferedWriter,
+BufferedInputStream and BufferedOutputStream instances (respectively),
+with default implementations extended to a variety of argument
+types: URLs or filenames as strings, java.io.File's, Sockets, etc.
+ + + + Public variables and functions: + *append* *buffer-size* *byte-array-type* *char-array-type* *default-encoding* append-output-stream append-spit append-writer as-url copy delete-file delete-file-recursively file file-str input-stream make-parents output-stream pwd read-lines reader relative-path-string slurp* spit to-byte-array with-in-reader with-out-append-writer with-out-writer write-lines writer
+ +
+
+
+

jar

+ by Stuart Sierra
+ Detailed API documentation
+
Utilities for working with Java JAR files
+ + + + Public variables and functions: + filenames-in-jar jar-file?
+ +
+
+
+

java-utils

+ by Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard, Stuart Sierra
+ Detailed API documentation
+
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.
+Contributors:
+
+Stuart Halloway
+Stephen C. Gilardi
+Shawn Hoover
+Perry Trolard
+Stuart Sierra
+ + + + Public variables and functions: + as-file as-properties as-str as-url delete-file delete-file-recursively file get-system-property read-properties relative-path-string set-system-properties wall-hack-field wall-hack-method with-system-properties write-properties
+ +
+
+
+

javadoc.browse

+ by Christophe Grand
+ Detailed API documentation
+
Start a web browser from Clojure
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + open-url-in-browser open-url-in-swing
+ +
+
+
+

jmx

+ by Stuart Halloway
+ Detailed API documentation
+
JMX support for Clojure
+
+Requires post-Clojure 1.0 git edge for clojure.test, clojure.backtrace.
+This is prerelease.
+This API will change.
+Send reports to stu@thinkrelevance.com.
+
+Usage
+  (require '[clojure.contrib.jmx :as jmx])
+
+What beans do I have?
+
+  (jmx/mbean-names "*:*")
+  -> #<HashSet [java.lang:type=MemoryPool,name=CMS Old Gen, 
+                java.lang:type=Memory, ...]
+
+What attributes does a bean have?
+
+  (jmx/attribute-names "java.lang:type=Memory")
+  -> (:Verbose :ObjectPendingFinalizationCount 
+      :HeapMemoryUsage :NonHeapMemoryUsage)
+
+What is the value of an attribute? 
+
+  (jmx/read "java.lang:type=Memory" :ObjectPendingFinalizationCount)
+  -> 0
+
+Can't I just have *all* the attributes in a Clojure map?
+
+  (jmx/mbean "java.lang:type=Memory")
+  -> {:NonHeapMemoryUsage
+       {:used 16674024, :max 138412032, :init 24317952, :committed 24317952},
+      :HeapMemoryUsage
+       {:used 18619064, :max 85393408, :init 0, :committed 83230720},
+      :ObjectPendingFinalizationCount 0,
+      :Verbose false}
+
+Can I find and invoke an operation?
+
+  (jmx/operation-names "java.lang:type=Memory")
+  -> (:gc)  
+  (jmx/invoke "java.lang:type=Memory" :gc)
+  -> nil
+
+What about some other process? Just run *any* of the above code
+inside a with-connection:
+
+  (jmx/with-connection {:host "localhost", :port 3000} 
+    (jmx/mbean "java.lang:type=Memory"))
+  -> {:ObjectPendingFinalizationCount 0, 
+      :HeapMemoryUsage ... etc.}
+
+Can I serve my own beans?  Sure, just drop a Clojure ref
+into an instance of clojure.contrib.jmx.Bean, and the bean
+will expose read-only attributes for every key/value pair
+in the ref:
+
+  (jmx/register-mbean
+     (Bean.
+     (ref {:string-attribute "a-string"}))
+     "my.namespace:name=Value")
+ + + + Public variables and functions: + *connection* as-object-name attribute-info attribute-names build-attribute-info guess-attribute-typename jmx->clj jmx-url map->attribute-infos maybe-atomize maybe-keywordize mbean mbean-names op-param-types operation operation-names operations raw-read read read-supported readable? with-connection
+ +
+
+
+

json

+ by Stuart Sierra
+ Detailed API documentation
+
JavaScript Object Notation (JSON) parser/writer.
+See http://www.json.org/
+To write JSON, use json-str, write-json, or write-json.
+To read JSON, use read-json.
+ + + + Public variables and functions: + json-str pprint-json print-json read-json read-json-from write-json
+ +
+
+
+

lazy-seqs

+ by Stephen C. Gilardi
+ Detailed API documentation
+
+==== 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 ====
+
+ (partition-all, shuffle moved to clojure.core)
+ (rand-elt moved to clojure.core/rand-nth)
+ (rotations, 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
+ + + + Public variables and functions: + fibs powers-of-2 primes
+ +
+
+
+

lazy-xml

+ by Chris Houser
+ Detailed API documentation
+
Functions to parse xml lazily and emit back to text.
+ + + + Public variables and functions: + parse-seq parse-trim
+ +
+
+
+

logging

+ by Alex Taggart, Timothy Pratley
+ Detailed API documentation
+
Logging macros which delegate to a specific logging implementation. At
+runtime a specific implementation is selected from, in order, Apache
+commons-logging, log4j, and finally java.util.logging.
+
+Logging levels are specified by clojure keywords corresponding to the
+values used in log4j and commons-logging:
+  :trace, :debug, :info, :warn, :error, :fatal
+
+Logging occurs with the log macro, or the level-specific convenience macros,
+which write either directly or via an agent.  For performance reasons, direct
+logging is enabled by default, but setting the *allow-direct-logging* boolean
+atom to false will disable it. If logging is invoked within a transaction it
+will always use an agent.
+
+The log macros will not evaluate their 'message' unless the specific logging
+level is in effect. Alternately, you can use the spy macro when you have code
+that needs to be evaluated, and also want to output the code and its result to
+the debug log.
+
+Unless otherwise specified, the current namespace (as identified by *ns*) will
+be used as the log-ns (similar to how the java class name is usually used).
+Note: your log configuration should display the name that was passed to the
+logging implementation, and not perform stack-inspection, otherwise you'll see
+something like "fn__72$impl_write_BANG__39__auto____81" in your logs.
+
+Use the enabled? macro to write conditional code against the logging level
+(beyond simply whether or not to call log, which is handled automatically).
+
+You can redirect all java writes of System.out and System.err to the log
+system by calling log-capture!.  To rebind *out* and *err* to the log system
+invoke with-logs.  In both cases a log-ns (e.g., "com.example.captured")
+needs to be specified to namespace the output.
+ + + + Public variables and functions: + *allow-direct-logging* *impl-name* *logging-agent* debug enabled? error fatal impl-enabled? impl-get-log impl-write! info log log-capture! log-stream log-uncapture! spy trace warn with-logs
+ +
+
+
+

macro-utils

+ by Konrad Hinsen
+ Detailed API documentation
+
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.
+ + + + Public variables and functions: + defsymbolmacro deftemplate macrolet mexpand mexpand-1 mexpand-all symbol-macrolet with-symbol-macros
+ +
+
+
+

macros

+ by Konrad Hinsen
+ Detailed API documentation
+
Various small macros
+ + + + Public variables and functions: + const letfn- with-direct-linking
+ +
+
+
+

map-utils

+ by Jason Wolfe, Chris Houser
+ Detailed API documentation
+
Utilities for operating on Clojure maps.
+ + + + Public variables and functions: + deep-merge-with lazy-get safe-get safe-get-in
+ +
+
+
+

math

+ by Mark Engelberg
+ Detailed API documentation
+
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 
+ + + + Public variables and functions: + abs ceil exact-integer-sqrt expt floor gcd lcm round sqrt
+ +
+
+
+

miglayout

+ by Stephen C. Gilardi
+ Detailed API documentation
+
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))
+ + + + Public variables and functions: + components miglayout
+
Variables and functions in + miglayout.example: + + converter-ui + + fahrenheit + + main + +
+

Variables and functions in + miglayout.internal: + + add-components + + component? + + constraint? + + do-layout + + format-constraint + + format-constraints + + get-components + + parse-component-constraint + + parse-item-constraints + +
+
+
+
+
+

mmap

+ by Chris Houser
+ Detailed API documentation
+
Functions for memory-mapping files, plus some functions that use a
+mmaped file for "normal" activies -- slurp, load-file, etc.
+ + + + Public variables and functions: + buffer-stream mmap slurp
+ +
+
+
+

mock

+ + Detailed API documentation
+

+  
+  
+  
+  Public variables and functions:
+  calls expect has-args has-matching-signature? make-arg-checker make-count-checker make-mock returns times validate-counts 
+
Variables and functions in + mock.test-adapter: + + calls + + has-args + + has-matching-signature? + + make-arg-checker + + make-count-checker + + make-mock + + report-problem + + returns + + times + + validate-counts + +
+
+
+
+
+

monadic-io-streams

+ by Konrad Hinsen
+ Detailed API documentation
+
Monadic I/O with Java input/output streams
+Defines monadic I/O statements to be used in a state monad
+with an input or output stream as the state. The macro
+monadic-io creates a stream, runs a monadic I/O statement
+on it, and closes the stream. This structure permits the
+definition of purely functional compound I/O statements
+which are applied to streams that can never escape from the
+monadic statement sequence.
+ + + + Public variables and functions: + flush print println read-char read-line read-lines skip-chars with-io-streams with-reader with-writer write
+ +
+
+
+

monads

+ by Konrad Hinsen
+ Detailed API documentation
+
This library contains the most commonly used monads as well
+as macros for defining and using monads and useful monadic
+functions.
+ + + See also: + + Monad tutorial part 1 + + Monad tutorial part 2 + + Monad tutorial part 3 + + Monad tutorial part 4 + + Monads in Clojure part 1 + + Monads in Clojure part 2 +
+
+ Public variables and functions: + call-cc cont-m defmonad defmonadfn domonad fetch-state fetch-val identity-m m-chain m-fmap m-join m-lift m-map m-reduce m-seq m-until m-when m-when-not maybe-m maybe-t monad monad-transformer run-cont sequence-m sequence-t set-m set-state set-val state-m state-m-until state-t update-state update-val with-monad with-state-field writer-m
+ +
+
+
+

ns-utils

+ by Stephen C. Gilardi
+ Detailed API documentation
+
Namespace utilities
+ + + + Public variables and functions: + dir docs get-ns immigrate ns-vars print-dir print-docs vars
+ +
+
+
+

pprint

+ by Tom Faulhaber
+ Detailed API documentation
+
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 Java-based format function.
+
+See documentation for those functions for more information or complete 
+documentation on the the clojure-contrib web site on github.
+
+As of the 1.2 release, pprint has been moved to clojure.pprint. Please prefer
+the clojure.pprint version for new code.
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + *code-dispatch* *print-base* *print-circle* *print-lines* *print-miser-width* *print-pprint-dispatch* *print-pretty* *print-radix* *print-right-margin* *print-shared* *print-suppress-namespaces* *simple-dispatch* cl-format compile-format formatter formatter-out fresh-line pp pprint pprint-indent pprint-logical-block pprint-newline pprint-tab set-pprint-dispatch use-method with-pprint-dispatch write write-out
+
Variables and functions in + pprint.examples.json: + + dispatch-json + + json-str + + print-json + +
+

Variables and functions in + pprint.examples.xml: + + *html-compatible* + + *prxml-indent* + + prxml + +
+
+
+
+
+

priority-map

+ + Detailed API documentation
+

+  
+  
+  
+  Public variables and functions:
+  priority-map priority-map-by 
+ +
+
+
+

probabilities.finite-distributions

+ by Konrad Hinsen
+ Detailed API documentation
+
Finite probability distributions
+This library defines a monad for combining finite probability
+distributions.
+ + + + Public variables and functions: + certainly choose cond-dist-m cond-prob dist-m join-with make-distribution normalize prob uniform zipf
+ +
+
+
+

probabilities.monte-carlo

+ by Konrad Hinsen
+ Detailed API documentation
+
Monte-Carlo method support
+
+Monte-Carlo methods transform an input random number stream
+(usually having a continuous uniform distribution in the
+interval [0, 1)) into a random number stream whose distribution
+satisfies certain conditions (usually the expectation value
+is equal to some desired quantity). They are thus
+transformations from one probability distribution to another one.
+
+This library represents a Monte-Carlo method by a function that
+takes as input the state of a random number stream with
+uniform distribution (see
+clojure.contrib.probabilities.random-numbers) and returns a
+vector containing one sample value of the desired output
+distribution and the final state of the input random number
+stream. Such functions are state monad values and can be
+composed using operations defined in clojure.contrib.monads.
+ + + + Public variables and functions: + discrete exponential lognormal n-sphere normal normal-box-muller random-stream reject sample sample-mean sample-mean-variance sample-reduce sample-sum
+ +
+
+
+

probabilities.random-numbers

+ by Konrad Hinsen
+ Detailed API documentation
+
Random number streams
+
+This library provides random number generators with a common
+stream interface. They all produce pseudo-random numbers that are
+uniformly distributed in the interval [0, 1), i.e. 0 is a
+possible value but 1 isn't. For transformations to other
+distributions, see clojure.contrib.probabilities.monte-carlo.
+
+At the moment, the only generator provided is a rather simple
+linear congruential generator.
+ + + + Public variables and functions: + lcg rand-stream
+ +
+
+
+

profile

+ by Stuart Sierra
+ Detailed API documentation
+
Simple code profiling & timing measurement.
+
+Wrap any section of code in the prof macro, giving it a name, like this:
+
+       (defn my-function [x y]
+         (let [sum (prof :addition (+ x y))
+               product (prof :multiplication (* x y))]
+           [sum product]))
+
+The run your code in the profile macro, like this:
+
+       (profile (dotimes [i 10000] (my-function 3 4)))
+
+Which prints a report for each named section of code:
+
+          Name      mean       min       max     count       sum
+      addition       265         0     37000     10000   2655000
+multiplication       274         0     53000     10000   2747000
+
+Times are measured in nanoseconds, to the maximum precision available
+under the JVM.  See the function documentation for more details.
+ + + + Public variables and functions: + *enable-profiling* print-summary prof profile summarize with-profile-data
+ +
+
+
+

properties

+ + Detailed API documentation
+

+  
+  Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + as-properties get-system-property read-properties set-system-properties with-system-properties write-properties
+ +
+
+
+

prxml

+ by Stuart Sierra
+ Detailed API documentation
+
Compact syntax for generating XML. See the documentation of "prxml" 
+for details.
+ + + + Public variables and functions: + *html-compatible* *prxml-indent* prxml
+ +
+
+
+

reflect

+ + Detailed API documentation
+

+  
+  
+  
+  Public variables and functions:
+  call-method get-field 
+ +
+
+
+

repl-ln

+ by Stephen C. Gilardi
+ Detailed API documentation
+
A repl with that provides support for lines and line numbers in the
+input stream.
+ + + + Public variables and functions: + print-repl-info repl repl-info repl-prompt set-repl-name set-repl-prompt stream-repl
+ +
+
+
+

repl-utils

+ by Chris Houser, Christophe Grand, Stephen Gilardi, Michel Salim
+ Detailed API documentation
+
Utilities meant to be used interactively at the REPL
+ + + + Public variables and functions: + *local-javadocs* *remote-javadocs* add-break-thread! add-local-javadoc add-remote-javadoc apropos break-threads expression-info find-javadoc-url get-source javadoc run run* show source start-handling-break
+ +
+
+
+

seq

+ by Stuart Sierra (and others)
+ Detailed API documentation
+
Sequence utilities for Clojure
+ + + + Public variables and functions: + fill-queue find-first flatten frequencies group-by includes? indexed partition-all partition-by positions rand-elt rec-cat rec-seq reductions rotations separate seq-on shuffle
+ +
+
+
+

seq-utils

+ by Stuart Sierra (and others)
+ Detailed API documentation
+
Sequence utilities for Clojure
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + fill-queue find-first flatten frequencies group-by includes? indexed partition-all partition-by positions rand-elt rec-cat rec-seq reductions rotations separate seq-on shuffle
+ +
+
+
+

server-socket

+ by Craig McDaniel
+ Detailed API documentation
+
Server socket library - includes REPL on socket
+ + + + Public variables and functions: + create-repl-server create-server
+ +
+
+
+

set

+ by Jason Wolfe
+ Detailed API documentation
+
Clojure functions for operating on sets (supplemental to clojure.set)
+ + + + Public variables and functions: + proper-subset? proper-superset? subset? superset?
+ +
+
+
+

shell

+ by Chris Houser
+ Detailed API documentation
+
Conveniently launch a sub-process providing to its stdin and
+collecting its stdout
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + sh
+ +
+
+
+

shell-out

+ by Chris Houser
+ Detailed API documentation
+
Conveniently launch a sub-process providing to its stdin and
+collecting its stdout
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + sh
+ +
+
+
+

singleton

+ by Stuart Sierra
+ Detailed API documentation
+
Singleton functions
+ + + + Public variables and functions: + global-singleton per-thread-singleton
+ +
+
+
+

sql

+ by Stephen C. Gilardi
+ Detailed API documentation
+
A Clojure interface to sql databases via jdbc.
+ + + See also: + + Example code +
+
+ Public variables and functions: + connection create-table delete-rows do-commands do-prepared drop-table find-connection insert-records insert-rows insert-values is-rollback-only set-rollback-only transaction update-or-insert-values update-values with-connection with-query-results
+
Variables and functions in + sql.internal: + + connection* + + find-connection* + + get-connection + + print-sql-exception + + print-sql-exception-chain + + print-update-counts + + rollback + + throw-rollback + + transaction* + + with-connection* + + with-query-results* + +
+
+
+
+
+

str-utils

+ by Stuart Sierra
+ Detailed API documentation
+
String utilities for Clojure
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + chomp chop re-gsub re-partition re-split re-sub str-join
+ +
+
+
+

str-utils2

+ by Stuart Sierra
+ Detailed API documentation
+
This is a library of string manipulation functions.  It
+is intented as a replacement for clojure.contrib.str-utils.
+
+You cannot (use 'clojure.contrib.str-utils2) because it defines
+functions with the same names as functions in clojure.core.
+Instead, do (require '[clojure.contrib.str-utils2 :as s]) 
+or something similar.
+
+Goals:
+  1. Be functional
+  2. String argument first, to work with ->
+  3. Performance linear in string length
+
+Some ideas are borrowed from
+http://github.com/francoisdevlin/devlinsf-clojure-utils/
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + blank? butlast capitalize chomp chop codepoints contains? dochars docodepoints drop escape get grep join lower-case ltrim map-str partial partition repeat replace replace-first reverse rtrim split split-lines swap-case tail take trim upper-case
+ +
+
+
+

stream-utils

+ by Konrad Hinsen
+ Detailed API documentation
+
Functions for setting up computational pipelines via data streams.
+
+NOTE: This library is experimental. It may change significantly
+      with future release.
+
+This library defines:
+- an abstract stream type, whose interface consists of the
+  multimethod stream-next
+- a macro for implementing streams
+- implementations of stream for
+  1) Clojure sequences, and vectors
+  2) nil, representing an empty stream
+- tools for writing stream transformers, including the
+  monad stream-m
+- various utility functions for working with streams
+
+Streams are building blocks in the construction of computational
+pipelines. A stream is represented by its current state plus
+a function that takes a stream state and obtains the next item
+in the stream as well as the new stream state. The state is
+implemented as a Java class or a Clojure type (as defined by the
+function clojure.core/type), and the function is provided as an
+implementation of the multimethod stream-next for this class or type.
+
+While setting up pipelines using this mechanism is somewhat more
+cumbersome than using Clojure's lazy seq mechanisms, there are a
+few advantages:
+- The state of a stream can be stored in any Clojure data structure,
+  and the stream can be re-generated from it any number of times.
+  Any number of states can be stored this way.
+- The elements of the stream are never cached, so keeping a reference
+  to a stream state does not incur an uncontrollable memory penalty.
+
+Note that the stream mechanism is thread-safe as long as the
+concrete stream implementations do not use any mutable state.
+
+Stream transformers take any number of input streams and produce one
+output stream. They are typically written using the stream-m
+monad. In the definition of a stream transformer, (pick s) returns
+the next value of stream argument s, whereas pick-all returns the
+next value of all stream arguments in the form of a vector.
+ + + + Public variables and functions: + defst defstream pick pick-all stream-drop stream-filter stream-flatten stream-m stream-map stream-next stream-seq stream-type
+ +
+
+
+

string

+ + Detailed API documentation
+

+  
+  
+  
+  Public variables and functions:
+  as-str blank? butlast capitalize chomp chop codepoints dochars docodepoints drop escape get grep join lower-case ltrim map-str partition repeat replace-by replace-char replace-first-by replace-first-re replace-first-str replace-re replace-str reverse rtrim split split-lines substring? swap-case tail take trim upper-case 
+ +
+
+
+

strint

+ by Chas Emerick
+ Detailed API documentation
+
String interpolation for Clojure.
+ + + + Public variables and functions: + <<
+ +
+
+
+

swing-utils

+ + Detailed API documentation
+

+  
+  
+  
+  Public variables and functions:
+  action-translation-table add-action-listener add-key-typed-listener add-menu-item do-swing do-swing* do-swing-and-wait make-action make-menubar menu-constructor-dispatch 
+ +
+
+
+

test-is

+ by Stuart Sierra
+ Detailed API documentation
+
Backwards-compatibility for clojure.contrib.test-is
+
+The clojure.contrib.test-is library moved from Contrib into the
+Clojure distribution as clojure.test.
+
+This happened on or around clojure-contrib Git commit
+82cf0409d0fcb71be477ebfc4da18ee2128a2ad1 on June 25, 2009.
+
+This file makes the clojure.test interface available under the old
+namespace clojure.contrib.test-is.
+
+This includes support for the old syntax of the 'are' macro.
+
+This was suggested by Howard Lewis Ship in ticket #26, 
+http://www.assembla.com/spaces/clojure-contrib/tickets/26
+ + Deprecated since clojure-contrib version 1.2
+ + Public variables and functions: + *load-tests* *stack-trace-depth* apply-template are assert-any assert-predicate compose-fixtures deftest deftest- do-template file-position find-holes find-pure-exprs find-symbols flatten-map function? get-possibly-unbound-var inc-report-counter is join-fixtures report run-all-tests run-tests set-test successful? template? test-all-vars test-ns test-var testing testing-contexts-str testing-vars-str try-expr use-fixtures with-test with-test-out
+ +
+
+
+

trace

+ by Stuart Sierra, Michel Salim
+ Detailed API documentation
+
This file defines simple "tracing" macros to help you see what your
+code is doing.
+ + + + Public variables and functions: + *trace-depth* deftrace dotrace trace trace-fn-call trace-indent tracer
+ +
+
+
+

types

+ by Konrad Hinsen
+ Detailed API documentation
+
General and algebraic data types
+ + + + Public variables and functions: + defadt deftype deftype- match
+ +
+
+
+

with-ns

+ by Stuart Sierra
+ Detailed API documentation
+
Temporary namespace macro
+ + + + Public variables and functions: + with-ns with-temp-ns
+ +
+
+
+

zip-filter

+ by Chris Houser
+ Detailed API documentation
+
System for filtering trees and nodes generated by zip.clj in
+general, and xml trees in particular.
+ + + + Public variables and functions: + ancestors children children-auto descendants left-locs leftmost? right-locs rightmost?
+
Variables and functions in + zip-filter.xml: + + attr + + attr= + + seq-test + + tag= + + text + + text= + + xml-> + + xml1-> + +
+
+
+
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/io-api.html b/branch-master/io-api.html new file mode 100644 index 00000000..66607a64 --- /dev/null +++ b/branch-master/io-api.html @@ -0,0 +1,553 @@ + + + io - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for io + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.io))
+
+

Overview

+
This file defines polymorphic I/O utility functions for Clojure.
+
+The Streams protocol defines reader, writer, input-stream and
+output-stream methods that return BufferedReader, BufferedWriter,
+BufferedInputStream and BufferedOutputStream instances (respectively),
+with default implementations extended to a variety of argument
+types: URLs or filenames as strings, java.io.File's, Sockets, etc.
+ + +
+

Public Variables and Functions

+
+
+
+

*append*

+ var
+

+  
If true, writer, output-stream and spit will open files in append mode.
+Defaults to false.  Instead of binding this var directly, use append-writer,
+append-output-stream or append-spit.
+ + + Source +
+
+
+

*buffer-size*

+ var
+

+  
Size, in bytes or characters, of the buffer used when
+copying streams.
+ + + Source +
+
+
+

*byte-array-type*

+ var
+

+  
Type object for a Java primitive byte array.
+ + + Source +
+
+
+

*char-array-type*

+ var
+

+  
Type object for a Java primitive char array.
+ + + Source +
+
+
+

*default-encoding*

+ var
+

+  
Name of the default encoding to use when reading & writing.
+Default is UTF-8.
+ + + Source +
+
+
+

append-output-stream

+ function
+
Usage: (append-output-stream x)
+
+
Like output-stream but opens file for appending.  Does not work on streams
+that are already open.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

append-spit

+ function
+
Usage: (append-spit f content)
+
+
Like spit but appends to file.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

append-writer

+ function
+
Usage: (append-writer x)
+
+
Like writer but opens file for appending.  Does not work on streams
+that are already open.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

as-url

+ function
+
Usage: (as-url arg)
+
+
Coerces argument (URL, URI, or String) to a java.net.URL.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

copy

+ function
+
Usage: (copy input output)
+
+
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.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

delete-file

+ function
+
Usage: (delete-file f & [silently])
+
+
Delete file f. Raise an exception if it fails unless silently is true.
+ + + Source +
+
+
+

delete-file-recursively

+ function
+
Usage: (delete-file-recursively f & [silently])
+
+
Delete file f. If it's a directory, recursively delete all its contents.
+Raise an exception if any deletion fails unless silently is true.
+ + + Source +
+
+
+

file

+ function
+
Usage: (file arg)
+       (file parent child)
+       (file parent child & more)
+
+
Returns a java.io.File from string or file args.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

file-str

+ function
+
Usage: (file-str & args)
+
+
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.
+ + + Source +
+
+
+

input-stream

+ function
+
Usage: (input-stream x)
+
+
Attempts to coerce its argument into an open java.io.InputStream.
+The default implementations of this protocol always return a
+java.io.BufferedInputStream.
+
+Default implementations are defined for OutputStream, File, URI, URL,
+Socket, byte array, and String arguments.
+
+If the 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 InputStream is properly
+closed.
+ + + +
+
+
+

make-parents

+ function
+
Usage: (make-parents file)
+
+
Creates all parent directories of file.
+ + + Source +
+
+
+

output-stream

+ function
+
Usage: (output-stream x)
+
+
Attempts to coerce its argument into an open java.io.OutputStream.
+The default implementations of this protocol always return a
+java.io.BufferedOutputStream.
+
+Default implementations are defined for OutputStream, File, URI, URL,
+Socket, and String arguments.
+
+If the 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 OutputStream is
+properly closed.
+ + + +
+
+
+

pwd

+ function
+
Usage: (pwd)
+
+
Returns current working directory as a String.  (Like UNIX 'pwd'.)
+Note: In Java, you cannot change the current working directory.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

read-lines

+ function
+
Usage: (read-lines f)
+
+
Like clojure.core/line-seq but opens f with reader.  Automatically
+closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE.
+ + + Source +
+
+
+

reader

+ function
+
Usage: (reader x)
+
+
Attempts to coerce its argument into an open java.io.Reader.
+The default implementations of this protocol always return a
+java.io.BufferedReader.
+
+Default implementations are provided for Reader, BufferedReader,
+InputStream, File, URI, URL, Socket, byte arrays, character arrays,
+and 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.  If this fails, a final attempt is made to resolve
+the string as a resource on the CLASSPATH.
+
+Uses *default-encoding* as the text encoding.
+
+Should be used inside with-open to ensure the Reader is properly
+closed.
+ + + +
+
+
+

relative-path-string

+ multimethod
+
No usage documentation available
+
Interpret a String or java.io.File as a relative path string. 
+Building block for clojure.contrib.java/file.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

slurp*

+ function
+
Usage: (slurp* f)
+
+
Like clojure.core/slurp but opens f with reader.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

spit

+ function
+
Usage: (spit f content)
+
+
Opposite of slurp.  Opens f with writer, writes content, then
+closes f.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

to-byte-array

+ function
+
Usage: (to-byte-array arg)
+
+
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.
+ + + Source +
+
+
+

with-in-reader

+ macro
+
Usage: (with-in-reader f & body)
+
+
Opens a PushbackReader on f, binds it to *in*, and evaluates body.
+ + + Source +
+
+
+

with-out-append-writer

+ macro
+
Usage: (with-out-append-writer f & body)
+
+
Like with-out-writer but appends to file.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

with-out-writer

+ macro
+
Usage: (with-out-writer f & body)
+
+
Opens a writer on f, binds it to *out*, and evalutes body.
+Anything printed within body will be written to f.
+ + + Source +
+
+
+

write-lines

+ function
+
Usage: (write-lines f lines)
+
+
Writes lines (a seq) to f, separated by newlines.  f is opened with
+writer, and automatically closed at the end of the sequence.
+ + + Source +
+
+
+

writer

+ function
+
Usage: (writer x)
+
+
Attempts to coerce its argument into an open java.io.Writer.
+The default implementations of this protocol always return a
+java.io.BufferedWriter.
+
+Default implementations are provided for Writer, BufferedWriter,
+OutputStream, File, URI, URL, Socket, and String.
+
+If the 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.
+ + + +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/jar-api.html b/branch-master/jar-api.html new file mode 100644 index 00000000..2b6735d7 --- /dev/null +++ b/branch-master/jar-api.html @@ -0,0 +1,125 @@ + + + jar - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for jar + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.jar))
+
+

Overview

+
Utilities for working with Java JAR files
+ + +
+

Public Variables and Functions

+
+
+
+

filenames-in-jar

+ function
+
Usage: (filenames-in-jar jar-file)
+
+
Returns a sequence of Strings naming the non-directory entries in
+the JAR file.
+ + + Source +
+
+
+

jar-file?

+ function
+
Usage: (jar-file? file)
+
+
Returns true if file is a normal file with a .jar or .JAR extension.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/java-utils-api.html b/branch-master/java-utils-api.html new file mode 100644 index 00000000..0d2adebc --- /dev/null +++ b/branch-master/java-utils-api.html @@ -0,0 +1,346 @@ + + + java-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for java-utils + - clojure-contrib next (in development) +

+by Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard, Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.java-utils))
+
+

Overview

+
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.
+Contributors:
+
+Stuart Halloway
+Stephen C. Gilardi
+Shawn Hoover
+Perry Trolard
+Stuart Sierra
+ + +
+

Public Variables and Functions

+
+
+
+

as-file

+ multimethod
+
No usage documentation available
+
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.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

as-properties

+ function
+
Usage: (as-properties m)
+
+
Convert any seq of pairs to a java.utils.Properties instance.
+Uses as-str to convert both keys and values into strings.
+ + + Source +
+
+
+

as-str

+ function
+
Usage: (as-str)
+       (as-str x)
+       (as-str x & ys)
+
+
Like clojure.core/str, but if an argument is a keyword or symbol,
+its name will be used instead of its literal representation.
+
+Example:
+   (str :foo :bar)     ;;=> ":foo:bar"
+   (as-str :foo :bar)  ;;=> "foobar" 
+
+Note that this does not apply to keywords or symbols nested within
+data structures; they will be rendered as with str.
+
+Example:
+   (str {:foo :bar})     ;;=> "{:foo :bar}"
+   (as-str {:foo :bar})  ;;=> "{:foo :bar}" 
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

as-url

+ multimethod
+
Usage: (as-url arg)
+
+
Coerces argument (URL, URI, or String) to a java.net.URL.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

delete-file

+ function
+
Usage: (delete-file f & [silently])
+
+
Delete file f. Raise an exception if it fails unless silently is true.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

delete-file-recursively

+ function
+
Usage: (delete-file-recursively f & [silently])
+
+
Delete file f. If it's a directory, recursively delete all its contents.
+Raise an exception if any deletion fails unless silently is true.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

file

+ function
+
Usage: (file arg)
+       (file parent child)
+       (file parent child & more)
+
+
Returns a java.io.File from string or file args.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

get-system-property

+ function
+
Usage: (get-system-property stringable)
+       (get-system-property stringable default)
+
+
Get a system property.
+ + + Source +
+
+
+

read-properties

+ function
+
Usage: (read-properties file-able)
+
+
Read properties from file-able.
+ + + Source +
+
+
+

relative-path-string

+ multimethod
+
No usage documentation available
+
Interpret a String or java.io.File as a relative path string. 
+Building block for clojure.contrib.java-utils/file.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

set-system-properties

+ function
+
Usage: (set-system-properties settings)
+
+
Set some system properties. Nil clears a property.
+ + + Source +
+
+
+

wall-hack-field

+ function
+
Usage: (wall-hack-field class-name field-name obj)
+
+
Access to private or protected field.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

wall-hack-method

+ function
+
Usage: (wall-hack-method class-name method-name params obj & args)
+
+
Calls a private or protected method.
+params is a vector of class which correspond to the arguments to the method
+obj is nil for static methods, the instance object otherwise
+the method name is given as a symbol or a keyword (something Named)
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

with-system-properties

+ macro
+
Usage: (with-system-properties settings & body)
+
+
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.
+ + + Source +
+
+
+

write-properties

+ function
+
Usage: (write-properties m file-able)
+       (write-properties m file-able comments)
+
+
Write properties to file-able.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/javadoc.browse-api.html b/branch-master/javadoc.browse-api.html new file mode 100644 index 00000000..9038a8e8 --- /dev/null +++ b/branch-master/javadoc.browse-api.html @@ -0,0 +1,126 @@ + + + javadoc.browse - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for javadoc.browse + - clojure-contrib next (in development) +

+by Christophe Grand
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.javadoc.browse))
+
+

Overview

+
Start a web browser from Clojure
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

open-url-in-browser

+ function
+
Usage: (open-url-in-browser url)
+
+
Opens url (a string) in the default system web browser.  May not
+work on all platforms.  Returns url on success, nil if not
+supported.
+ + + Source +
+
+
+

open-url-in-swing

+ function
+
Usage: (open-url-in-swing url)
+
+
Opens url (a string) in a Swing window.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/jmx-api.html b/branch-master/jmx-api.html new file mode 100644 index 00000000..2488dade --- /dev/null +++ b/branch-master/jmx-api.html @@ -0,0 +1,455 @@ + + + jmx - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for jmx + - clojure-contrib next (in development) +

+by Stuart Halloway
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.jmx))
+
+

Overview

+
JMX support for Clojure
+
+Requires post-Clojure 1.0 git edge for clojure.test, clojure.backtrace.
+This is prerelease.
+This API will change.
+Send reports to stu@thinkrelevance.com.
+
+Usage
+  (require '[clojure.contrib.jmx :as jmx])
+
+What beans do I have?
+
+  (jmx/mbean-names "*:*")
+  -> #<HashSet [java.lang:type=MemoryPool,name=CMS Old Gen, 
+                java.lang:type=Memory, ...]
+
+What attributes does a bean have?
+
+  (jmx/attribute-names "java.lang:type=Memory")
+  -> (:Verbose :ObjectPendingFinalizationCount 
+      :HeapMemoryUsage :NonHeapMemoryUsage)
+
+What is the value of an attribute? 
+
+  (jmx/read "java.lang:type=Memory" :ObjectPendingFinalizationCount)
+  -> 0
+
+Can't I just have *all* the attributes in a Clojure map?
+
+  (jmx/mbean "java.lang:type=Memory")
+  -> {:NonHeapMemoryUsage
+       {:used 16674024, :max 138412032, :init 24317952, :committed 24317952},
+      :HeapMemoryUsage
+       {:used 18619064, :max 85393408, :init 0, :committed 83230720},
+      :ObjectPendingFinalizationCount 0,
+      :Verbose false}
+
+Can I find and invoke an operation?
+
+  (jmx/operation-names "java.lang:type=Memory")
+  -> (:gc)  
+  (jmx/invoke "java.lang:type=Memory" :gc)
+  -> nil
+
+What about some other process? Just run *any* of the above code
+inside a with-connection:
+
+  (jmx/with-connection {:host "localhost", :port 3000} 
+    (jmx/mbean "java.lang:type=Memory"))
+  -> {:ObjectPendingFinalizationCount 0, 
+      :HeapMemoryUsage ... etc.}
+
+Can I serve my own beans?  Sure, just drop a Clojure ref
+into an instance of clojure.contrib.jmx.Bean, and the bean
+will expose read-only attributes for every key/value pair
+in the ref:
+
+  (jmx/register-mbean
+     (Bean.
+     (ref {:string-attribute "a-string"}))
+     "my.namespace:name=Value")
+ + +
+

Public Variables and Functions

+
+
+
+

*connection*

+ var
+

+  
The connection to be used for JMX ops. Defaults to the local process.
+ + + Source +
+
+
+

as-object-name

+ multimethod
+
Usage: (as-object-name string-or-name)
+
+
Interpret an object as a JMX ObjectName.
+ + + Source +
+
+
+

attribute-info

+ function
+
Usage: (attribute-info object-name attr-name)
+
+
Get the MBeanAttributeInfo for an attribute.
+ + + Source +
+
+
+

attribute-names

+ function
+
Usage: (attribute-names n)
+
+
All attribute names available on an MBean.
+ + + Source +
+
+
+

build-attribute-info

+ function
+
Usage: (build-attribute-info attr-name attr-value)
+       (build-attribute-info name type desc readable? writable? is?)
+
+
Construct an MBeanAttributeInfo. Normally called with a key/value pair from a Clojure map.
+ + + Source +
+
+
+

guess-attribute-typename

+ function
+
Usage: (guess-attribute-typename value)
+
+
Guess the attribute typename for MBeanAttributeInfo based on the attribute value.
+ + + Source +
+
+
+

jmx->clj

+ multimethod
+
No usage documentation available
+
Coerce JMX data structures into Clojure data.
+Handles CompositeData, TabularData, maps, and atoms.
+ + + Source +
+
+
+

jmx-url

+ function
+
Usage: (jmx-url)
+       (jmx-url overrides)
+
+
Build a JMX URL from options.
+ + + Source +
+
+
+

map->attribute-infos

+ function
+
Usage: (map->attribute-infos attr-map)
+
+
Construct an MBeanAttributeInfo[] from a Clojure associative.
+ + + Source +
+
+
+

maybe-atomize

+ function
+
Usage: (maybe-atomize k)
+
+
Convert a list of length 1 into its contents, leaving other things alone.
+Used to simplify keys in the tabular data API.
+ + + Source +
+
+
+

maybe-keywordize

+ function
+
Usage: (maybe-keywordize s)
+
+
Convert a string key to a keyword, leaving other types alone. Used to
+simplify keys in the tabular data API.
+ + + Source +
+
+
+

mbean

+ function
+
Usage: (mbean n)
+
+
Like clojure.core/bean, but for JMX beans. Returns a read-only map of
+a JMX bean's attributes. If an attribute it not supported, value is
+set to the exception thrown.
+ + + Source +
+
+
+

mbean-names

+ function
+
Usage: (mbean-names n)
+
+
Finds all MBeans matching a name on the current *connection*.
+ + + Source +
+
+
+

op-param-types

+ function
+
Usage: (op-param-types n op)
+
+
The parameter types (as class name strings) for operation op on n.
+Used for invoke.
+ + + Source +
+
+
+

operation

+ function
+
Usage: (operation n op)
+
+
The MBeanOperationInfo for operation op on mbean n. Used by invoke.
+ + + Source +
+
+
+

operation-names

+ function
+
Usage: (operation-names n)
+
+
All operation names available on an MBean.
+ + + Source +
+
+
+

operations

+ function
+
Usage: (operations n)
+
+
All oeprations available on an MBean.
+ + + Source +
+
+
+

raw-read

+ function
+
Usage: (raw-read n attr)
+
+
Read an mbean property. Returns low-level Java object model for
+composites, tabulars, etc. Most callers should use read.
+ + + Source +
+
+
+

read

+ var
+

+  
Read an mbean property.
+ + + Source +
+
+
+

read-supported

+ function
+
Usage: (read-supported n attr)
+
+
Calls read to read an mbean property, *returning* unsupported
+operation exceptions instead of throwing them. Used to keep mbean
+from blowing up. Note: There is no good exception that aggregates
+unsupported operations, hence the overly-general catch block.
+ + + Source +
+
+
+

readable?

+ function
+
Usage: (readable? n attr)
+
+
Is attribute readable?
+ + + Source +
+
+
+

with-connection

+ macro
+
Usage: (with-connection opts & body)
+
+
Execute body with JMX connection specified by opts. opts can also
+include an optional :environment key which is passed as the
+environment arg to JMXConnectorFactory/connect.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/json-api.html b/branch-master/json-api.html new file mode 100644 index 00000000..63124264 --- /dev/null +++ b/branch-master/json-api.html @@ -0,0 +1,187 @@ + + + json - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for json + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.json))
+
+

Overview

+
JavaScript Object Notation (JSON) parser/writer.
+See http://www.json.org/
+To write JSON, use json-str, write-json, or write-json.
+To read JSON, use read-json.
+ + +
+

Public Variables and Functions

+
+
+
+

json-str

+ function
+
Usage: (json-str x)
+
+
Converts x to a JSON-formatted string.
+ + + Source +
+
+
+

pprint-json

+ function
+
Usage: (pprint-json x)
+
+
Pretty-prints JSON representation of x to *out*
+ + + Source +
+
+
+

print-json

+ function
+
Usage: (print-json x)
+
+
Write JSON-formatted output to *out*
+ + + Source +
+
+
+

read-json

+ function
+
Usage: (read-json input)
+       (read-json input keywordize?)
+       (read-json input keywordize? eof-error? eof-value)
+
+
Reads one JSON value from input String or Reader.
+If keywordize? is true (default), object keys will be converted to
+keywords.  If eof-error? is true (default), empty input will throw
+an EOFException; if false EOF will return eof-value. 
+ + + Source +
+
+
+

read-json-from

+ function
+
Usage: (read-json-from input keywordize? eof-error? eof-value)
+
+
Reads one JSON value from input String or Reader.
+If keywordize? is true, object keys will be converted to keywords.
+If eof-error? is true, empty input will throw an EOFException; if
+false EOF will return eof-value. 
+ + + +
+
+
+

write-json

+ function
+
Usage: (write-json object out)
+
+
Print object to PrintWriter out as JSON
+ + + +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/lazy-seqs-api.html b/branch-master/lazy-seqs-api.html new file mode 100644 index 00000000..e670a877 --- /dev/null +++ b/branch-master/lazy-seqs-api.html @@ -0,0 +1,156 @@ + + + lazy-seqs - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for lazy-seqs + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.lazy-seqs))
+
+

Overview

+
+==== 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 ====
+
+ (partition-all, shuffle moved to clojure.core)
+ (rand-elt moved to clojure.core/rand-nth)
+ (rotations, 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
+ + +
+

Public Variables and Functions

+
+
+
+

fibs

+ function
+
Usage: (fibs)
+
+
Returns a lazy sequence of all the Fibonacci numbers.
+ + + Source +
+
+
+

powers-of-2

+ function
+
Usage: (powers-of-2)
+
+
Returns a lazy sequence of all the powers of 2
+ + + Source +
+
+
+

primes

+ var
+

+  
Lazy sequence of all the prime numbers.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/lazy-xml-api.html b/branch-master/lazy-xml-api.html new file mode 100644 index 00000000..0b8101f4 --- /dev/null +++ b/branch-master/lazy-xml-api.html @@ -0,0 +1,147 @@ + + + lazy-xml - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for lazy-xml + - clojure-contrib next (in development) +

+by Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.lazy-xml))
+
+

Overview

+
Functions to parse xml lazily and emit back to text.
+ + +
+

Public Variables and Functions

+
+
+
+

parse-seq

+ function
+
Usage: (parse-seq s)
+       (parse-seq s startparse)
+       (parse-seq s startparse queue-size)
+
+
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 maxint.  If no parser
+is specified and org.xmlpull.v1.XmlPullParser is in the classpath,
+this superior pull parser will be used.
+ + + Source +
+
+
+

parse-trim

+ function
+
Usage: (parse-trim s)
+       (parse-trim s startparse queue-size)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/logging-api.html b/branch-master/logging-api.html new file mode 100644 index 00000000..19d4d1d6 --- /dev/null +++ b/branch-master/logging-api.html @@ -0,0 +1,394 @@ + + + logging - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for logging + - clojure-contrib next (in development) +

+by Alex Taggart, Timothy Pratley
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.logging))
+
+

Overview

+
Logging macros which delegate to a specific logging implementation. At
+runtime a specific implementation is selected from, in order, Apache
+commons-logging, log4j, and finally java.util.logging.
+
+Logging levels are specified by clojure keywords corresponding to the
+values used in log4j and commons-logging:
+  :trace, :debug, :info, :warn, :error, :fatal
+
+Logging occurs with the log macro, or the level-specific convenience macros,
+which write either directly or via an agent.  For performance reasons, direct
+logging is enabled by default, but setting the *allow-direct-logging* boolean
+atom to false will disable it. If logging is invoked within a transaction it
+will always use an agent.
+
+The log macros will not evaluate their 'message' unless the specific logging
+level is in effect. Alternately, you can use the spy macro when you have code
+that needs to be evaluated, and also want to output the code and its result to
+the debug log.
+
+Unless otherwise specified, the current namespace (as identified by *ns*) will
+be used as the log-ns (similar to how the java class name is usually used).
+Note: your log configuration should display the name that was passed to the
+logging implementation, and not perform stack-inspection, otherwise you'll see
+something like "fn__72$impl_write_BANG__39__auto____81" in your logs.
+
+Use the enabled? macro to write conditional code against the logging level
+(beyond simply whether or not to call log, which is handled automatically).
+
+You can redirect all java writes of System.out and System.err to the log
+system by calling log-capture!.  To rebind *out* and *err* to the log system
+invoke with-logs.  In both cases a log-ns (e.g., "com.example.captured")
+needs to be specified to namespace the output.
+ + +
+

Public Variables and Functions

+
+
+
+

*allow-direct-logging*

+ var
+

+  
A boolean indicating whether direct logging (as opposed to via an agent) is
+allowed when not operating from within a transaction. Defaults to true.
+ + + Source +
+
+
+

*impl-name*

+ var
+

+  
The name of the logging implementation used.
+ + + Source +
+
+
+

*logging-agent*

+ var
+

+  
The default agent used for performing logging durng a transaction or when
+direct logging is disabled.
+ + + Source +
+
+
+

debug

+ macro
+
Usage: (debug message)
+       (debug message throwable)
+
+
Logs a message at the debug level.
+ + + Source +
+
+
+

enabled?

+ macro
+
Usage: (enabled? level)
+       (enabled? level log-ns)
+
+
Returns true if the specific logging level is enabled.  Use of this function
+should only be necessary if one needs to execute alternate code paths beyond
+whether the log should be written to.
+ + + Source +
+
+
+

error

+ macro
+
Usage: (error message)
+       (error message throwable)
+
+
Logs a message at the error level.
+ + + Source +
+
+
+

fatal

+ macro
+
Usage: (fatal message)
+       (fatal message throwable)
+
+
Logs a message at the fatal level.
+ + + Source +
+
+
+

impl-enabled?

+ var
+

+  
Implementation-specific check if a particular level is enabled. End-users
+should not need to call this.
+ + + Source +
+
+
+

impl-get-log

+ var
+

+  
Returns an implementation-specific log by string namespace. End-users should
+not need to call this.
+ + + Source +
+
+
+

impl-write!

+ var
+

+  
Implementation-specific write of a log message. End-users should not need to
+call this.
+ + + Source +
+
+
+

info

+ macro
+
Usage: (info message)
+       (info message throwable)
+
+
Logs a message at the info level.
+ + + Source +
+
+
+

log

+ macro
+
Usage: (log level message)
+       (log level message throwable)
+       (log level message throwable log-ns)
+
+
Logs a message, either directly or via an agent. Also see the level-specific
+convenience macros.
+ + + Source +
+
+
+

log-capture!

+ function
+
Usage: (log-capture! log-ns)
+
+
Captures System.out and System.err, redirecting all writes of those streams
+to :info and :error logging, respectively. The specified log-ns value will
+be used to namespace all redirected logging. NOTE: this will not redirect
+output of *out* or *err*; for that, use with-logs.
+ + + Source +
+
+
+

log-stream

+ function
+
Usage: (log-stream level log-ns)
+
+
Creates a PrintStream that will output to the log. End-users should not need
+to invoke this.
+ + + Source +
+
+
+

log-uncapture!

+ function
+
Usage: (log-uncapture!)
+
+
Restores System.out and System.err to their original values.
+ + + Source +
+
+
+

spy

+ macro
+
Usage: (spy expr)
+
+
Evaluates expr and outputs the form and its result to the debug log; returns 
+the result of expr.
+ + + Source +
+
+
+

trace

+ macro
+
Usage: (trace message)
+       (trace message throwable)
+
+
Logs a message at the trace level.
+ + + Source +
+
+
+

warn

+ macro
+
Usage: (warn message)
+       (warn message throwable)
+
+
Logs a message at the warn level.
+ + + Source +
+
+
+

with-logs

+ macro
+
Usage: (with-logs log-ns & body)
+
+
Evaluates exprs in a context in which *out* and *err* are bound to :info and
+:error logging, respectively. The specified log-ns value will be used to
+namespace all redirected logging.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/macro-utils-api.html b/branch-master/macro-utils-api.html new file mode 100644 index 00000000..ec086aeb --- /dev/null +++ b/branch-master/macro-utils-api.html @@ -0,0 +1,219 @@ + + + macro-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for macro-utils + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.macro-utils))
+
+

Overview

+
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.
+ + +
+

Public Variables and Functions

+
+
+
+

defsymbolmacro

+ macro
+
Usage: (defsymbolmacro symbol expansion)
+
+
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.
+ + + Source +
+
+
+

deftemplate

+ macro
+
Usage: (deftemplate name params & forms)
+
+
Define a macro that expands into forms after replacing the
+symbols in params (a vector) by the corresponding parameters
+given in the macro call.
+ + + Source +
+
+
+

macrolet

+ macro
+
Usage: (macrolet fn-bindings & exprs)
+
+
Define local macros that are used in the expansion of exprs. The
+syntax is the same as for letfn forms.
+ + + Source +
+
+
+

mexpand

+ function
+
Usage: (mexpand form)
+
+
Like clojure.core/macroexpand, but takes into account symbol macros.
+ + + Source +
+
+
+

mexpand-1

+ function
+
Usage: (mexpand-1 form)
+
+
Like clojure.core/macroexpand-1, but takes into account symbol macros.
+ + + Source +
+
+
+

mexpand-all

+ function
+
Usage: (mexpand-all form)
+
+
Perform a full recursive macro expansion of a form.
+ + + Source +
+
+
+

symbol-macrolet

+ macro
+
Usage: (symbol-macrolet symbol-bindings & exprs)
+
+
Define local symbol macros that are used in the expansion of exprs.
+The syntax is the same as for let forms.
+ + + Source +
+
+
+

with-symbol-macros

+ macro
+
Usage: (with-symbol-macros & exprs)
+
+
Fully expand exprs, including symbol macros.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/macros-api.html b/branch-master/macros-api.html new file mode 100644 index 00000000..1e5aafb8 --- /dev/null +++ b/branch-master/macros-api.html @@ -0,0 +1,147 @@ + + + macros - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for macros + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.macros))
+
+

Overview

+
Various small macros
+ + +
+

Public Variables and Functions

+
+
+
+

const

+ macro
+
Usage: (const expr)
+
+
Evaluate the constant expression expr at compile time.
+ + + Source +
+
+
+

letfn-

+ macro
+
Usage: (letfn- fn-bindings & exprs)
+
+
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)] ...).
+ + + Source +
+
+
+

with-direct-linking

+ macro
+
Usage: (with-direct-linking symbols? & body)
+
+
EXPERIMENTAL!
+Compiles the functions in body with direct links to the functions
+named in symbols, i.e. without a var lookup for each invocation.
+Symbols is a vector of symbols that name either vars or namespaces.
+A namespace reference is replaced by the list of all symbols in the
+namespace that are bound to functions. If symbols is not provided,
+the default value ['clojure.core] is used. The symbol *ns* can be
+used to refer to the current namespace.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/map-utils-api.html b/branch-master/map-utils-api.html new file mode 100644 index 00000000..ba69aff7 --- /dev/null +++ b/branch-master/map-utils-api.html @@ -0,0 +1,155 @@ + + + map-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for map-utils + - clojure-contrib next (in development) +

+by Jason Wolfe, Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.map-utils))
+
+

Overview

+
Utilities for operating on Clojure maps.
+ + +
+

Public Variables and Functions

+
+
+
+

deep-merge-with

+ function
+
Usage: (deep-merge-with f & maps)
+
+
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}
+ + + Source +
+
+
+

lazy-get

+ macro
+
Usage: (lazy-get map key not-found)
+
+
Like get, but doesn't evaluate not-found unless it is needed.
+ + + Source +
+
+
+

safe-get

+ function
+
Usage: (safe-get map key)
+
+
Like get, but throws an exception if the key is not found.
+ + + Source +
+
+
+

safe-get-in

+ function
+
Usage: (safe-get-in map ks)
+
+
Like get-in, but throws an exception if any key is not found.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/math-api.html b/branch-master/math-api.html new file mode 100644 index 00000000..8bf38ef5 --- /dev/null +++ b/branch-master/math-api.html @@ -0,0 +1,260 @@ + + + math - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for math + - clojure-contrib next (in development) +

+by Mark Engelberg
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.math))
+
+

Overview

+
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 
+ + +
+

Public Variables and Functions

+
+
+
+

abs

+ function
+
Usage: (abs n)
+
+
(abs n) is the absolute value of n
+ + + Source +
+
+
+

ceil

+ multimethod
+
Usage: (ceil n)
+
+
(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.
+ + + Source +
+
+
+

exact-integer-sqrt

+ function
+
Usage: (exact-integer-sqrt n)
+
+
(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.
+ + + Source +
+
+
+

expt

+ multimethod
+
Usage: (expt base pow)
+
+
(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.
+ + + Source +
+
+
+

floor

+ multimethod
+
Usage: (floor n)
+
+
(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.
+ + + Source +
+
+
+

gcd

+ function
+
Usage: (gcd a b)
+
+
(gcd a b) returns the greatest common divisor of a and b
+ + + Source +
+
+
+

lcm

+ function
+
Usage: (lcm a b)
+
+
(lcm a b) returns the least common multiple of a and b
+ + + Source +
+
+
+

round

+ multimethod
+
Usage: (round n)
+
+
(round n) rounds to the nearest integer.
+round always returns an integer.  Rounds up for values exactly in between two integers.
+ + + Source +
+
+
+

sqrt

+ multimethod
+
Usage: (sqrt n)
+
+
Square root, but returns exact number if possible.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/miglayout-api.html b/branch-master/miglayout-api.html new file mode 100644 index 00000000..cacab628 --- /dev/null +++ b/branch-master/miglayout-api.html @@ -0,0 +1,333 @@ + + + miglayout - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for miglayout + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.miglayout))
+
+

Overview

+
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))
+ + +
+

Public Variables and Functions

+
+
+
+

components

+ function
+
Usage: (components container)
+
+
Returns a map from id (a keyword) to component for all components with
+an id constraint set
+ + + Source +
+
+
+

miglayout

+ function
+
Usage: (miglayout container & args)
+
+
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.
+ + + Source +
+

miglayout.example

+

+
+
+
+
+
+

converter-ui

+ function
+
Usage: (converter-ui)
+
+
Lays out and shows a Temperature Converter UI
+ + + Source +
+
+

fahrenheit

+ function
+
Usage: (fahrenheit celsius)
+
+
Converts a Celsius temperature to Fahrenheit. Input and output are
+strings. Returns "input?" if the input can't be parsed as a Double.
+ + + Source +
+
+

main

+ function
+
Usage: (main)
+
+
Invokes converter-ui in the AWT Event thread
+ + + Source +
+

miglayout.internal

+

+
+
+
+
+
+

add-components

+ function
+
Usage: (add-components container components)
+
+
Adds components with constraints to a container
+ + + Source +
+
+

component?

+ function
+
Usage: (component? x)
+
+
Returns true if x is a java.awt.Component
+ + + Source +
+
+

constraint?

+ function
+
Usage: (constraint? x)
+
+
Returns true if x is not a keyword-item or component
+ + + Source +
+
+

do-layout

+ function
+
Usage: (do-layout container layout column row components)
+
+
Attaches a MigLayout layout manager to container and adds components
+with constraints
+ + + Source +
+
+

format-constraint

+ function
+
Usage: (format-constraint c)
+
+
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.
+ + + Source +
+
+

format-constraints

+ function
+
Usage: (format-constraints & constraints)
+
+
Returns a string representing all the constraints for one keyword-item
+or component formatted for miglayout.
+ + + Source +
+
+

get-components

+ function
+
Usage: (get-components container)
+
+
Returns a map from id to component for all components with an id
+ + + Source +
+
+

parse-component-constraint

+ function
+
Usage: (parse-component-constraint constraint)
+
+
Parses a component constraint string returning a CC object
+ + + Source +
+
+

parse-item-constraints

+ function
+
Usage: (parse-item-constraints & args)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/mmap-api.html b/branch-master/mmap-api.html new file mode 100644 index 00000000..539486fc --- /dev/null +++ b/branch-master/mmap-api.html @@ -0,0 +1,138 @@ + + + mmap - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for mmap + - clojure-contrib next (in development) +

+by Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.mmap))
+
+

Overview

+
Functions for memory-mapping files, plus some functions that use a
+mmaped file for "normal" activies -- slurp, load-file, etc.
+ + +
+

Public Variables and Functions

+
+
+
+

buffer-stream

+ function
+
Usage: (buffer-stream buf)
+
+
Returns an InputStream for a ByteBuffer, such as returned by mmap.
+ + + Source +
+
+
+

mmap

+ function
+
Usage: (mmap f)
+
+
Memory-map the file named f.  Returns a ByteBuffer.
+ + + Source +
+
+
+

slurp

+ function
+
Usage: (slurp f)
+
+
Reads the file named by f and returns it as a string.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/mock-api.html b/branch-master/mock-api.html new file mode 100644 index 00000000..551de504 --- /dev/null +++ b/branch-master/mock-api.html @@ -0,0 +1,454 @@ + + + mock - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for mock + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.mock))
+
+

Overview

+

+
+
+
+

Public Variables and Functions

+
+
+
+

calls

+ function
+
Usage: (calls val)
+       (calls val expectation-hash)
+
+
Creates or associates to an existing expectation hash the :calls key with a
+function that will be called with the given arguments. The return value from
+this function will be returned returned by the expected function. If both this
+and returns are specified, the return value of "calls" will have precedence.
+Usage:
+(calls some-fn expectation-hash?)
+ + + Source +
+
+
+

expect

+ macro
+
Usage: (expect expect-bindings & body)
+
+
Use expect to redirect calls to dependent functions that are made within the
+code under test. Instead of calling the functions that would normally be used,
+temporary stubs are used, which can verify function parameters and call counts.
+Return values can also be specified as needed.
+Usage:
+(expect [dep-fn (has-args [arg-pred1] (times n (returns x)))]
+  (function-under-test a b c))
+ + + Source +
+
+
+

has-args

+ macro
+
Usage: (has-args arg-pred-forms)
+       (has-args arg-pred-forms expect-hash-form)
+
+
Creates or associates to an existing expectation hash the :has-args key with
+a value corresponding to a function that will either return true if its
+argument expectations are met or throw an exception with the details of the
+first failed argument it encounters.
+Only specify as many predicates as you are interested in verifying. The rest
+of the values are safely ignored.
+Usage:
+(has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?)
+ + + Source +
+
+
+

has-matching-signature?

+ function
+
Usage: (has-matching-signature? fn-name args)
+
+
Calls no-matching-function-signature if no match is found for the given
+function. If no argslist meta data is available for the function, it is
+not called.
+ + + Source +
+
+
+

make-arg-checker

+ function
+
Usage: (make-arg-checker arg-preds arg-pred-forms)
+
+
Creates the argument verifying function for a replaced dependency within
+the expectation bound scope. These functions take the additional argument
+of the name of the replaced function, then the rest of their args. It is
+designed to be called from the mock function generated in the first argument
+of the mock info object created by make-mock.
+ + + Source +
+
+
+

make-count-checker

+ function
+
Usage: (make-count-checker pred pred-form)
+
+
creates the count checker that is invoked at the end of an expectation, after
+the code under test has all been executed. The function returned takes the
+name of the associated dependency and the invocation count as arguments.
+ + + Source +
+
+
+

make-mock

+ function
+
Usage: (make-mock fn-name expectation-hash)
+
+
creates a vector containing the following information for the named function:
+1. dependent function replacement - verifies signature, calls arg checker,
+increases count, returns return value.
+2. an atom containing the invocation count
+3. the invocation count checker function
+4. a symbol of the name of the function being replaced.
+ + + Source +
+
+
+

returns

+ function
+
Usage: (returns val)
+       (returns val expectation-hash)
+
+
Creates or associates to an existing expectation hash the :returns key with
+a value to be returned by the expectation after a successful invocation
+matching its expected arguments (if applicable).
+Usage:
+(returns ret-value expectation-hash?)
+ + + Source +
+
+
+

times

+ macro
+
Usage: (times times-fn)
+       (times times-fn expectation-hash)
+
+
Creates or associates to an existing expectation hash the :times key with a
+value corresponding to a predicate function which expects an integer value.
+This function can either be specified as the first argument to times or can be
+the result of calling times with an integer argument, in which case the
+predicate will default to being an exact match.  This predicate is called at
+the end of an expect expression to validate that an expected dependency
+function was called the expected number of times.
+Usage:
+(times n)
+(times #(> n %))
+(times n expectation-hash)
+ + + Source +
+
+
+

validate-counts

+ function
+
Usage: (validate-counts mock-data)
+
+
given the sequence of all mock data for the expectation, simply calls the
+count checker for each dependency.
+ + + Source +
+

mock.test-adapter

+

+
+
+
+
+
+

calls

+ function
+
Usage: (calls val)
+       (calls val expectation-hash)
+
+
Creates or associates to an existing expectation hash the :calls key with a
+function that will be called with the given arguments. The return value from
+this function will be returned returned by the expected function. If both this
+and returns are specified, the return value of "calls" will have precedence.
+Usage:
+(calls some-fn expectation-hash?)
+ + + Source +
+
+

has-args

+ macro
+
Usage: (has-args arg-pred-forms)
+       (has-args arg-pred-forms expect-hash-form)
+
+
Creates or associates to an existing expectation hash the :has-args key with
+a value corresponding to a function that will either return true if its
+argument expectations are met or throw an exception with the details of the
+first failed argument it encounters.
+Only specify as many predicates as you are interested in verifying. The rest
+of the values are safely ignored.
+Usage:
+(has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?)
+ + + Source +
+
+

has-matching-signature?

+ function
+
Usage: (has-matching-signature? fn-name args)
+
+
Calls no-matching-function-signature if no match is found for the given
+function. If no argslist meta data is available for the function, it is
+not called.
+ + + Source +
+
+

make-arg-checker

+ function
+
Usage: (make-arg-checker arg-preds arg-pred-forms)
+
+
Creates the argument verifying function for a replaced dependency within
+the expectation bound scope. These functions take the additional argument
+of the name of the replaced function, then the rest of their args. It is
+designed to be called from the mock function generated in the first argument
+of the mock info object created by make-mock.
+ + + Source +
+
+

make-count-checker

+ function
+
Usage: (make-count-checker pred pred-form)
+
+
creates the count checker that is invoked at the end of an expectation, after
+the code under test has all been executed. The function returned takes the
+name of the associated dependency and the invocation count as arguments.
+ + + Source +
+
+

make-mock

+ function
+
Usage: (make-mock fn-name expectation-hash)
+
+
creates a vector containing the following information for the named function:
+1. dependent function replacement - verifies signature, calls arg checker,
+increases count, returns return value.
+2. an atom containing the invocation count
+3. the invocation count checker function
+4. a symbol of the name of the function being replaced.
+ + + Source +
+
+

report-problem

+ function
+
Usage: (report-problem fn-name expected actual msg)
+
+
This function is designed to be used in a binding macro to override
+the report-problem function in clojure.contrib.mock. Instead of printing
+the error to the console, the error is logged via clojure.test.
+ + + Source +
+
+

returns

+ function
+
Usage: (returns val)
+       (returns val expectation-hash)
+
+
Creates or associates to an existing expectation hash the :returns key with
+a value to be returned by the expectation after a successful invocation
+matching its expected arguments (if applicable).
+Usage:
+(returns ret-value expectation-hash?)
+ + + Source +
+
+

times

+ macro
+
Usage: (times times-fn)
+       (times times-fn expectation-hash)
+
+
Creates or associates to an existing expectation hash the :times key with a
+value corresponding to a predicate function which expects an integer value.
+This function can either be specified as the first argument to times or can be
+the result of calling times with an integer argument, in which case the
+predicate will default to being an exact match.  This predicate is called at
+the end of an expect expression to validate that an expected dependency
+function was called the expected number of times.
+Usage:
+(times n)
+(times #(> n %))
+(times n expectation-hash)
+ + + Source +
+
+

validate-counts

+ function
+
Usage: (validate-counts mock-data)
+
+
given the sequence of all mock data for the expectation, simply calls the
+count checker for each dependency.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/monadic-io-streams-api.html b/branch-master/monadic-io-streams-api.html new file mode 100644 index 00000000..eb8a532c --- /dev/null +++ b/branch-master/monadic-io-streams-api.html @@ -0,0 +1,262 @@ + + + monadic-io-streams - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for monadic-io-streams + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.monadic-io-streams))
+
+

Overview

+
Monadic I/O with Java input/output streams
+Defines monadic I/O statements to be used in a state monad
+with an input or output stream as the state. The macro
+monadic-io creates a stream, runs a monadic I/O statement
+on it, and closes the stream. This structure permits the
+definition of purely functional compound I/O statements
+which are applied to streams that can never escape from the
+monadic statement sequence.
+ + +
+

Public Variables and Functions

+
+
+
+

flush

+ function
+
Usage: (flush)
+
+
Flush
+ + + Source +
+
+
+

print

+ function
+
Usage: (print obj)
+
+
Print obj
+ + + Source +
+
+
+

println

+ function
+
Usage: (println)
+       (println obj)
+
+
Print obj followed by a newline
+ + + Source +
+
+
+

read-char

+ function
+
Usage: (read-char)
+
+
Read a single character
+ + + Source +
+
+
+

read-line

+ function
+
Usage: (read-line)
+
+
Read a single line
+ + + Source +
+
+
+

read-lines

+ function
+
Usage: (read-lines)
+
+
Read all lines and return them in a vector
+ + + Source +
+
+
+

skip-chars

+ function
+
Usage: (skip-chars n)
+
+
Skip n characters
+ + + Source +
+
+
+

with-io-streams

+ function
+
Usage: (with-io-streams io-specs statement)
+
+
Open one or more streams as specified by io-spec, run a monadic
+I/O statement on them, and close the streams. io-spec is
+a binding-like vector in which each stream is specified by
+three element: a keyword by which the stream can be referred to,
+the stream mode (:read or :write), and a stream specification as
+accepted by clojure.contrib.io/reader (mode :read) or
+clojure.contrib.io/writer (mode :write). The statement
+is run on a state which is a map from keywords to corresponding
+streams. Single-stream monadic I/O statements must be wrapped
+with clojure.contrib.monads/with-state-field.
+ + + Source +
+
+
+

with-reader

+ function
+
Usage: (with-reader reader-spec statement)
+
+
Create a reader from reader-spec, run the monadic I/O statement
+on it, and close the reader. reader-spec can be any object accepted
+by clojure.contrib.io/reader.
+ + + Source +
+
+
+

with-writer

+ function
+
Usage: (with-writer writer-spec statement)
+
+
Create a writer from writer-spec, run the monadic I/O statement
+on it, and close the writer. writer-spec can be any object accepted
+by clojure.contrib.io/writer.
+ + + Source +
+
+
+

write

+ function
+
Usage: (write text)
+
+
Write text (a string)
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/monads-api.html b/branch-master/monads-api.html new file mode 100644 index 00000000..bdaa863d --- /dev/null +++ b/branch-master/monads-api.html @@ -0,0 +1,645 @@ + + + monads - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for monads + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.monads))
+
+

Overview

+
This library contains the most commonly used monads as well
+as macros for defining and using monads and useful monadic
+functions.
+ + +See also: + + Monad tutorial part 1 + + Monad tutorial part 2 + + Monad tutorial part 3 + + Monad tutorial part 4 + + Monads in Clojure part 1 + + Monads in Clojure part 2 +
+

+

Public Variables and Functions

+
+
+
+

call-cc

+ function
+
Usage: (call-cc f)
+
+
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.
+ + + Source +
+
+
+

cont-m

+ var
+

+  
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.
+ + + Source +
+
+
+

defmonad

+ macro
+
Usage: (defmonad name doc-string operations)
+       (defmonad name operations)
+
+
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).
+ + + Source +
+
+
+

defmonadfn

+ macro
+
Usage: (defmonadfn name docstring? attr-map? args expr)
+       (defmonadfn name docstring? attr-map? (args expr) ...)
+
+
Like defn, but for functions that use monad operations and are used inside
+a with-monad block.
+ + + Source +
+
+
+

domonad

+ macro
+
Usage: (domonad steps expr)
+       (domonad name steps expr)
+
+
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.
+ + + Source +
+
+
+

fetch-state

+ function
+
Usage: (fetch-state)
+
+
Return a state-monad function that returns the current state and does not
+modify it.
+ + + Source +
+
+
+

fetch-val

+ function
+
Usage: (fetch-val key)
+
+
Return a state-monad function that assumes the state to be a map and
+returns the value corresponding to the given key. The state is not modified.
+ + + Source +
+
+
+

identity-m

+ var
+

+  
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.
+ + + Source +
+
+
+

m-chain

+ var
+

+  
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)).
+ + + Source +
+
+
+

m-fmap

+ var
+

+  
Bind the monadic value m to the function returning (f x) for argument x
+ + + Source +
+
+
+

m-join

+ var
+

+  
Converts a monadic value containing a monadic value into a 'simple'
+monadic value.
+ + + Source +
+
+
+

m-lift

+ macro
+
Usage: (m-lift n f)
+
+
Converts a function f of n arguments into a function of n
+monadic arguments returning a monadic value.
+ + + Source +
+
+
+

m-map

+ var
+

+  
'Executes' the sequence of monadic values resulting from mapping
+f onto the values xs. f must return a monadic value.
+ + + Source +
+
+
+

m-reduce

+ var
+

+  
Return the reduction of (m-lift 2 f) over the list of monadic values mvs
+with initial value (m-result val).
+ + + Source +
+
+
+

m-seq

+ var
+

+  
'Executes' the monadic values in ms and returns a sequence of the
+basic values contained in them.
+ + + Source +
+
+
+

m-until

+ var
+

+  
While (p x) is false, replace x by the value returned by the
+monadic computation (f x). Return (m-result x) for the first
+x for which (p x) is true.
+ + + Source +
+
+
+

m-when

+ macro
+
Usage: (m-when test m-expr)
+
+
If test is logical true, return monadic value m-expr, else return
+(m-result nil).
+ + + Source +
+
+
+

m-when-not

+ macro
+
Usage: (m-when-not test m-expr)
+
+
If test if logical false, return monadic value m-expr, else return
+(m-result nil).
+ + + Source +
+
+
+

maybe-m

+ var
+

+  
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.
+ + + Source +
+
+
+

maybe-t

+ function
+
Usage: (maybe-t m)
+       (maybe-t m nothing)
+       (maybe-t m nothing which-m-plus)
+
+
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.
+ + + Source +
+
+
+

monad

+ macro
+
Usage: (monad operations)
+
+
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).
+ + + Source +
+
+
+

monad-transformer

+ macro
+
Usage: (monad-transformer base which-m-plus operations)
+
+
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.
+ + + Source +
+
+
+

run-cont

+ function
+
Usage: (run-cont c)
+
+
Execute the computation c in the cont monad and return its result.
+ + + Source +
+
+
+

sequence-m

+ var
+

+  
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.
+ + + Source +
+
+
+

sequence-t

+ function
+
Usage: (sequence-t m)
+       (sequence-t m which-m-plus)
+
+
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.
+ + + Source +
+
+
+

set-m

+ var
+

+  
Monad describing multi-valued computations, like sequence-m,
+but returning sets of results instead of sequences of results.
+ + + Source +
+
+
+

set-state

+ function
+
Usage: (set-state s)
+
+
Return a state-monad function that replaces the current state by s and
+returns the previous state.
+ + + Source +
+
+
+

set-val

+ function
+
Usage: (set-val key val)
+
+
Return a state-monad function that assumes the state to be a map and
+replaces the value associated with key by val. The old value is returned.
+ + + Source +
+
+
+

state-m

+ var
+

+  
Monad describing stateful computations. The monadic values have the
+structure (fn [old-state] [result new-state]).
+ + + Source +
+
+
+

state-m-until

+ function
+
Usage: (state-m-until p f x)
+
+
An optimized implementation of m-until for the state monad that
+replaces recursion by a loop.
+ + + Source +
+
+
+

state-t

+ function
+
Usage: (state-t m)
+
+
Monad transformer that transforms a monad m into a monad of stateful
+computations that have the base monad type as their result.
+ + + Source +
+
+
+

update-state

+ function
+
Usage: (update-state f)
+
+
Return a state-monad function that replaces the current state by the
+result of f applied to the current state and that returns the old state.
+ + + Source +
+
+
+

update-val

+ function
+
Usage: (update-val key f)
+
+
Return a state-monad function that assumes the state to be a map and
+replaces the value associated with the given key by the return value
+of f applied to the old value. The old value is returned.
+ + + Source +
+
+
+

with-monad

+ macro
+
Usage: (with-monad monad & exprs)
+
+
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.
+ + + Source +
+
+
+

with-state-field

+ function
+
Usage: (with-state-field key statement)
+
+
Returns a state-monad function that expects a map as its state and
+runs statement (another state-monad function) on the state defined by
+the map entry corresponding to key. The map entry is updated with the
+new state returned by statement.
+ + + Source +
+
+
+

writer-m

+ function
+
Usage: (writer-m empty-accumulator)
+
+
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.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/ns-utils-api.html b/branch-master/ns-utils-api.html new file mode 100644 index 00000000..c5d51f04 --- /dev/null +++ b/branch-master/ns-utils-api.html @@ -0,0 +1,208 @@ + + + ns-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for ns-utils + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.ns-utils))
+
+

Overview

+
Namespace utilities
+ + +
+

Public Variables and Functions

+
+
+
+

dir

+ macro
+
Usage: (dir nsname)
+
+
Prints a sorted directory of public vars in a namespace
+ + + Source +
+
+
+

docs

+ macro
+
Usage: (docs nsname)
+
+
Prints documentation for the public vars in a namespace
+ + + Source +
+
+
+

get-ns

+ function
+
Usage: (get-ns ns-sym)
+
+
Returns the namespace named by ns-sym or throws if the
+namespace does not exist
+ + + Source +
+
+
+

immigrate

+ function
+
Usage: (immigrate & ns-names)
+
+
Create a public var in this namespace for each public var in the
+namespaces named by ns-names. The created vars have the same name, root
+binding, and metadata as the original except that their :ns metadata
+value is this namespace.
+ + + Source +
+
+
+

ns-vars

+ function
+
Usage: (ns-vars ns)
+
+
Returns a sorted seq of symbols naming public vars in
+a namespace
+ + + Source +
+
+
+

print-dir

+ function
+
Usage: (print-dir ns)
+
+
Prints a sorted directory of public vars in a namespace
+ + + Source +
+
+
+

print-docs

+ function
+
Usage: (print-docs ns)
+
+
Prints documentation for the public vars in a namespace
+ + + Source +
+
+
+

vars

+ macro
+
Usage: (vars nsname)
+
+
Returns a sorted seq of symbols naming public vars in
+a namespace
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/pprint-api.html b/branch-master/pprint-api.html new file mode 100644 index 00000000..36002416 --- /dev/null +++ b/branch-master/pprint-api.html @@ -0,0 +1,694 @@ + + + pprint - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for pprint + - clojure-contrib next (in development) +

+by Tom Faulhaber
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.pprint))
+
+

Overview

+
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 Java-based format function.
+
+See documentation for those functions for more information or complete 
+documentation on the the clojure-contrib web site on github.
+
+As of the 1.2 release, pprint has been moved to clojure.pprint. Please prefer
+the clojure.pprint version for new code.
+ +Deprecated since clojure-contrib version 1.2
+
+Related documentation: + +
A Common Lisp-compatible Format Function +
+
A Pretty Printer for Clojure +

+

Public Variables and Functions

+
+
+
+

*code-dispatch*

+ multimethod
+
Usage: (*code-dispatch* object)
+
+
The pretty print dispatch function for pretty printing Clojure code.
+ + + Source +
+
+
+

*print-base*

+ var
+

+  
The base to use for printing integers and rationals.
+ + + Source +
+
+
+

*print-circle*

+ var
+

+  
Mark circular structures (N.B. This is not yet used)
+ + + Source +
+
+
+

*print-lines*

+ var
+

+  
Maximum number of lines to print in a pretty print instance (N.B. This is not yet used)
+ + + Source +
+
+
+

*print-miser-width*

+ var
+

+  
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.
+ + + Source +
+
+
+

*print-pprint-dispatch*

+ var
+

+  
The pretty print dispatch function. Use with-pprint-dispatch or set-pprint-dispatch
+to modify.
+ + + Source +
+
+
+

*print-pretty*

+ var
+

+  
Bind to true if you want write to use pretty printing
+ + + Source +
+
+
+

*print-radix*

+ var
+

+  
Print a radix specifier in front of integers and rationals. If *print-base* is 2, 8, 
+or 16, then the radix specifier used is #b, #o, or #x, respectively. Otherwise the 
+radix specifier is in the form #XXr where XX is the decimal value of *print-base* 
+ + + Source +
+
+
+

*print-right-margin*

+ var
+

+  
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.
+ + + Source +
+
+
+

*print-shared*

+ var
+

+  
Mark repeated structures rather than repeat them (N.B. This is not yet used)
+ + + Source +
+
+
+

*print-suppress-namespaces*

+ var
+

+  
Don't print namespaces with symbols. This is particularly useful when 
+pretty printing the results of macro expansions
+ + + Source +
+
+
+

*simple-dispatch*

+ multimethod
+
Usage: (*simple-dispatch* object)
+
+
The pretty print dispatch function for simple data structure format.
+ + + Source +
+
+
+

cl-format

+ function
+
Usage: (cl-format writer format-in & args)
+
+
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
+ + + Source +
+
+
+

compile-format

+ function
+
Usage: (compile-format format-str)
+
+
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
+ + + Source +
+
+
+

formatter

+ macro
+
Usage: (formatter format-in)
+
+
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.
+ + + Source +
+
+
+

formatter-out

+ macro
+
Usage: (formatter-out format-in)
+
+
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.
+ + + Source +
+
+
+

fresh-line

+ function
+
Usage: (fresh-line)
+
+
Make a newline if the Writer is not already at the beginning of the line.
+N.B. Only works on ColumnWriters right now.
+ + + Source +
+
+
+

pp

+ macro
+
Usage: (pp)
+
+
A convenience macro that pretty prints the last thing output. This is
+exactly equivalent to (pprint *1).
+ + + Source +
+
+
+

pprint

+ function
+
Usage: (pprint object)
+       (pprint object writer)
+
+
Pretty print object to the optional output writer. If the writer is not provided, 
+print the object to the currently bound value of *out*.
+ + + Source +
+
+
+

pprint-indent

+ function
+
Usage: (pprint-indent relative-to n)
+
+
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.
+ + + Source +
+
+
+

pprint-logical-block

+ macro
+
Usage: (pprint-logical-block options* body)
+
+
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.
+ + + Source +
+
+
+

pprint-newline

+ function
+
Usage: (pprint-newline kind)
+
+
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.
+ + + Source +
+
+
+

pprint-tab

+ function
+
Usage: (pprint-tab kind colnum colinc)
+
+
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.
+ + + Source +
+
+
+

set-pprint-dispatch

+ function
+
Usage: (set-pprint-dispatch function)
+
+
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.
+ + + Source +
+
+
+

use-method

+ function
+
Usage: (use-method multifn dispatch-val func)
+
+
Installs a function as a new method of multimethod associated with dispatch-value. 
+ + + Source +
+
+
+

with-pprint-dispatch

+ macro
+
Usage: (with-pprint-dispatch function & body)
+
+
Execute body with the pretty print dispatch function bound to function.
+ + + Source +
+
+
+

write

+ function
+
Usage: (write object & kw-args)
+
+
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*)
+  :base                Base to use for writing rationals    Current value of *print-base*
+  :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*
+  :radix               If true, prepend a radix specifier   Current value of *print-radix*
+  :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
+ + + Source +
+
+
+

write-out

+ function
+
Usage: (write-out object)
+
+
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. 
+ + + Source +
+

pprint.examples.json

+
Pretty printing JavaScript Object Notation (JSON) generator.
+
+This is an example of using a pretty printer dispatch function to generate JSON output
+ + +See also: + + JSON Home Page +
+

+
+
+

dispatch-json

+ multimethod
+
Usage: (dispatch-json x)
+
+
The dispatch function for printing objects as JSON
+ + + Source +
+
+

json-str

+ function
+
Usage: (json-str x)
+
+
Converts x to a JSON-formatted string.
+ + + Source +
+
+

print-json

+ function
+
Usage: (print-json x)
+
+
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.
+ + + Source +
+

pprint.examples.xml

+
A version of prxml that uses a pretty print dispatch function.
+ + +
+
+
+

*html-compatible*

+ var
+

+  
If true, empty tags will have a space before the closing />
+ + + Source +
+
+

*prxml-indent*

+ var
+

+  
The number of spaces to indent sub-tags.
+ + + Source +
+
+

prxml

+ function
+
Usage: (prxml & args)
+
+
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"?>
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/priority-map-api.html b/branch-master/priority-map-api.html new file mode 100644 index 00000000..019e33b7 --- /dev/null +++ b/branch-master/priority-map-api.html @@ -0,0 +1,126 @@ + + + priority-map - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for priority-map + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.priority-map))
+
+

Overview

+

+
+
+
+

Public Variables and Functions

+
+
+
+

priority-map

+ function
+
Usage: (priority-map & keyvals)
+
+
keyval => key val
+Returns a new priority map with supplied mappings
+ + + Source +
+
+
+

priority-map-by

+ function
+
Usage: (priority-map-by comparator & keyvals)
+
+
keyval => key val
+Returns a new priority map with supplied mappings
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/probabilities.finite-distributions-api.html b/branch-master/probabilities.finite-distributions-api.html new file mode 100644 index 00000000..5322dce3 --- /dev/null +++ b/branch-master/probabilities.finite-distributions-api.html @@ -0,0 +1,256 @@ + + + probabilities.finite-distributions - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for probabilities.finite-distributions + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.probabilities.finite-distributions))
+
+

Overview

+
Finite probability distributions
+This library defines a monad for combining finite probability
+distributions.
+ + +
+

Public Variables and Functions

+
+
+
+

certainly

+ function
+
Usage: (certainly v)
+
+
Returns a distribution in which the single value v has probability 1.
+ + + Source +
+
+
+

choose

+ function
+
Usage: (choose & choices)
+
+
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.
+ + + Source +
+
+
+

cond-dist-m

+ var
+

+  
Variant of the dist monad that can handle undefined values.
+ + + Source +
+
+
+

cond-prob

+ function
+
Usage: (cond-prob pred dist)
+
+
Returns the conditional probability for the values in dist that satisfy
+the predicate pred.
+ + + Source +
+
+
+

dist-m

+ var
+

+  
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.
+ + + Source +
+
+
+

join-with

+ function
+
Usage: (join-with f dist1 dist2)
+
+
Returns the distribution of (f x y) with x from dist1 and y from dist2.
+ + + Source +
+
+
+

make-distribution

+ function
+
Usage: (make-distribution coll f)
+
+
Returns the distribution in which each element x of the collection
+has a probability proportional to (f x)
+ + + Source +
+
+
+

normalize

+ function
+
Usage: (normalize weights)
+
+
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.
+ + + Source +
+
+
+

prob

+ function
+
Usage: (prob pred dist)
+
+
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.
+ + + Source +
+
+
+

uniform

+ function
+
Usage: (uniform coll)
+
+
Return a distribution in which each of the elements of coll
+has the same probability.
+ + + Source +
+
+
+

zipf

+ function
+
Usage: (zipf s n)
+
+
Returns the Zipf distribution in which the numbers k=1..n have
+probabilities proportional to 1/k^s.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/probabilities.monte-carlo-api.html b/branch-master/probabilities.monte-carlo-api.html new file mode 100644 index 00000000..7be9773a --- /dev/null +++ b/branch-master/probabilities.monte-carlo-api.html @@ -0,0 +1,300 @@ + + + probabilities.monte-carlo - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for probabilities.monte-carlo + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.probabilities.monte-carlo))
+
+

Overview

+
Monte-Carlo method support
+
+Monte-Carlo methods transform an input random number stream
+(usually having a continuous uniform distribution in the
+interval [0, 1)) into a random number stream whose distribution
+satisfies certain conditions (usually the expectation value
+is equal to some desired quantity). They are thus
+transformations from one probability distribution to another one.
+
+This library represents a Monte-Carlo method by a function that
+takes as input the state of a random number stream with
+uniform distribution (see
+clojure.contrib.probabilities.random-numbers) and returns a
+vector containing one sample value of the desired output
+distribution and the final state of the input random number
+stream. Such functions are state monad values and can be
+composed using operations defined in clojure.contrib.monads.
+ + +
+

Public Variables and Functions

+
+
+
+

discrete

+ function
+
Usage: (discrete dist)
+
+
A discrete distribution, defined by a map dist mapping values
+to probabilities. The sum of probabilities must be one.
+ + + Source +
+
+
+

exponential

+ function
+
Usage: (exponential lambda)
+
+
Transform a sequence of uniform random numbers in the interval [0, 1)
+into a sequence of exponential random numbers with parameter lambda.
+ + + Source +
+
+
+

lognormal

+ function
+
Usage: (lognormal mu sigma)
+
+
Transform a sequence of uniform random numbesr in the interval [0, 1)
+into a sequence of lognormal random numbers with mean mu and standard
+deviation sigma.
+ + + Source +
+
+
+

n-sphere

+ function
+
Usage: (n-sphere n r)
+
+
Return a uniform distribution of n-dimensional vectors inside an
+n-sphere of radius r.
+ + + Source +
+
+
+

normal

+ function
+
Usage: (normal mu sigma)
+
+
Transform a sequence urs of uniform random number in the interval [0, 1)
+into a sequence of normal random numbers with mean mu and standard
+deviation sigma.
+ + + Source +
+
+
+

normal-box-muller

+ function
+
Usage: (normal-box-muller mu sigma)
+
+
Transform a sequence of uniform random numbers in the interval [0, 1)
+into a sequence of normal random numbers with mean mu and standard
+deviation sigma.
+ + + Source +
+
+
+

random-stream

+ function
+
Usage: (random-stream distribution random-stream-state)
+
+
Define a random stream by a distribution and the state of a
+random number stream with uniform distribution in [0, 1).
+ + + Source +
+
+
+

reject

+ function
+
Usage: (reject p dist)
+
+
Return the distribution that results from rejecting the values from
+dist that do not satisfy predicate p.
+ + + Source +
+
+
+

sample

+ function
+
Usage: (sample n dist)
+
+
Return the distribution of samples of length n from the
+distribution dist
+ + + Source +
+
+
+

sample-mean

+ function
+
Usage: (sample-mean n dist)
+
+
Return the distribution of the mean over n samples from the
+distribution dist
+ + + Source +
+
+
+

sample-mean-variance

+ function
+
Usage: (sample-mean-variance n dist)
+
+
Return the distribution of the mean-and-variance (a vector containing
+the mean and the variance) over n samples from the distribution dist
+ + + Source +
+
+
+

sample-reduce

+ function
+
Usage: (sample-reduce f n dist)
+       (sample-reduce f val n dist)
+
+
Returns the distribution of the reduction of f over n samples from the
+distribution dist.
+ + + Source +
+
+
+

sample-sum

+ function
+
Usage: (sample-sum n dist)
+
+
Return the distribution of the sum over n samples from the
+distribution dist.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/probabilities.random-numbers-api.html b/branch-master/probabilities.random-numbers-api.html new file mode 100644 index 00000000..952df157 --- /dev/null +++ b/branch-master/probabilities.random-numbers-api.html @@ -0,0 +1,134 @@ + + + probabilities.random-numbers - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for probabilities.random-numbers + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.probabilities.random-numbers))
+
+

Overview

+
Random number streams
+
+This library provides random number generators with a common
+stream interface. They all produce pseudo-random numbers that are
+uniformly distributed in the interval [0, 1), i.e. 0 is a
+possible value but 1 isn't. For transformations to other
+distributions, see clojure.contrib.probabilities.monte-carlo.
+
+At the moment, the only generator provided is a rather simple
+linear congruential generator.
+ + +
+

Public Variables and Functions

+
+
+
+

lcg

+ function
+
Usage: (lcg modulus multiplier increment seed)
+
+
Create a linear congruential generator
+ + + Source +
+
+
+

rand-stream

+ var
+

+  
A random number stream based on clojure.core/rand. Note that this
+generator uses an internal mutable state. The state is thus not stored
+in the stream object and cannot be restored.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/profile-api.html b/branch-master/profile-api.html new file mode 100644 index 00000000..685c0366 --- /dev/null +++ b/branch-master/profile-api.html @@ -0,0 +1,212 @@ + + + profile - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for profile + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.profile))
+
+

Overview

+
Simple code profiling & timing measurement.
+
+Wrap any section of code in the prof macro, giving it a name, like this:
+
+       (defn my-function [x y]
+         (let [sum (prof :addition (+ x y))
+               product (prof :multiplication (* x y))]
+           [sum product]))
+
+The run your code in the profile macro, like this:
+
+       (profile (dotimes [i 10000] (my-function 3 4)))
+
+Which prints a report for each named section of code:
+
+          Name      mean       min       max     count       sum
+      addition       265         0     37000     10000   2655000
+multiplication       274         0     53000     10000   2747000
+
+Times are measured in nanoseconds, to the maximum precision available
+under the JVM.  See the function documentation for more details.
+ + +
+

Public Variables and Functions

+
+
+
+

*enable-profiling*

+ var
+

+  
Set this to false before loading/compiling to omit
+profiling code.
+ + + Source +
+
+
+

print-summary

+ function
+
Usage: (print-summary profile-summary)
+
+
Prints a table of the results returned by summarize.
+ + + Source +
+
+
+

prof

+ macro
+
Usage: (prof name & body)
+
+
If *enable-profiling* is true, wraps body in profiling code.
+Returns the result of body. Profile timings will be stored in
+*profile-data* using name, which must be a keyword, as the key.
+Timings are measured with System/nanoTime.
+ + + Source +
+
+
+

profile

+ macro
+
Usage: (profile & body)
+
+
Runs body with profiling enabled, then prints a summary of
+results.  Returns nil.
+ + + Source +
+
+
+

summarize

+ function
+
Usage: (summarize profile-data)
+
+
Takes the raw data returned by with-profile-data and returns a map
+from names to summary statistics.  Each value in the map will look
+like:
+
+   {:mean ..., :min ..., :max ..., :count ..., :sum ...}
+
+:mean, :min, and :max are how long the profiled section took to run,
+in nanoseconds.  :count is the total number of times the profiled
+section was executed.  :sum is the total amount of time spent in the
+profiled section, in nanoseconds.
+ + + Source +
+
+
+

with-profile-data

+ macro
+
Usage: (with-profile-data & body)
+
+
Executes body with *profile-data* bound to an atom of a new map.
+Returns the raw profile data as a map.  Keys in the map are profile
+names (keywords), and values are lists of elapsed time, in
+nanoseconds.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/properties-api.html b/branch-master/properties-api.html new file mode 100644 index 00000000..5b9c699d --- /dev/null +++ b/branch-master/properties-api.html @@ -0,0 +1,183 @@ + + + properties - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for properties + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.properties))
+
+

Overview

+

+
+Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

as-properties

+ function
+
Usage: (as-properties m)
+
+
Convert any seq of pairs to a java.utils.Properties instance.
+Uses as-str to convert both keys and values into strings.
+ + + Source +
+
+
+

get-system-property

+ function
+
Usage: (get-system-property stringable)
+       (get-system-property stringable default)
+
+
Get a system property.
+ + + Source +
+
+
+

read-properties

+ function
+
Usage: (read-properties file-able)
+
+
Read properties from file-able.
+ + + Source +
+
+
+

set-system-properties

+ function
+
Usage: (set-system-properties settings)
+
+
Set some system properties. Nil clears a property.
+ + + Source +
+
+
+

with-system-properties

+ macro
+
Usage: (with-system-properties settings & body)
+
+
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.
+ + + Source +
+
+
+

write-properties

+ function
+
Usage: (write-properties m file-able)
+       (write-properties m file-able comments)
+
+
Write properties to file-able.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/prxml-api.html b/branch-master/prxml-api.html new file mode 100644 index 00000000..93eeb991 --- /dev/null +++ b/branch-master/prxml-api.html @@ -0,0 +1,158 @@ + + + prxml - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for prxml + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.prxml))
+
+

Overview

+
Compact syntax for generating XML. See the documentation of "prxml" 
+for details.
+ + +
+

Public Variables and Functions

+
+
+
+

*html-compatible*

+ var
+

+  
If true, empty tags will have a space before the closing />
+ + + Source +
+
+
+

*prxml-indent*

+ var
+

+  
The number of spaces to indent sub-tags.  nil for no indent
+and no extra line-breaks.
+ + + Source +
+
+
+

prxml

+ function
+
Usage: (prxml & args)
+
+
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"?>
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/reflect-api.html b/branch-master/reflect-api.html new file mode 100644 index 00000000..8e0d431a --- /dev/null +++ b/branch-master/reflect-api.html @@ -0,0 +1,132 @@ + + + reflect - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for reflect + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.reflect))
+
+

Overview

+

+
+
+
+

Public Variables and Functions

+
+
+
+

call-method

+ function
+
Usage: (call-method klass method-name params obj & args)
+
+
Calls a private or protected method.
+
+params is a vector of classes which correspond to the arguments to
+the method e
+
+obj is nil for static methods, the instance object otherwise.
+
+The method-name is given a symbol or a keyword (something Named).
+ + + Source +
+
+
+

get-field

+ function
+
Usage: (get-field klass field-name obj)
+
+
Access to private or protected field.  field-name is a symbol or
+keyword.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/repl-ln-api.html b/branch-master/repl-ln-api.html new file mode 100644 index 00000000..0c3ed7ba --- /dev/null +++ b/branch-master/repl-ln-api.html @@ -0,0 +1,225 @@ + + + repl-ln - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for repl-ln + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.repl-ln))
+
+

Overview

+
A repl with that provides support for lines and line numbers in the
+input stream.
+ + +
+

Public Variables and Functions

+
+
+
+

print-repl-info

+ function
+
Usage: (print-repl-info)
+
+
Prints info about the current repl
+ + + Source +
+
+
+

repl

+ function
+
Usage: (repl & options)
+
+
A repl that supports line numbers. For definitions and evaluations made
+at the repl, the repl-name and line number will be reported as the
+origin. Use set-repl-name and set-repl-prompt to customize the repl name
+and prompt. This repl supports all of the keyword arguments documented
+for clojure.main/repl with the following change and additions:
+
+     - :prompt has a new default
+       default: #(clojure.core/print (repl-prompt))
+
+     - :name-fmt, Name format string
+       default: the name-fmt of the parent repl, or "repl-%S"
+
+     - :prompt-fmt, Prompt format string
+       default: the prompt-fmt of the parent repl, or "%S:%L %N=> "
+ + + Source +
+
+
+

repl-info

+ function
+
Usage: (repl-info)
+
+
Returns a map of info about the current repl
+ + + Source +
+
+
+

repl-prompt

+ function
+
Usage: (repl-prompt)
+
+
Returns the current repl prompt based on this repl's prompt-fmt
+ + + Source +
+
+
+

set-repl-name

+ function
+
Usage: (set-repl-name)
+       (set-repl-name name-fmt)
+
+
Sets the repl name format to the string name-fmt. Include the following
+codes in the name to make the corresponding dynamic values part of it:
+
+  %S - repl serial number
+  %T - thread id
+  %D - nesting depth in this thread
+
+With no arguments, resets the repl name to its default: "repl-%S"
+ + + Source +
+
+
+

set-repl-prompt

+ function
+
Usage: (set-repl-prompt)
+       (set-repl-prompt prompt-fmt)
+
+
Sets the repl prompt. Include the following codes in the prompt to make
+the corresponding dynamic values part of it:
+
+  %S - repl serial number
+  %T - thread id
+  %D - nesting depth in this thread
+  %L - input line number
+  %N - namespace name
+
+With no arguments, resets the repl pompt to its default: "%S:%L %N=> "
+ + + Source +
+
+
+

stream-repl

+ function
+
Usage: (stream-repl & options)
+
+
Repl entry point that provides convenient overriding of input, output,
+and err streams via sequential keyword-value pairs. Default values
+for :in, :out, and :err are streams associated with System/in,
+System/out, and System/err using UTF-8 encoding. Also supports all the
+options provided by clojure.contrib.repl-ln/repl.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/repl-utils-api.html b/branch-master/repl-utils-api.html new file mode 100644 index 00000000..7620f67b --- /dev/null +++ b/branch-master/repl-utils-api.html @@ -0,0 +1,348 @@ + + + repl-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for repl-utils + - clojure-contrib next (in development) +

+by Chris Houser, Christophe Grand, Stephen Gilardi, Michel Salim
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.repl-utils))
+
+

Overview

+
Utilities meant to be used interactively at the REPL
+ + +
+

Public Variables and Functions

+
+
+
+

*local-javadocs*

+ var
+

+  
Ref to a list of local paths for Javadoc-generated HTML
+files.
+ + + Source +
+
+
+

*remote-javadocs*

+ var
+

+  
Ref to a map from package name prefixes to URLs for remote
+Javadocs.
+ + + Source +
+
+
+

add-break-thread!

+ function
+
Usage: (add-break-thread!)
+       (add-break-thread! t)
+
+
Add the given thread to break-threads so that it will be stopped
+any time the user presses Ctrl-C.  Calls start-handling-break for
+you.  Adds the current thread if none is given.
+ + + Source +
+
+
+

add-local-javadoc

+ function
+
Usage: (add-local-javadoc path)
+
+
Adds to the list of local Javadoc paths.
+ + + Source +
+
+
+

add-remote-javadoc

+ function
+
Usage: (add-remote-javadoc package-prefix url)
+
+
Adds to the list of remote Javadoc URLs.  package-prefix is the
+beginning of the package name that has docs at this URL.
+ + + Source +
+
+
+

apropos

+ function
+
Usage: (apropos str-or-pattern)
+
+
Given a regular expression or stringable thing, return a seq of 
+all definitions in all currently-loaded namespaces that match the
+str-or-pattern.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

break-threads

+ var
+

+  
Threads to stop when Ctrl-C is pressed.  See 'add-break-thread!'
+ + + Source +
+
+
+

expression-info

+ function
+
Usage: (expression-info expr)
+
+
Uses the Clojure compiler to analyze the given s-expr.  Returns
+a map with keys :class and :primitive? indicating what the compiler
+concluded about the return value of the expression.  Returns nil if
+not type info can be determined at compile-time.
+
+Example: (expression-info '(+ (int 5) (float 10)))
+Returns: {:class float, :primitive? true}
+ + + Source +
+
+
+

find-javadoc-url

+ function
+
Usage: (find-javadoc-url classname)
+
+
Searches for a URL for the given class name.  Tries
+*local-javadocs* first, then *remote-javadocs*.  Returns a string.
+ + + Source +
+
+
+

get-source

+ function
+
Usage: (get-source x)
+
+
Returns a string of the source code for the given symbol, if it can
+find it.  This requires that the symbol resolve to a Var defined in
+a namespace for which the .clj is in the classpath.  Returns nil if
+it can't find the source.  For most REPL usage, 'source' is more
+convenient.
+
+Example: (get-source 'filter)
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

javadoc

+ function
+
Usage: (javadoc class-or-object)
+
+
Opens a browser window displaying the javadoc for the argument.
+Tries *local-javadocs* first, then *remote-javadocs*.
+ + + Source +
+
+
+

run

+ macro
+
Usage: (run ns-name & args)
+
+
Loads the specified namespace and invokes its "main" function with
+optional args. ns-name is not evaluated.
+ + + Source +
+
+
+

run*

+ function
+
Usage: (run* ns-sym & args)
+
+
Loads the specified namespace and invokes its "main" function with
+optional args.
+ + + Source +
+
+
+

show

+ function
+
Usage: (show x)
+       (show x selector)
+
+
With one arg prints all static and instance members of x or (class x).
+Each member is listed with a number which can be given as 'selector'
+to return the member object -- the REPL will print more details for
+that member.
+
+The selector also may be a string or regex, in which case only
+members whose names match 'selector' as a case-insensitive regex
+will be printed.
+
+Finally, the selector also may be a predicate, in which case only
+members for which the predicate returns true will be printed.  The
+predicate will be passed a single argument, a map that includes the
+:text that will be printed and the :member object itself, as well as
+all the properies of the member object as translated by 'bean'.
+
+Examples: (show Integer)  (show [])  (show String 23)  (show String "case")
+ + + Source +
+
+
+

source

+ macro
+
Usage: (source n)
+
+
Prints the source code for the given symbol, if it can find it.
+This requires that the symbol resolve to a Var defined in a
+namespace for which the .clj is in the classpath.
+
+Example: (source filter)
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

start-handling-break

+ function
+
Usage: (start-handling-break)
+
+
Register INT signal handler.  After calling this, Ctrl-C will cause
+all break-threads to be stopped.  See 'add-break-thread!'
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/seq-api.html b/branch-master/seq-api.html new file mode 100644 index 00000000..af14dfa9 --- /dev/null +++ b/branch-master/seq-api.html @@ -0,0 +1,367 @@ + + + seq - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for seq + - clojure-contrib next (in development) +

+by Stuart Sierra (and others)
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.seq))
+
+

Overview

+
Sequence utilities for Clojure
+ + +
+

Public Variables and Functions

+
+
+
+

fill-queue

+ function
+
Usage: (fill-queue filler-func & optseq)
+
+
filler-func will be called in another thread with a single arg
+'fill'.  filler-func may call fill repeatedly with one arg each
+time which will be pushed onto a queue, blocking if needed until
+this is possible.  fill-queue will return a lazy seq of the values
+filler-func has pushed onto the queue, blocking if needed until each
+next element becomes available.  filler-func's return value is ignored.
+ + + Source +
+
+
+

find-first

+ function
+
Usage: (find-first pred coll)
+
+
Returns the first item of coll for which (pred item) returns logical true.
+Consumes sequences up to the first match, will consume the entire sequence
+and return nil if no match is found.
+ + + Source +
+
+
+

flatten

+ function
+
Usage: (flatten x)
+
+
DEPRECATED. Prefer clojure.core version.
+Takes any nested combination of sequential things (lists, vectors,
+etc.) and returns their contents as a single, flat sequence.
+(flatten nil) returns nil.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

frequencies

+ function
+
Usage: (frequencies coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Returns a map from distinct items in coll to the number of times
+they appear.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

group-by

+ function
+
Usage: (group-by f coll)
+
+
DEPRECATED. Prefer clojure.core version.
+ Returns a sorted map of the elements of coll keyed by the result of
+f on each element. The value at each key will be a vector of the
+corresponding elements, in the order they appeared in coll.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

includes?

+ function
+
Usage: (includes? coll x)
+
+
Returns true if coll contains something equal (with =) to x,
+in linear time. Deprecated. Prefer 'contains?' for key testing,
+or 'some' for ad hoc linear searches.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

indexed

+ function
+
Usage: (indexed s)
+
+
Returns a lazy sequence of [index, item] pairs, where items come
+from 's' and indexes count up from zero.
+
+(indexed '(a b c d))  =>  ([0 a] [1 b] [2 c] [3 d])
+ + + Source +
+
+
+

partition-all

+ function
+
Usage: (partition-all n coll)
+       (partition-all n step coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Returns a lazy sequence of lists like clojure.core/partition, but may
+include lists with fewer than n items at the end.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

partition-by

+ function
+
Usage: (partition-by f coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Applies f to each value in coll, splitting it each time f returns
+a new value.  Returns a lazy seq of lazy seqs.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

positions

+ function
+
Usage: (positions pred coll)
+
+
Returns a lazy sequence containing the positions at which pred
+is true for items in coll.
+ + + Source +
+
+
+

rand-elt

+ function
+
Usage: (rand-elt s)
+
+
DEPRECATED. Prefer clojure.core/rand-nth.
+Return a random element of this seq
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

rec-cat

+ macro
+
Usage: (rec-cat binding-name & exprs)
+
+
Similar to lazy-cat but binds the resulting sequence to the supplied 
+binding-name, allowing for recursive expressions.
+ + + Source +
+
+
+

rec-seq

+ macro
+
Usage: (rec-seq binding-name & body)
+
+
Similar to lazy-seq but binds the resulting seq to the supplied 
+binding-name, allowing for recursive expressions.
+ + + Source +
+
+
+

reductions

+ function
+
Usage: (reductions f coll)
+       (reductions f init coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Returns a lazy seq of the intermediate values of the reduction (as
+per reduce) of coll by f, starting with init.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

rotations

+ function
+
Usage: (rotations x)
+
+
Returns a lazy seq of all rotations of a seq
+ + + Source +
+
+
+

separate

+ function
+
Usage: (separate f s)
+
+
Returns a vector:
+[ (filter f s), (filter (complement f) s) ]
+ + + Source +
+
+
+

seq-on

+ multimethod
+
Usage: (seq-on s)
+
+
Returns a seq on the object s. Works like the built-in seq but as
+a multimethod that can have implementations for new classes and types.
+ + + Source +
+
+
+

shuffle

+ function
+
Usage: (shuffle coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Return a random permutation of coll
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/seq-utils-api.html b/branch-master/seq-utils-api.html new file mode 100644 index 00000000..ad1d8bce --- /dev/null +++ b/branch-master/seq-utils-api.html @@ -0,0 +1,367 @@ + + + seq-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for seq-utils + - clojure-contrib next (in development) +

+by Stuart Sierra (and others)
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.seq-utils))
+
+

Overview

+
Sequence utilities for Clojure
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

fill-queue

+ function
+
Usage: (fill-queue filler-func & optseq)
+
+
filler-func will be called in another thread with a single arg
+'fill'.  filler-func may call fill repeatedly with one arg each
+time which will be pushed onto a queue, blocking if needed until
+this is possible.  fill-queue will return a lazy seq of the values
+filler-func has pushed onto the queue, blocking if needed until each
+next element becomes available.  filler-func's return value is ignored.
+ + + Source +
+
+
+

find-first

+ function
+
Usage: (find-first pred coll)
+
+
Returns the first item of coll for which (pred item) returns logical true.
+Consumes sequences up to the first match, will consume the entire sequence
+and return nil if no match is found.
+ + + Source +
+
+
+

flatten

+ function
+
Usage: (flatten x)
+
+
DEPRECATED. Prefer clojure.core version.
+Takes any nested combination of sequential things (lists, vectors,
+etc.) and returns their contents as a single, flat sequence.
+(flatten nil) returns nil.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

frequencies

+ function
+
Usage: (frequencies coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Returns a map from distinct items in coll to the number of times
+they appear.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

group-by

+ function
+
Usage: (group-by f coll)
+
+
DEPRECATED. Prefer clojure.core version.
+ Returns a sorted map of the elements of coll keyed by the result of
+f on each element. The value at each key will be a vector of the
+corresponding elements, in the order they appeared in coll.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

includes?

+ function
+
Usage: (includes? coll x)
+
+
Returns true if coll contains something equal (with =) to x,
+in linear time. Deprecated. Prefer 'contains?' for key testing,
+or 'some' for ad hoc linear searches.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

indexed

+ function
+
Usage: (indexed s)
+
+
Returns a lazy sequence of [index, item] pairs, where items come
+from 's' and indexes count up from zero.
+
+(indexed '(a b c d))  =>  ([0 a] [1 b] [2 c] [3 d])
+ + + Source +
+
+
+

partition-all

+ function
+
Usage: (partition-all n coll)
+       (partition-all n step coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Returns a lazy sequence of lists like clojure.core/partition, but may
+include lists with fewer than n items at the end.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

partition-by

+ function
+
Usage: (partition-by f coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Applies f to each value in coll, splitting it each time f returns
+a new value.  Returns a lazy seq of lazy seqs.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

positions

+ function
+
Usage: (positions pred coll)
+
+
Returns a lazy sequence containing the positions at which pred
+is true for items in coll.
+ + + Source +
+
+
+

rand-elt

+ function
+
Usage: (rand-elt s)
+
+
DEPRECATED. Prefer clojure.core/rand-nth.
+Return a random element of this seq
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

rec-cat

+ macro
+
Usage: (rec-cat binding-name & exprs)
+
+
Similar to lazy-cat but binds the resulting sequence to the supplied 
+binding-name, allowing for recursive expressions.
+ + + Source +
+
+
+

rec-seq

+ macro
+
Usage: (rec-seq binding-name & body)
+
+
Similar to lazy-seq but binds the resulting seq to the supplied 
+binding-name, allowing for recursive expressions.
+ + + Source +
+
+
+

reductions

+ function
+
Usage: (reductions f coll)
+       (reductions f init coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Returns a lazy seq of the intermediate values of the reduction (as
+per reduce) of coll by f, starting with init.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

rotations

+ function
+
Usage: (rotations x)
+
+
Returns a lazy seq of all rotations of a seq
+ + + Source +
+
+
+

separate

+ function
+
Usage: (separate f s)
+
+
Returns a vector:
+[ (filter f s), (filter (complement f) s) ]
+ + + Source +
+
+
+

seq-on

+ multimethod
+
Usage: (seq-on s)
+
+
Returns a seq on the object s. Works like the built-in seq but as
+a multimethod that can have implementations for new classes and types.
+ + + Source +
+
+
+

shuffle

+ function
+
Usage: (shuffle coll)
+
+
DEPRECATED. Prefer clojure.core version.
+Return a random permutation of coll
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/server-socket-api.html b/branch-master/server-socket-api.html new file mode 100644 index 00000000..0f81b6e2 --- /dev/null +++ b/branch-master/server-socket-api.html @@ -0,0 +1,134 @@ + + + server-socket - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for server-socket + - clojure-contrib next (in development) +

+by Craig McDaniel
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.server-socket))
+
+

Overview

+
Server socket library - includes REPL on socket
+ + +
+

Public Variables and Functions

+
+
+
+

create-repl-server

+ function
+
Usage: (create-repl-server port backlog bind-addr)
+       (create-repl-server port backlog)
+       (create-repl-server port)
+
+
create a repl on a socket
+ + + Source +
+
+
+

create-server

+ function
+
Usage: (create-server port fun backlog bind-addr)
+       (create-server port fun backlog)
+       (create-server port fun)
+
+
Creates a server socket on port. Upon accept, a new thread is
+created which calls:
+
+(fun input-stream output-stream)
+
+Optional arguments support specifying a listen backlog and binding
+to a specific endpoint.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/set-api.html b/branch-master/set-api.html new file mode 100644 index 00000000..8cec973e --- /dev/null +++ b/branch-master/set-api.html @@ -0,0 +1,150 @@ + + + set - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for set + - clojure-contrib next (in development) +

+by Jason Wolfe
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.set))
+
+

Overview

+
Clojure functions for operating on sets (supplemental to clojure.set)
+ + +
+

Public Variables and Functions

+
+
+
+

proper-subset?

+ function
+
Usage: (proper-subset? set1 set2)
+
+
Is s1 a proper subset of s2?
+ + + Source +
+
+
+

proper-superset?

+ function
+
Usage: (proper-superset? set1 set2)
+
+
Is s1 a proper superset of s2?
+ + + Source +
+
+
+

subset?

+ function
+
Usage: (subset? set1 set2)
+
+
Is set1 a subset of set2?
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

superset?

+ function
+
Usage: (superset? set1 set2)
+
+
Is set1 a superset of set2?
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/shell-api.html b/branch-master/shell-api.html new file mode 100644 index 00000000..002f9f86 --- /dev/null +++ b/branch-master/shell-api.html @@ -0,0 +1,137 @@ + + + shell - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for shell + - clojure-contrib next (in development) +

+by Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.shell))
+
+

Overview

+
Conveniently launch a sub-process providing to its stdin and
+collecting its stdout
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

sh

+ function
+
Usage: (sh & args)
+
+
Passes the given strings to Runtime.exec() to launch a sub-process.
+
+Options are
+
+:in    may be given followed by a String specifying text to be fed to the 
+       sub-process's stdin.  
+:out   option may be given followed by :bytes or a String. If a String 
+       is given, it will be used as a character encoding name (for 
+       example "UTF-8" or "ISO-8859-1") to convert the 
+       sub-process's stdout to a String which is returned.
+       If :bytes is given, the sub-process's stdout will be stored in 
+       a byte array and returned.  Defaults to UTF-8.
+:return-map
+       when followed by boolean true, sh returns a map of
+         :exit => sub-process's exit code
+         :out  => sub-process's stdout (as byte[] or String)
+         :err  => sub-process's stderr (as byte[] or String)
+       when not given or followed by false, sh returns a single
+       array or String of the sub-process's stdout followed by its
+       stderr
+:env   override the process env with a map (or the underlying Java
+       String[] if you are a masochist).
+:dir   override the process dir with a String or java.io.File.
+
+You can bind :env or :dir for multiple operations using with-sh-env
+and with-sh-dir.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/shell-out-api.html b/branch-master/shell-out-api.html new file mode 100644 index 00000000..3238e864 --- /dev/null +++ b/branch-master/shell-out-api.html @@ -0,0 +1,137 @@ + + + shell-out - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for shell-out + - clojure-contrib next (in development) +

+by Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.shell-out))
+
+

Overview

+
Conveniently launch a sub-process providing to its stdin and
+collecting its stdout
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

sh

+ function
+
Usage: (sh & args)
+
+
Passes the given strings to Runtime.exec() to launch a sub-process.
+
+Options are
+
+:in    may be given followed by a String specifying text to be fed to the 
+       sub-process's stdin.  
+:out   option may be given followed by :bytes or a String. If a String 
+       is given, it will be used as a character encoding name (for 
+       example "UTF-8" or "ISO-8859-1") to convert the 
+       sub-process's stdout to a String which is returned.
+       If :bytes is given, the sub-process's stdout will be stored in 
+       a byte array and returned.  Defaults to UTF-8.
+:return-map
+       when followed by boolean true, sh returns a map of
+         :exit => sub-process's exit code
+         :out  => sub-process's stdout (as byte[] or String)
+         :err  => sub-process's stderr (as byte[] or String)
+       when not given or followed by false, sh returns a single
+       array or String of the sub-process's stdout followed by its
+       stderr
+:env   override the process env with a map (or the underlying Java
+       String[] if you are a masochist).
+:dir   override the process dir with a String or java.io.File.
+
+You can bind :env or :dir for multiple operations using with-sh-env
+and with-sh-dir.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/singleton-api.html b/branch-master/singleton-api.html new file mode 100644 index 00000000..3c630712 --- /dev/null +++ b/branch-master/singleton-api.html @@ -0,0 +1,139 @@ + + + singleton - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for singleton + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.singleton))
+
+

Overview

+
Singleton functions
+ + +
+

Public Variables and Functions

+
+
+
+

global-singleton

+ function
+
Usage: (global-singleton f)
+
+
Returns a global singleton function.  f is a function of no
+arguments that creates and returns some object.  The singleton
+function will call f just once, the first time it is needed, and
+cache the value for all subsequent calls.
+
+Warning: global singletons are often unsafe in multi-threaded code.
+Consider per-thread-singleton instead.
+ + + Source +
+
+
+

per-thread-singleton

+ function
+
Usage: (per-thread-singleton f)
+
+
Returns a per-thread singleton function.  f is a function of no
+arguments that creates and returns some object.  The singleton
+function will call f only once for each thread, and cache its value
+for subsequent calls from the same thread.  This allows you to
+safely and lazily initialize shared objects on a per-thread basis.
+
+Warning: due to a bug in JDK 5, it may not be safe to use a
+per-thread-singleton in the initialization function for another
+per-thread-singleton.  See
+http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5025230
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/sql-api.html b/branch-master/sql-api.html new file mode 100644 index 00000000..b16baba0 --- /dev/null +++ b/branch-master/sql-api.html @@ -0,0 +1,549 @@ + + + sql - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for sql + - clojure-contrib next (in development) +

+by Stephen C. Gilardi
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.sql))
+
+

Overview

+
A Clojure interface to sql databases via jdbc.
+ + +See also: + + Example code +
+

+

Public Variables and Functions

+
+
+
+

connection

+ function
+
Usage: (connection)
+
+
Returns the current database connection (or throws if there is none)
+ + + Source +
+
+
+

create-table

+ function
+
Usage: (create-table name & specs)
+
+
Creates a table on the open database connection given a table name and
+specs. Each spec is either a column spec: a vector containing a column
+name and optionally a type and other constraints, or a table-level
+constraint: a vector containing words that express the constraint. All
+words used to describe the table may be supplied as strings or keywords.
+ + + Source +
+
+
+

delete-rows

+ function
+
Usage: (delete-rows table where-params)
+
+
Deletes rows from a table. where-params is a vector containing a string
+providing the (optionally parameterized) selection criteria followed by
+values for any parameters.
+ + + Source +
+
+
+

do-commands

+ function
+
Usage: (do-commands & commands)
+
+
Executes SQL commands on the open database connection.
+ + + Source +
+
+
+

do-prepared

+ function
+
Usage: (do-prepared sql & param-groups)
+
+
Executes an (optionally parameterized) SQL prepared statement on the
+open database connection. Each param-group is a seq of values for all of
+the parameters.
+ + + Source +
+
+
+

drop-table

+ function
+
Usage: (drop-table name)
+
+
Drops a table on the open database connection given its name, a string
+or keyword
+ + + Source +
+
+
+

find-connection

+ function
+
Usage: (find-connection)
+
+
Returns the current database connection (or nil if there is none)
+ + + Source +
+
+
+

insert-records

+ function
+
Usage: (insert-records table & records)
+
+
Inserts records into a table. records are maps from strings or
+keywords (identifying columns) to values.
+ + + Source +
+
+
+

insert-rows

+ function
+
Usage: (insert-rows table & rows)
+
+
Inserts complete rows into a table. Each row is a vector of values for
+each of the table's columns in order.
+ + + Source +
+
+
+

insert-values

+ function
+
Usage: (insert-values table column-names & value-groups)
+
+
Inserts rows into a table with values for specified columns only.
+column-names is a vector of strings or keywords identifying columns. Each
+value-group is a vector containing a values for each column in
+order. When inserting complete rows (all columns), consider using
+insert-rows instead.
+ + + Source +
+
+
+

is-rollback-only

+ function
+
Usage: (is-rollback-only)
+
+
Returns true if the outermost transaction will rollback rather than
+commit when complete
+ + + Source +
+
+
+

set-rollback-only

+ function
+
Usage: (set-rollback-only)
+
+
Marks the outermost transaction such that it will rollback rather than
+commit when complete
+ + + Source +
+
+
+

transaction

+ macro
+
Usage: (transaction & body)
+
+
Evaluates body as a transaction on the open database connection. Any
+nested transactions are absorbed into the outermost transaction. By
+default, all database updates are committed together as a group after
+evaluating the outermost body, or rolled back on any uncaught
+exception. If set-rollback-only is called within scope of the outermost
+transaction, the entire transaction will be rolled back rather than
+committed when complete.
+ + + Source +
+
+
+

update-or-insert-values

+ function
+
Usage: (update-or-insert-values table where-params record)
+
+
Updates values on selected rows in a table, or inserts a new row when no
+existing row matches the selection criteria. where-params is a vector
+containing a string providing the (optionally parameterized) selection
+criteria followed by values for any parameters. record is a map from
+strings or keywords (identifying columns) to updated values.
+ + + Source +
+
+
+

update-values

+ function
+
Usage: (update-values table where-params record)
+
+
Updates values on selected rows in a table. where-params is a vector
+containing a string providing the (optionally parameterized) selection
+criteria followed by values for any parameters. record is a map from
+strings or keywords (identifying columns) to updated values.
+ + + Source +
+
+
+

with-connection

+ macro
+
Usage: (with-connection db-spec & body)
+
+
Evaluates body in the context of a new connection to a database then
+closes the connection. db-spec is a map containing values for one of the
+following parameter sets:
+
+Factory:
+  :factory     (required) a function of one argument, a map of params
+  (others)     (optional) passed to the factory function in a map
+
+DriverManager:
+  :classname   (required) a String, the jdbc driver class name
+  :subprotocol (required) a String, the jdbc subprotocol
+  :subname     (required) a String, the jdbc subname
+  (others)     (optional) passed to the driver as properties.
+
+DataSource:
+  :datasource  (required) a javax.sql.DataSource
+  :username    (optional) a String
+  :password    (optional) a String, required if :username is supplied
+
+JNDI:
+  :name        (required) a String or javax.naming.Name
+  :environment (optional) a java.util.Map
+ + + Source +
+
+
+

with-query-results

+ macro
+
Usage: (with-query-results results sql-params & body)
+
+
Executes a query, then evaluates body with results bound to a seq of the
+results. sql-params is a vector containing a string providing
+the (optionally parameterized) SQL query followed by values for any
+parameters.
+ + + Source +
+

sql.internal

+

+
+
+
+
+
+

connection*

+ function
+
Usage: (connection*)
+
+
Returns the current database connection (or throws if there is none)
+ + + Source +
+
+

find-connection*

+ function
+
Usage: (find-connection*)
+
+
Returns the current database connection (or nil if there is none)
+ + + Source +
+
+

get-connection

+ function
+
Usage: (get-connection {:keys [factory classname subprotocol subname datasource username password name environment], :as db-spec})
+
+
Creates a connection to a database. db-spec is a map containing values
+for one of the following parameter sets:
+
+Factory:
+  :factory     (required) a function of one argument, a map of params
+  (others)     (optional) passed to the factory function in a map
+
+DriverManager:
+  :classname   (required) a String, the jdbc driver class name
+  :subprotocol (required) a String, the jdbc subprotocol
+  :subname     (required) a String, the jdbc subname
+  (others)     (optional) passed to the driver as properties.
+
+DataSource:
+  :datasource  (required) a javax.sql.DataSource
+  :username    (optional) a String
+  :password    (optional) a String, required if :username is supplied
+
+JNDI:
+  :name        (required) a String or javax.naming.Name
+  :environment (optional) a java.util.Map
+ + + Source +
+
+

print-sql-exception

+ function
+
Usage: (print-sql-exception stream exception)
+
+
Prints the contents of an SQLException to stream
+ + + Source +
+
+

print-sql-exception-chain

+ function
+
Usage: (print-sql-exception-chain stream exception)
+
+
Prints a chain of SQLExceptions to stream
+ + + Source +
+
+

print-update-counts

+ function
+
Usage: (print-update-counts stream exception)
+
+
Prints the update counts from a BatchUpdateException to stream
+ + + Source +
+
+

rollback

+ function
+
Usage: (rollback)
+       (rollback val)
+
+
Accessor for the rollback flag on the current connection
+ + + Source +
+
+

throw-rollback

+ function
+
Usage: (throw-rollback e)
+
+
Sets rollback and throws a wrapped exception
+ + + Source +
+
+

transaction*

+ function
+
Usage: (transaction* func)
+
+
Evaluates func as a transaction on the open database connection. Any
+nested transactions are absorbed into the outermost transaction. By
+default, all database updates are committed together as a group after
+evaluating the outermost body, or rolled back on any uncaught
+exception. If rollback is set within scope of the outermost transaction,
+the entire transaction will be rolled back rather than committed when
+complete.
+ + + Source +
+
+

with-connection*

+ function
+
Usage: (with-connection* db-spec func)
+
+
Evaluates func in the context of a new connection to a database then
+closes the connection.
+ + + Source +
+
+

with-query-results*

+ function
+
Usage: (with-query-results* [sql & params :as sql-params] func)
+
+
Executes a query, then evaluates func passing in a seq of the results as
+an argument. The first argument is a vector containing the (optionally
+parameterized) sql query string followed by values for any parameters.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/str-utils-api.html b/branch-master/str-utils-api.html new file mode 100644 index 00000000..f02b75d5 --- /dev/null +++ b/branch-master/str-utils-api.html @@ -0,0 +1,212 @@ + + + str-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for str-utils + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.str-utils))
+
+

Overview

+
String utilities for Clojure
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

chomp

+ function
+
Usage: (chomp s)
+
+
Removes all trailing newline \n or return \r characters from
+string.  Note: String.trim() is similar and faster.
+ + + Source +
+
+
+

chop

+ function
+
Usage: (chop s)
+
+
Removes the last character of string.
+ + + Source +
+
+
+

re-gsub

+ function
+
Usage: (re-gsub regex replacement string)
+
+
Replaces all instances of 'pattern' in 'string' with
+'replacement'.  Like Ruby's 'String#gsub'.
+
+If (ifn? replacment) is true, the replacement is called with the
+match.
+
+ + + Source +
+
+
+

re-partition

+ function
+
Usage: (re-partition re string)
+
+
Splits the string into a lazy sequence of substrings, alternating
+between substrings that match the patthern and the substrings
+between the matches.  The sequence always starts with the substring
+before the first match, or an empty string if the beginning of the
+string matches.
+
+For example: (re-partition #"[a-z]+" "abc123def")
+
+Returns: ("" "abc" "123" "def")
+ + + Source +
+
+
+

re-split

+ function
+
Usage: (re-split pattern string)
+       (re-split pattern string limit)
+
+
Splits the string on instances of 'pattern'.  Returns a sequence of
+strings.  Optional 'limit' argument is the maximum number of
+splits.  Like Perl's 'split'.
+ + + Source +
+
+
+

re-sub

+ function
+
Usage: (re-sub regex replacement string)
+
+
Replaces the first instance of 'pattern' in 'string' with
+'replacement'.  Like Ruby's 'String#sub'.
+
+If (ifn? replacement) is true, the replacement is called with
+the match.
+
+ + + Source +
+
+
+

str-join

+ function
+
Usage: (str-join separator sequence)
+
+
Returns a string of all elements in 'sequence', separated by
+'separator'.  Like Perl's 'join'.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/str-utils2-api.html b/branch-master/str-utils2-api.html new file mode 100644 index 00000000..c3233d4d --- /dev/null +++ b/branch-master/str-utils2-api.html @@ -0,0 +1,578 @@ + + + str-utils2 - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for str-utils2 + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.str-utils2))
+
+

Overview

+
This is a library of string manipulation functions.  It
+is intented as a replacement for clojure.contrib.str-utils.
+
+You cannot (use 'clojure.contrib.str-utils2) because it defines
+functions with the same names as functions in clojure.core.
+Instead, do (require '[clojure.contrib.str-utils2 :as s]) 
+or something similar.
+
+Goals:
+  1. Be functional
+  2. String argument first, to work with ->
+  3. Performance linear in string length
+
+Some ideas are borrowed from
+http://github.com/francoisdevlin/devlinsf-clojure-utils/
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

blank?

+ function
+
Usage: (blank? s)
+
+
True if s is nil, empty, or contains only whitespace.
+ + + Source +
+
+
+

butlast

+ function
+
Usage: (butlast s n)
+
+
Returns s without the last n characters.  Returns an empty string
+if n is greater than the length of s.
+
+Note the argument order is the opposite of clojure.core/butlast;
+this is to keep the string as the first argument for use with ->
+ + + Source +
+
+
+

capitalize

+ function
+
Usage: (capitalize s)
+
+
Converts first character of the string to upper-case, all other
+characters to lower-case.
+ + + Source +
+
+
+

chomp

+ function
+
Usage: (chomp s)
+
+
Removes all trailing newline \n or return \r characters from
+string.  Note: String.trim() is similar and faster.
+ + + Source +
+
+
+

chop

+ function
+
Usage: (chop s)
+
+
Removes the last character of string, does nothing on a zero-length
+string.
+ + + Source +
+
+
+

codepoints

+ function
+
Usage: (codepoints s)
+
+
Returns a sequence of integer Unicode code points in s.  Handles
+Unicode supplementary characters (above U+FFFF) correctly.
+ + + Source +
+
+
+

contains?

+ function
+
Usage: (contains? s substring)
+
+
True if s contains the substring.
+ + + Source +
+
+
+

dochars

+ macro
+
Usage: (dochars bindings & body)
+
+
bindings => [name string]
+
+Repeatedly executes body, with name bound to each character in
+string.  Does NOT handle Unicode supplementary characters (above
+U+FFFF).
+ + + Source +
+
+
+

docodepoints

+ macro
+
Usage: (docodepoints bindings & body)
+
+
bindings => [name string]
+
+Repeatedly executes body, with name bound to the integer code point
+of each Unicode character in the string.  Handles Unicode
+supplementary characters (above U+FFFF) correctly.
+ + + Source +
+
+
+

drop

+ function
+
Usage: (drop s n)
+
+
Drops first n characters from s.  Returns an empty string if n is
+greater than the length of s.
+
+Note the argument order is the opposite of clojure.core/drop; this
+is to keep the string as the first argument for use with ->
+ + + Source +
+
+
+

escape

+ function
+
Usage: (escape s cmap)
+
+
Returns a new String by applying cmap (a function or a map) to each
+character in s.  If cmap returns nil, the original character is
+added to the output unchanged.
+ + + Source +
+
+
+

get

+ function
+
Usage: (get s i)
+
+
Gets the i'th character in string.
+ + + Source +
+
+
+

grep

+ function
+
Usage: (grep re coll)
+
+
Filters elements of coll by a regular expression.  The String
+representation (with str) of each element is tested with re-find.
+ + + Source +
+
+
+

join

+ function
+
Usage: (join separator coll)
+
+
Returns a string of all elements in coll, separated by
+separator.  Like Perl's join.
+ + + Source +
+
+
+

lower-case

+ function
+
Usage: (lower-case s)
+
+
Converts string to all lower-case.
+ + + Source +
+
+
+

ltrim

+ function
+
Usage: (ltrim s)
+
+
Removes whitespace from the left side of string.
+ + + Source +
+
+
+

map-str

+ function
+
Usage: (map-str f coll)
+
+
Apply f to each element of coll, concatenate all results into a
+String.
+ + + Source +
+
+
+

partial

+ function
+
Usage: (partial f & args)
+
+
Like clojure.core/partial for functions that take their primary
+argument first.
+
+Takes a function f and its arguments, NOT INCLUDING the first
+argument.  Returns a new function whose first argument will be the
+first argument to f.
+
+Example: (str-utils2/partial str-utils2/take 2)
+         ;;=> (fn [s] (str-utils2/take s 2))
+ + + Source +
+
+
+

partition

+ function
+
Usage: (partition s re)
+
+
Splits the string into a lazy sequence of substrings, alternating
+between substrings that match the patthern and the substrings
+between the matches.  The sequence always starts with the substring
+before the first match, or an empty string if the beginning of the
+string matches.
+
+For example: (partition "abc123def" #"[a-z]+")
+returns: ("" "abc" "123" "def")
+ + + Source +
+
+
+

repeat

+ function
+
Usage: (repeat s n)
+
+
Returns a new String containing s repeated n times.
+ + + Source +
+
+
+

replace

+ multimethod
+
Usage: (replace string pattern replacement)
+
+
Replaces all instances of pattern in string with replacement.  
+
+Allowed argument types for pattern and replacement are:
+ 1. String and String
+ 2. Character and Character
+ 3. regex Pattern and String
+    (Uses java.util.regex.Matcher.replaceAll)
+ 4. regex Pattern and function
+    (Calls function with re-groups of each match, uses return 
+     value as replacement.)
+ + + Source +
+
+
+

replace-first

+ multimethod
+
Usage: (replace-first s pattern replacement)
+
+
Replaces the first instance of pattern in s with replacement.
+
+Allowed argument types for pattern and replacement are:
+ 1. String and String
+ 2. regex Pattern and String
+    (Uses java.util.regex.Matcher.replaceAll)
+ 3. regex Pattern and function
+ + + Source +
+
+
+

reverse

+ function
+
Usage: (reverse s)
+
+
Returns s with its characters reversed.
+ + + Source +
+
+
+

rtrim

+ function
+
Usage: (rtrim s)
+
+
Removes whitespace from the right side of string.
+ + + Source +
+
+
+

split

+ function
+
Usage: (split s re)
+       (split s re limit)
+
+
Splits string on a regular expression.  Optional argument limit is
+the maximum number of splits.
+ + + Source +
+
+
+

split-lines

+ function
+
Usage: (split-lines s)
+
+
Splits s on \n or \r\n.
+ + + Source +
+
+
+

swap-case

+ function
+
Usage: (swap-case s)
+
+
Changes upper case characters to lower case and vice-versa.
+Handles Unicode supplementary characters correctly.  Uses the
+locale-sensitive String.toUpperCase() and String.toLowerCase()
+methods.
+ + + Source +
+
+
+

tail

+ function
+
Usage: (tail s n)
+
+
Returns the last n characters of s.
+ + + Source +
+
+
+

take

+ function
+
Usage: (take s n)
+
+
Take first n characters from s, up to the length of s.
+
+Note the argument order is the opposite of clojure.core/take; this
+is to keep the string as the first argument for use with ->
+ + + Source +
+
+
+

trim

+ function
+
Usage: (trim s)
+
+
Removes whitespace from both ends of string.
+ + + Source +
+
+
+

upper-case

+ function
+
Usage: (upper-case s)
+
+
Converts string to all upper-case.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/stream-utils-api.html b/branch-master/stream-utils-api.html new file mode 100644 index 00000000..9f3cf70a --- /dev/null +++ b/branch-master/stream-utils-api.html @@ -0,0 +1,310 @@ + + + stream-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for stream-utils + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.stream-utils))
+
+

Overview

+
Functions for setting up computational pipelines via data streams.
+
+NOTE: This library is experimental. It may change significantly
+      with future release.
+
+This library defines:
+- an abstract stream type, whose interface consists of the
+  multimethod stream-next
+- a macro for implementing streams
+- implementations of stream for
+  1) Clojure sequences, and vectors
+  2) nil, representing an empty stream
+- tools for writing stream transformers, including the
+  monad stream-m
+- various utility functions for working with streams
+
+Streams are building blocks in the construction of computational
+pipelines. A stream is represented by its current state plus
+a function that takes a stream state and obtains the next item
+in the stream as well as the new stream state. The state is
+implemented as a Java class or a Clojure type (as defined by the
+function clojure.core/type), and the function is provided as an
+implementation of the multimethod stream-next for this class or type.
+
+While setting up pipelines using this mechanism is somewhat more
+cumbersome than using Clojure's lazy seq mechanisms, there are a
+few advantages:
+- The state of a stream can be stored in any Clojure data structure,
+  and the stream can be re-generated from it any number of times.
+  Any number of states can be stored this way.
+- The elements of the stream are never cached, so keeping a reference
+  to a stream state does not incur an uncontrollable memory penalty.
+
+Note that the stream mechanism is thread-safe as long as the
+concrete stream implementations do not use any mutable state.
+
+Stream transformers take any number of input streams and produce one
+output stream. They are typically written using the stream-m
+monad. In the definition of a stream transformer, (pick s) returns
+the next value of stream argument s, whereas pick-all returns the
+next value of all stream arguments in the form of a vector.
+ + +
+

Public Variables and Functions

+
+
+
+

defst

+ macro
+
Usage: (defst name args streams & body)
+
+
Define the stream transformer name by body.
+The non-stream arguments args and the stream arguments streams
+are given separately, with args being possibly empty.
+ + + Source +
+
+
+

defstream

+ macro
+
Usage: (defstream type-tag args & body)
+
+
Define object of the given type as a stream whose implementation
+of stream-next is defined by args and body. This macro adds
+a type-specific method for stream-next and derives type
+from stream-type.
+ + + Source +
+
+
+

pick

+ function
+
Usage: (pick n)
+
+
Return the next value of stream argument n inside a stream
+transformer. When used inside of defst, the name of the stream
+argument can be used instead of its index n.
+ + + Source +
+
+
+

pick-all

+ function
+
Usage: (pick-all streams)
+
+
Return a vector containing the next value of each stream argument
+inside a stream transformer.
+ + + Source +
+
+
+

stream-drop

+ function
+
Usage: (stream-drop n stream)
+
+
Return a stream containing all but the first n elements of stream.
+ + + Source +
+
+
+

stream-filter

+ multimethod
+
Usage: (stream-filter p stream)
+
+
Return a new stream that contrains the elements of stream
+that satisfy the predicate p.
+ + + Source +
+
+
+

stream-flatten

+ function
+
Usage: (stream-flatten s)
+
+
Converts a stream of sequences into a stream of the elements of the
+sequences. Flattening is not recursive, only one level of nesting
+will be removed.
+ + + Source +
+
+
+

stream-m

+ var
+

+  
Monad describing stream computations. The monadic values can be
+of any type handled by stream-next.
+ + + Source +
+
+
+

stream-map

+ multimethod
+
Usage: (stream-map f stream)
+
+
Return a new stream by mapping the function f on the given stream.
+ + + Source +
+
+
+

stream-next

+ multimethod
+
Usage: (stream-next stream-state)
+
+
Returns a vector [next-value new-state] where next-value is the next
+item in the data stream defined by stream-state and new-state
+is the new state of the stream. At the end of the stream,
+next-value and new-state are nil.
+ + + Source +
+
+
+

stream-seq

+ function
+
Usage: (stream-seq s)
+
+
Return a lazy seq on the stream. Also accessible via
+clojure.contrib.seq/seq-on and
+clojure.contrib.generic.collection/seq for streams.
+ + + Source +
+
+
+

stream-type

+ var
+

+  
The root type for the stream hierarchy. For each stream type,
+add a derivation from this type.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/string-api.html b/branch-master/string-api.html new file mode 100644 index 00000000..5f1d6ff5 --- /dev/null +++ b/branch-master/string-api.html @@ -0,0 +1,616 @@ + + + string - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for string + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.string))
+
+

Overview

+

+
+
+
+

Public Variables and Functions

+
+
+
+

as-str

+ function
+
Usage: (as-str)
+       (as-str x)
+       (as-str x & ys)
+
+
Like clojure.core/str, but if an argument is a keyword or symbol,
+its name will be used instead of its literal representation.
+
+Example:
+   (str :foo :bar)     ;;=> ":foo:bar"
+   (as-str :foo :bar)  ;;=> "foobar" 
+
+Note that this does not apply to keywords or symbols nested within
+data structures; they will be rendered as with str.
+
+Example:
+   (str {:foo :bar})     ;;=> "{:foo :bar}"
+   (as-str {:foo :bar})  ;;=> "{:foo :bar}" 
+ + + Source +
+
+
+

blank?

+ function
+
Usage: (blank? s)
+
+
True if s is nil, empty, or contains only whitespace.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

butlast

+ function
+
Usage: (butlast n s)
+
+
Returns s without the last n characters.  Returns an empty string
+if n is greater than the length of s.
+ + + Source +
+
+
+

capitalize

+ function
+
Usage: (capitalize s)
+
+
Converts first character of the string to upper-case, all other
+characters to lower-case.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

chomp

+ function
+
Usage: (chomp s)
+
+
Removes all trailing newline \n or return \r characters from
+string.  Note: String.trim() is similar and faster.
+Deprecated in 1.2. Use clojure.string/trim-newline
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

chop

+ function
+
Usage: (chop s)
+
+
Removes the last character of string, does nothing on a zero-length
+string.
+ + + Source +
+
+
+

codepoints

+ function
+
Usage: (codepoints s)
+
+
Returns a sequence of integer Unicode code points in s.  Handles
+Unicode supplementary characters (above U+FFFF) correctly.
+ + + Source +
+
+
+

dochars

+ macro
+
Usage: (dochars bindings & body)
+
+
bindings => [name string]
+
+Repeatedly executes body, with name bound to each character in
+string.  Does NOT handle Unicode supplementary characters (above
+U+FFFF).
+ + + Source +
+
+
+

docodepoints

+ macro
+
Usage: (docodepoints bindings & body)
+
+
bindings => [name string]
+
+Repeatedly executes body, with name bound to the integer code point
+of each Unicode character in the string.  Handles Unicode
+supplementary characters (above U+FFFF) correctly.
+ + + Source +
+
+
+

drop

+ function
+
Usage: (drop n s)
+
+
Drops first n characters from s.  Returns an empty string if n is
+greater than the length of s.
+ + + Source +
+
+
+

escape

+ function
+
Usage: (escape cmap s)
+
+
Returns a new String by applying cmap (a function or a map) to each
+character in s.  If cmap returns nil, the original character is
+added to the output unchanged.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

get

+ function
+
Usage: (get s i)
+
+
Gets the i'th character in string.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

grep

+ function
+
Usage: (grep re coll)
+
+
Filters elements of coll by a regular expression.  The String
+representation (with str) of each element is tested with re-find.
+ + + Source +
+
+
+

join

+ function
+
Usage: (join separator coll)
+
+
Returns a string of all elements in coll, separated by
+separator.  Like Perl's join.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

lower-case

+ function
+
Usage: (lower-case s)
+
+
Converts string to all lower-case.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

ltrim

+ function
+
Usage: (ltrim s)
+
+
Removes whitespace from the left side of string.
+Deprecated in 1.2. Use clojure.string/triml.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

map-str

+ function
+
Usage: (map-str f coll)
+
+
Apply f to each element of coll, concatenate all results into a
+String.
+ + + Source +
+
+
+

partition

+ function
+
Usage: (partition re s)
+
+
Splits the string into a lazy sequence of substrings, alternating
+between substrings that match the patthern and the substrings
+between the matches.  The sequence always starts with the substring
+before the first match, or an empty string if the beginning of the
+string matches.
+
+For example: (partition #"[a-z]+" "abc123def")
+returns: ("" "abc" "123" "def")
+ + + Source +
+
+
+

repeat

+ function
+
Usage: (repeat n s)
+
+
Returns a new String containing s repeated n times.
+ + + Source +
+
+
+

replace-by

+ function
+
Usage: (replace-by re f s)
+
+
Replaces all matches of re in s with the result of 
+(f (re-groups the-match)).
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

replace-char

+ function
+
Usage: (replace-char a b s)
+
+
Replaces all instances of character a with character b in s.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

replace-first-by

+ function
+
Usage: (replace-first-by re f s)
+
+
Replace first match of re in s with the result of
+(f (re-groups the-match)).
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

replace-first-re

+ function
+
Usage: (replace-first-re re replacement s)
+
+
Replace first match of re in s.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

replace-first-str

+ function
+
Usage: (replace-first-str a b s)
+
+
Replace first occurance of substring a with b in s.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

replace-re

+ function
+
Usage: (replace-re re replacement s)
+
+
Replaces all matches of re with replacement in s.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

replace-str

+ function
+
Usage: (replace-str a b s)
+
+
Replaces all instances of substring a with b in s.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

reverse

+ function
+
Usage: (reverse s)
+
+
Returns s with its characters reversed.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

rtrim

+ function
+
Usage: (rtrim s)
+
+
Removes whitespace from the right side of string.
+Deprecated in 1.2. Use clojure.string/trimr.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

split

+ function
+
Usage: (split re s)
+       (split re limit s)
+
+
Splits string on a regular expression.  Optional argument limit is
+the maximum number of splits.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

split-lines

+ function
+
Usage: (split-lines s)
+
+
Splits s on \n or \r\n.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

substring?

+ function
+
Usage: (substring? substring s)
+
+
True if s contains the substring.
+ + + Source +
+
+
+

swap-case

+ function
+
Usage: (swap-case s)
+
+
Changes upper case characters to lower case and vice-versa.
+Handles Unicode supplementary characters correctly.  Uses the
+locale-sensitive String.toUpperCase() and String.toLowerCase()
+methods.
+ + + Source +
+
+
+

tail

+ function
+
Usage: (tail n s)
+
+
Returns the last n characters of s.
+ + + Source +
+
+
+

take

+ function
+
Usage: (take n s)
+
+
Take first n characters from s, up to the length of s.
+ + + Source +
+
+
+

trim

+ function
+
Usage: (trim s)
+
+
Removes whitespace from both ends of string.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+
+
+

upper-case

+ function
+
Usage: (upper-case s)
+
+
Converts string to all upper-case.
+ + Deprecated since clojure-contrib version 1.2
+ Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/strint-api.html b/branch-master/strint-api.html new file mode 100644 index 00000000..1ad442e2 --- /dev/null +++ b/branch-master/strint-api.html @@ -0,0 +1,130 @@ + + + strint - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for strint + - clojure-contrib next (in development) +

+by Chas Emerick
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.strint))
+
+

Overview

+
String interpolation for Clojure.
+ + +
+

Public Variables and Functions

+
+
+
+

<<

+ macro
+
Usage: (<< string)
+
+
Takes a single string argument and emits a str invocation that concatenates
+the string data and evaluated expressions contained within that argument.
+Evaluation is controlled using ~{} and ~() forms.  The former is used for
+simple value replacement using clojure.core/str; the latter can be used to
+embed the results of arbitrary function invocation into the produced string.
+
+Examples:
+user=> (def v 30.5)
+#'user/v
+user=> (<< "This trial required ~{v}ml of solution.")
+"This trial required 30.5ml of solution."
+user=> (<< "There are ~(int v) days in November.")
+"There are 30 days in November."
+user=> (def m {:a [1 2 3]})
+#'user/m
+user=> (<< "The total for your order is $~(->> m :a (apply +)).")
+"The total for your order is $6."
+
+Note that quotes surrounding string literals within ~() forms must be
+escaped.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/swing-utils-api.html b/branch-master/swing-utils-api.html new file mode 100644 index 00000000..6b664c10 --- /dev/null +++ b/branch-master/swing-utils-api.html @@ -0,0 +1,249 @@ + + + swing-utils - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for swing-utils + - clojure-contrib next (in development) +

+ +
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.swing-utils))
+
+

Overview

+

+
+
+
+

Public Variables and Functions

+
+
+
+

action-translation-table

+ var
+

+  
Translation table for the make-action constructor.
+ + + Source +
+
+
+

add-action-listener

+ function
+
Usage: (add-action-listener component f & args)
+
+
Adds an ActionLister to component. When the action fires, f will be
+invoked with the event as its first argument followed by args.
+Returns the listener.
+ + + Source +
+
+
+

add-key-typed-listener

+ function
+
Usage: (add-key-typed-listener component f & args)
+
+
Adds a KeyListener to component that only responds to KeyTyped events.
+When a key is typed, f is invoked with the KeyEvent as its first argument
+followed by args. Returns the listener.
+ + + Source +
+
+
+

add-menu-item

+ multimethod
+
Usage: (add-menu-item parent item)
+
+
Adds a menu item to the parent according to the item description.
+  The item description is a map of the following structure.
+
+Either:
+  - one single :action specifying a javax.swing.Action to be associated
+    with the item.
+  - a specification suitable for make-action
+  - a set of :name, :mnemonic and :items keys, specifying a submenu with
+    the given sequence of item entries.
+  - an empty map specifying a separator.
+ + + Source +
+
+
+

do-swing

+ macro
+
Usage: (do-swing & body)
+
+
Executes body in the Swing event thread asynchronously. Returns
+immediately after scheduling the execution.
+ + + Source +
+
+
+

do-swing*

+ function
+
Usage: (do-swing* schedule thunk)
+
+
Runs thunk in the Swing event thread according to schedule:
+- :later => schedule the execution and return immediately
+- :now   => wait until the execution completes.
+ + + Source +
+
+
+

do-swing-and-wait

+ macro
+
Usage: (do-swing-and-wait & body)
+
+
Executes body in the Swing event thread synchronously. Returns
+after the execution is complete.
+ + + Source +
+
+
+

make-action

+ function
+
Usage: (make-action spec)
+
+
Create an Action proxy from the given action spec. The standard keys
+recognised are: :name, :accelerator, :command-key, :long-desc,
+:short-desc, :mnemonic and :icon - corresponding to the similar named
+Action properties.  The :handler value is used in the actionPerformed
+method of the proxy to pass on the event.
+ + + Source +
+
+
+

make-menubar

+ function
+
Usage: (make-menubar menubar-items)
+
+
Create a menubar containing the given sequence of menu items. The menu
+items are described by a map as is detailed in the docstring of the
+add-menu-item function.
+ + + Source +
+
+
+

menu-constructor-dispatch

+ var
+

+  
An atom containing the dispatch set for the add-menu-item method.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/test-is-api.html b/branch-master/test-is-api.html new file mode 100644 index 00000000..e9d33228 --- /dev/null +++ b/branch-master/test-is-api.html @@ -0,0 +1,663 @@ + + + test-is - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for test-is + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.test-is))
+
+

Overview

+
Backwards-compatibility for clojure.contrib.test-is
+
+The clojure.contrib.test-is library moved from Contrib into the
+Clojure distribution as clojure.test.
+
+This happened on or around clojure-contrib Git commit
+82cf0409d0fcb71be477ebfc4da18ee2128a2ad1 on June 25, 2009.
+
+This file makes the clojure.test interface available under the old
+namespace clojure.contrib.test-is.
+
+This includes support for the old syntax of the 'are' macro.
+
+This was suggested by Howard Lewis Ship in ticket #26, 
+http://www.assembla.com/spaces/clojure-contrib/tickets/26
+ +Deprecated since clojure-contrib version 1.2
+
+

Public Variables and Functions

+
+
+
+

*load-tests*

+ var
+

+  
True by default.  If set to false, no test functions will
+be created by deftest, set-test, or with-test.  Use this to omit
+tests when compiling or loading production code.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

*stack-trace-depth*

+ var
+

+  
The maximum depth of stack traces to print when an Exception
+is thrown during a test.  Defaults to nil, which means print the 
+complete stack trace.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

apply-template

+ function
+
Usage: (apply-template expr values)
+
+
Replaces _1, _2, _3, etc. in expr with corresponding elements of
+values.  Returns the modified expression.  For use in macros.
+ + + Source +
+
+
+

are

+ macro
+
Usage: (are expr & args)
+
+
Checks multiple assertions with a template expression.
+See clojure.contrib.template/do-template for an explanation of
+templates.
+
+Example: (are (= _1 _2)  
+              2 (+ 1 1)
+              4 (* 2 2))
+Expands to: 
+         (do (is (= 2 (+ 1 1)))
+             (is (= 4 (* 2 2))))
+
+Note: This breaks some reporting features, such as line numbers.
+ + + Source +
+
+
+

assert-any

+ function
+
Usage: (assert-any msg form)
+
+
Returns generic assertion code for any test, including macros, Java
+method calls, or isolated symbols.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

assert-predicate

+ function
+
Usage: (assert-predicate msg form)
+
+
Returns generic assertion code for any functional predicate.  The
+'expected' argument to 'report' will contains the original form, the
+'actual' argument will contain the form with all its sub-forms
+evaluated.  If the predicate returns false, the 'actual' form will
+be wrapped in (not...).
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

compose-fixtures

+ function
+
Usage: (compose-fixtures f1 f2)
+
+
Composes two fixture functions, creating a new fixture function
+that combines their behavior.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

deftest

+ macro
+
Usage: (deftest name & body)
+
+
Defines a test function with no arguments.  Test functions may call
+other tests, so tests may be composed.  If you compose tests, you
+should also define a function named test-ns-hook; run-tests will
+call test-ns-hook instead of testing all vars.
+
+Note: Actually, the test body goes in the :test metadata on the var,
+and the real function (the value of the var) calls test-var on
+itself.
+
+When *load-tests* is false, deftest is ignored.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

deftest-

+ macro
+
Usage: (deftest- name & body)
+
+
Like deftest but creates a private var.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

do-template

+ macro
+
Usage: (do-template expr & args)
+
+
Repeatedly evaluates template expr (in a do block) using values in
+args.  args are grouped by the number of holes in the template.
+Example: (do-template (check _1 _2) :a :b :c :d)
+expands to (do (check :a :b) (check :c :d))
+ + + Source +
+
+
+

file-position

+ function
+
Usage: (file-position n)
+
+
Returns a vector [filename line-number] for the nth call up the
+stack.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

find-holes

+ function
+
Usage: (find-holes form)
+
+
Recursively finds all symbols starting with _ in form.
+ + + Source +
+
+
+

find-pure-exprs

+ function
+
Usage: (find-pure-exprs form)
+
+
Recursively finds all sub-expressions in form that do not contain
+any symbols starting with _
+ + + Source +
+
+
+

find-symbols

+ function
+
Usage: (find-symbols form)
+
+
Recursively finds all symbols in form.
+ + + Source +
+
+
+

flatten-map

+ function
+
Usage: (flatten-map m)
+
+
Transforms a map into a vector like [key value key value].
+ + + Source +
+
+
+

function?

+ function
+
Usage: (function? x)
+
+
Returns true if argument is a function or a symbol that resolves to
+a function (not a macro).
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

get-possibly-unbound-var

+ function
+
Usage: (get-possibly-unbound-var v)
+
+
Like var-get but returns nil if the var is unbound.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

inc-report-counter

+ function
+
Usage: (inc-report-counter name)
+
+
Increments the named counter in *report-counters*, a ref to a map.
+Does nothing if *report-counters* is nil.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

is

+ macro
+
Usage: (is form)
+       (is form msg)
+
+
Generic assertion macro.  'form' is any predicate test.
+'msg' is an optional message to attach to the assertion.
+
+Example: (is (= 4 (+ 2 2)) "Two plus two should be 4")
+
+Special forms:
+
+(is (thrown? c body)) checks that an instance of c is thrown from
+body, fails if not; then returns the thing thrown.
+
+(is (thrown-with-msg? c re body)) checks that an instance of c is
+thrown AND that the message on the exception matches (with
+re-find) the regular expression re.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

join-fixtures

+ function
+
Usage: (join-fixtures fixtures)
+
+
Composes a collection of fixtures, in order.  Always returns a valid
+fixture function, even if the collection is empty.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

report

+ multimethod
+
No usage documentation available
+
Generic reporting function, may be overridden to plug in
+different report formats (e.g., TAP, JUnit).  Assertions such as
+'is' call 'report' to indicate results.  The argument given to
+'report' will be a map with a :type key.  See the documentation at
+the top of test_is.clj for more information on the types of
+arguments for 'report'.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

run-all-tests

+ function
+
Usage: (run-all-tests)
+       (run-all-tests re)
+
+
Runs all tests in all namespaces; prints results.
+Optional argument is a regular expression; only namespaces with
+names matching the regular expression (with re-matches) will be
+tested.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

run-tests

+ function
+
Usage: (run-tests)
+       (run-tests & namespaces)
+
+
Runs all tests in the given namespaces; prints results.
+Defaults to current namespace if none given.  Returns a map
+summarizing test results.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

set-test

+ macro
+
Usage: (set-test name & body)
+
+
Experimental.
+Sets :test metadata of the named var to a fn with the given body.
+The var must already exist.  Does not modify the value of the var.
+
+When *load-tests* is false, set-test is ignored.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

successful?

+ function
+
Usage: (successful? summary)
+
+
Returns true if the given test summary indicates all tests
+were successful, false otherwise.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

template?

+ function
+
Usage: (template? form)
+
+
Returns true if form is a valid template expression.
+ + + Source +
+
+
+

test-all-vars

+ function
+
Usage: (test-all-vars ns)
+
+
Calls test-var on every var interned in the namespace, with fixtures.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

test-ns

+ function
+
Usage: (test-ns ns)
+
+
If the namespace defines a function named test-ns-hook, calls that.
+Otherwise, calls test-all-vars on the namespace.  'ns' is a
+namespace object or a symbol.
+
+Internally binds *report-counters* to a ref initialized to
+*inital-report-counters*.  Returns the final, dereferenced state of
+*report-counters*.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

test-var

+ function
+
Usage: (test-var v)
+
+
If v has a function in its :test metadata, calls that function,
+with *testing-vars* bound to (conj *testing-vars* v).
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

testing

+ macro
+
Usage: (testing string & body)
+
+
Adds a new string to the list of testing contexts.  May be nested,
+but must occur inside a test function (deftest).
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

testing-contexts-str

+ function
+
Usage: (testing-contexts-str)
+
+
Returns a string representation of the current test context. Joins
+strings in *testing-contexts* with spaces.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

testing-vars-str

+ function
+
Usage: (testing-vars-str)
+
+
Returns a string representation of the current test.  Renders names
+in *testing-vars* as a list, then the source file and line of
+current assertion.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

try-expr

+ macro
+
Usage: (try-expr msg form)
+
+
Used by the 'is' macro to catch unexpected exceptions.
+You don't call this.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

use-fixtures

+ multimethod
+
No usage documentation available
+
Wrap test runs in a fixture function to perform setup and
+teardown. Using a fixture-type of :each wraps every test
+individually, while:once wraps the whole run in a single function.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

with-test

+ macro
+
Usage: (with-test definition & body)
+
+
Takes any definition form (that returns a Var) as the first argument.
+Remaining body goes in the :test metadata function for that Var.
+
+When *load-tests* is false, only evaluates the definition, ignoring
+the tests.
+ Added in clojure-contrib version 1.1
+ + +
+
+
+

with-test-out

+ macro
+
Usage: (with-test-out & body)
+
+
Runs body with *out* bound to the value of *test-out*.
+ Added in clojure-contrib version 1.1
+ + +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/trace-api.html b/branch-master/trace-api.html new file mode 100644 index 00000000..e7cce268 --- /dev/null +++ b/branch-master/trace-api.html @@ -0,0 +1,199 @@ + + + trace - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for trace + - clojure-contrib next (in development) +

+by Stuart Sierra, Michel Salim
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.trace))
+
+

Overview

+
This file defines simple "tracing" macros to help you see what your
+code is doing.
+ + +
+

Public Variables and Functions

+
+
+
+

*trace-depth*

+ var
+

+  
Current stack depth of traced function calls.
+ + + Source +
+
+
+

deftrace

+ macro
+
Usage: (deftrace name & definition)
+
+
Use in place of defn; traces each call/return of this fn, including
+arguments.  Nested calls to deftrace'd functions will print a
+tree-like structure.
+ + + Source +
+
+
+

dotrace

+ macro
+
Usage: (dotrace fnames & exprs)
+
+
Given a sequence of function identifiers, evaluate the body
+expressions in an environment in which the identifiers are bound to
+the traced functions.  Does not work on inlined functions,
+such as clojure.core/+
+ + + Source +
+
+
+

trace

+ function
+
Usage: (trace value)
+       (trace name value)
+
+
Sends name (optional) and value to the tracer function, then
+returns value.  May be wrapped around any expression without
+affecting the result.
+ + + Source +
+
+
+

trace-fn-call

+ function
+
Usage: (trace-fn-call name f args)
+
+
Traces a single call to a function f with args.  'name' is the
+symbol name of the function.
+ + + Source +
+
+
+

trace-indent

+ function
+
Usage: (trace-indent)
+
+
Returns an indentation string based on *trace-depth*
+ + + Source +
+
+
+

tracer

+ function
+
Usage: (tracer name value)
+
+
This function is called by trace.  Prints to standard output, but
+may be rebound to do anything you like.  'name' is optional.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/types-api.html b/branch-master/types-api.html new file mode 100644 index 00000000..8ebab67d --- /dev/null +++ b/branch-master/types-api.html @@ -0,0 +1,178 @@ + + + types - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for types + - clojure-contrib next (in development) +

+by Konrad Hinsen
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.types))
+
+

Overview

+
General and algebraic data types
+ + +
+

Public Variables and Functions

+
+
+
+

defadt

+ macro
+
Usage: (defadt type-tag & constructors)
+
+
Define an algebraic data type name by an exhaustive list of constructors.
+Each constructor can be a symbol (argument-free constructor) or a
+list consisting of a tag symbol followed by the argument symbols.
+The data type tag must be a keyword.
+ + + Source +
+
+
+

deftype

+ macro
+
Usage: (deftype type-tag constructor-name docstring? attr-map?)
+       (deftype type-tag constructor-name docstring? attr-map? constructor)
+       (deftype type-tag constructor-name docstring? attr-map? constructor deconstructor)
+
+
Define a data type by a type tag (a namespace-qualified keyword)
+and a symbol naming the constructor function. Optionally, a
+constructor and a deconstructor function can be given as well,
+the defaults being clojure.core/identity and clojure.core/list.
+The full constructor associated with constructor-name calls the
+constructor function and attaches the type tag to its result
+as metadata. The deconstructor function must return the arguments
+to be passed to the constructor in order to create an equivalent
+object. It is used for printing and matching.
+ + + Source +
+
+
+

deftype-

+ macro
+
Usage: (deftype- type-tag constructor-name & optional)
+
+
Same as deftype but the constructor is private.
+ + + Source +
+
+
+

match

+ macro
+
Usage: (match value & clauses)
+
+
Given a value and a list of template-expr clauses, evaluate the first
+expr whose template matches the value. There are four kinds of templates:
+1) Lists of the form (tag x1 x2 ...) match instances of types
+   whose constructor has the same form as the list.
+2) Quoted lists of the form '(x1 x2 ...) match lists of the same
+   length.
+3) Vectors of the form [x1 x2 ...] match vectors of the same length.
+4) Maps of the form {:key1 x1 :key2 x2 ...} match maps that have
+   the same keys as the template, but which can have additional keys
+   that are not part of the template.
+The values x1, x2, ... can be symbols or non-symbol values. Non-symbols
+must be equal to the corresponding values in the object to be matched.
+Symbols will be bound to the corresponding value in the object in the
+evaluation of expr. If the same symbol occurs more than once in a,
+template the corresponding elements of the object must be equal
+for the template to match.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/with-ns-api.html b/branch-master/with-ns-api.html new file mode 100644 index 00000000..93530ab3 --- /dev/null +++ b/branch-master/with-ns-api.html @@ -0,0 +1,127 @@ + + + with-ns - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for with-ns + - clojure-contrib next (in development) +

+by Stuart Sierra
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.with-ns))
+
+

Overview

+
Temporary namespace macro
+ + +
+

Public Variables and Functions

+
+
+
+

with-ns

+ macro
+
Usage: (with-ns ns & body)
+
+
Evaluates body in another namespace.  ns is either a namespace
+object or a symbol.  This makes it possible to define functions in
+namespaces other than the current one.
+ + + Source +
+
+
+

with-temp-ns

+ macro
+
Usage: (with-temp-ns & body)
+
+
Evaluates body in an anonymous namespace, which is then immediately
+removed.  The temporary namespace will 'refer' clojure.core.
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/branch-master/zip-filter-api.html b/branch-master/zip-filter-api.html new file mode 100644 index 00000000..9f00c36b --- /dev/null +++ b/branch-master/zip-filter-api.html @@ -0,0 +1,336 @@ + + + zip-filter - clojure-contrib next API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for zip-filter + - clojure-contrib next (in development) +

+by Chris Houser
+
Usage: +
+(ns your-namespace
+  (:require clojure.contrib.zip-filter))
+
+

Overview

+
System for filtering trees and nodes generated by zip.clj in
+general, and xml trees in particular.
+ + +
+

Public Variables and Functions

+
+
+
+

ancestors

+ function
+
Usage: (ancestors loc)
+
+
Returns a lazy sequence of all ancestors of location loc, starting
+with loc and proceeding to loc's parent node and on through to the
+root of the tree.
+ + + Source +
+
+
+

children

+ function
+
Usage: (children loc)
+
+
Returns a lazy sequence of all immediate children of location loc,
+left-to-right.
+ + + Source +
+
+
+

children-auto

+ function
+
Usage: (children-auto loc)
+
+
Returns a lazy sequence of all immediate children of location loc,
+left-to-right, marked so that a following tag= predicate will auto-descend.
+ + + Source +
+
+
+

descendants

+ function
+
Usage: (descendants loc)
+
+
Returns a lazy sequence of all descendants of location loc, in
+depth-first order, left-to-right, starting with loc.
+ + + Source +
+
+
+

left-locs

+ function
+
Usage: (left-locs loc)
+
+
Returns a lazy sequence of locations to the left of loc, starting with loc.
+ + + Source +
+
+
+

leftmost?

+ function
+
Usage: (leftmost? loc)
+
+
Returns true if there are no more nodes to the left of location loc.
+ + + Source +
+
+
+

right-locs

+ function
+
Usage: (right-locs loc)
+
+
Returns a lazy sequence of locations to the right of loc, starting with loc.
+ + + Source +
+
+
+

rightmost?

+ function
+
Usage: (rightmost? loc)
+
+
Returns true if there are no more nodes to the right of location loc.
+ + + Source +
+

zip-filter.xml

+

+
+
+
+
+
+

attr

+ function
+
Usage: (attr attrname)
+       (attr loc attrname)
+
+
Returns the xml attribute named attrname, of the xml node at location loc.
+ + + Source +
+
+

attr=

+ function
+
Usage: (attr= attrname attrval)
+
+
Returns a query predicate that matches a node when it has an
+attribute named attrname whose value is attrval.
+ + + Source +
+
+

seq-test

+ function
+
Usage: (seq-test preds)
+
+
Returns a query predicate that matches a node when its xml content
+matches the query expresions given.
+ + + Source +
+
+

tag=

+ function
+
Usage: (tag= tagname)
+
+
Returns a query predicate that matches a node when its is a tag
+named tagname.
+ + + Source +
+
+

text

+ function
+
Usage: (text loc)
+
+
Returns the textual contents of the given location, similar to
+xpaths's value-of
+ + + Source +
+
+

text=

+ function
+
Usage: (text= s)
+
+
Returns a query predicate that matches a node when its textual
+content equals s.
+ + + Source +
+
+

xml->

+ function
+
Usage: (xml-> loc & preds)
+
+
The loc is passed to the first predicate.  If the predicate returns
+a collection, each value of the collection is passed to the next
+predicate.  If it returns a location, the location is passed to the
+next predicate.  If it returns true, the input location is passed to
+the next predicate.  If it returns false or nil, the next predicate
+is not called.
+
+This process is repeated, passing the processed results of each
+predicate to the next predicate.  xml-> returns the final sequence.
+The entire chain is evaluated lazily.
+
+There are also special predicates: keywords are converted to tag=,
+strings to text=, and vectors to sub-queries that return true if
+they match.
+
+See the footer of zip-query.clj for examples.
+ + + Source +
+
+

xml1->

+ function
+
Usage: (xml1-> loc & preds)
+
+
Returns the first item from loc based on the query predicates
+given.  See xml->
+ + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file diff --git a/classpath-api.html b/classpath-api.html index 58114f62..20b3621b 100644 --- a/classpath-api.html +++ b/classpath-api.html @@ -1,6 +1,6 @@ - classpath API reference (clojure-contrib) + classpath - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -65,7 +69,8 @@ namespace.

API for classpath - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -88,7 +93,7 @@ namespace.
   
Returns a sequence of File objects of the elements on CLASSPATH.
- Source + Source


@@ -99,7 +104,7 @@ namespace.
Returns a sequence of File objects for the directories on classpath.
- Source + Source


@@ -110,7 +115,7 @@ namespace.
Returns a sequence of JarFile objects for the JAR files on classpath.
- Source + Source
diff --git a/combinatorics-api.html b/combinatorics-api.html index 749fe24c..6458145e 100644 --- a/combinatorics-api.html +++ b/combinatorics-api.html @@ -1,6 +1,6 @@ - combinatorics API reference (clojure-contrib) + combinatorics - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -71,7 +75,8 @@ namespace.

API for combinatorics - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Mark Engelberg

Usage:
@@ -96,7 +101,7 @@ for a longer description.)
All the ways to take one item from each sequence
- Source + Source


@@ -107,7 +112,7 @@ for a longer description.)
All the unique ways of taking n different elements from items
- Source + Source


@@ -118,7 +123,7 @@ for a longer description.)
Fast lexicographic permutation generator for a sequence of numbers
- Source + Source


@@ -129,7 +134,7 @@ for a longer description.)
All the permutations of items, lexicographic by index
- Source + Source


@@ -140,7 +145,7 @@ for a longer description.)
All the ways of taking n (possibly the same) elements from the sequence of items
- Source + Source


@@ -151,7 +156,7 @@ for a longer description.)
All the subsets of items
- Source + Source
diff --git a/command-line-api.html b/command-line-api.html index e54b5602..b57595b1 100644 --- a/command-line-api.html +++ b/command-line-api.html @@ -1,6 +1,6 @@ - command-line API reference (clojure-contrib) + command-line - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for command-line - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser

Usage:
@@ -84,7 +89,7 @@ namespace.
   
Bind locals to command-line args.
- Source + Source
diff --git a/complex-numbers-api.html b/complex-numbers-api.html index 684ff803..3656d0e0 100644 --- a/complex-numbers-api.html +++ b/complex-numbers-api.html @@ -1,6 +1,6 @@ - complex-numbers API reference (clojure-contrib) + complex-numbers - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -59,7 +63,8 @@ namespace.

API for complex-numbers - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
diff --git a/cond-api.html b/cond-api.html
index 0c839b88..5256734f 100644
--- a/cond-api.html
+++ b/cond-api.html
@@ -1,6 +1,6 @@
 
   
-    cond API reference (clojure-contrib)
+    cond - clojure-contrib v1.2 API documentation
     
     
     
@@ -30,18 +30,22 @@ namespace.
       
@@ -61,7 +65,8 @@ namespace.

API for cond - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -91,7 +96,7 @@ refer to any parts of binding-form in the expr. (cond-let binding-form)
 returns nil.
- Source + Source
diff --git a/condition-api.html b/condition-api.html index 189b2111..78e21853 100644 --- a/condition-api.html +++ b/condition-api.html @@ -1,6 +1,6 @@ - condition API reference (clojure-contrib) + condition - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -79,7 +83,8 @@ namespace.

API for condition - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -123,7 +128,7 @@ Based on an idea from Chouser:
 traces
- Source + Source


@@ -151,7 +156,7 @@ handled and *selector* is bound to to the value returned by dispatch-fn that matched the handler's key. - Source + Source


@@ -164,7 +169,7 @@ classes in clojure.{core,lang,main} unless the *full-stack-traces* is bound to logical true - Source + Source


@@ -179,7 +184,7 @@ With one argument (a map), raises the argument. With two or more arguments, raises a map with keys and values from the arguments. - Source + Source


@@ -190,7 +195,7 @@ arguments, raises a map with keys and values from the arguments. Throwables - Source + Source

condition.Condition


diff --git a/core-api.html b/core-api.html
index 127dad36..bcf7171f 100644
--- a/core-api.html
+++ b/core-api.html
@@ -1,6 +1,6 @@
 
   
-    core API reference (clojure-contrib)
+    core - clojure-contrib v1.2 API documentation
     
     
     
@@ -30,18 +30,22 @@ namespace.
       
@@ -71,7 +75,8 @@ namespace.

API for core - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Laurent Petit (and others)

Usage:
@@ -100,7 +105,7 @@ Examples :
 
- Source + Source


@@ -116,7 +121,7 @@ Examples : - Source + Source


@@ -132,7 +137,7 @@ Examples : - Source + Source


@@ -145,7 +150,7 @@ nested structure. keys is a sequence of keys. Any empty maps that result will not be present in the new structure. - Source + Source


@@ -156,7 +161,7 @@ will not be present in the new structure.
Constructs a Java object whose class is specified by a String.
- Source + Source


@@ -167,7 +172,7 @@ will not be present in the new structure.
Returns true if (seq x) will succeed, false otherwise.
- Source + Source
diff --git a/dataflow-api.html b/dataflow-api.html index e886d7ca..c6512ea5 100644 --- a/dataflow-api.html +++ b/dataflow-api.html @@ -1,6 +1,6 @@ - dataflow API reference (clojure-contrib) + dataflow - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -99,7 +103,8 @@ namespace.

API for dataflow - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Jeffrey Straszheim

Usage:
@@ -125,7 +130,7 @@ value.  This is implemented using Clojure's add-watch to the
 underlying ref, and shared its sematics
- Source + Source


@@ -136,7 +141,7 @@ underlying ref, and shared its sematics
Given a collection of cells, add them to the dataflow.
- Source + Source


@@ -147,7 +152,7 @@ underlying ref, and shared its sematics
Given a collection of cells, build and return a dataflow object
- Source + Source


@@ -158,7 +163,7 @@ underlying ref, and shared its sematics
Builds a source cell
- Source + Source


@@ -169,7 +174,7 @@ underlying ref, and shared its sematics
Builds a standard cell
- Source + Source


@@ -180,7 +185,7 @@ underlying ref, and shared its sematics
Builds a validator cell
- Source + Source


@@ -216,7 +221,7 @@ Or: Which will perform the validation - Source + Source


@@ -226,7 +231,7 @@ Which will perform the validation
A 'readable' form of the cell
- Source + Source


@@ -236,7 +241,7 @@ Which will perform the validation
Evaluate a dataflow cell.  Return [changed, old val]
- Source + Source


@@ -247,7 +252,7 @@ Which will perform the validation
Get the single cell named by name
- Source + Source


@@ -258,7 +263,7 @@ Which will perform the validation
Get all the cells named by name
- Source + Source


@@ -269,7 +274,7 @@ Which will perform the validation
Looks up an old value
- Source + Source


@@ -280,7 +285,7 @@ Which will perform the validation
Returns a collection of source cells from the dataflow
- Source + Source


@@ -293,7 +298,7 @@ Signals an error if the name is not present, or if it not a single value. - Source + Source


@@ -304,7 +309,7 @@ value.
Given a cell, get its value
- Source + Source


@@ -315,7 +320,7 @@ value.
Gets a collection of values from the df by name
- Source + Source


@@ -326,7 +331,7 @@ value.
Prints a dataflow, one cell per line
- Source + Source


@@ -337,7 +342,7 @@ value.
Given a collection of cells, remove them from the dataflow.
- Source + Source


@@ -348,7 +353,7 @@ value.
Is this cell a source cell?
- Source + Source


@@ -361,7 +366,7 @@ dataflow by binding the new values. Each name must be of a source cell - Source + Source
diff --git a/datalog-api.html b/datalog-api.html index 11f9cfa5..67e2f152 100644 --- a/datalog-api.html +++ b/datalog-api.html @@ -1,6 +1,6 @@ - datalog API reference (clojure-contrib) + datalog - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -225,7 +229,8 @@ namespace.

API for datalog - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Jeffrey Straszheim

Usage:
@@ -253,7 +258,7 @@ namespace.
 used to execute the query.
- Source + Source


@@ -265,7 +270,7 @@ used to execute the query. work plan and return the results. - Source + Source

datalog.database


@@ -281,7 +286,7 @@ work plan and return the results.
   
Adds an index to an empty relation named name
- Source + Source

add-relation

@@ -291,7 +296,7 @@ work plan and return the results.
Adds a relation to the database
- Source + Source

add-tuple

@@ -307,7 +312,7 @@ the new database. [rel tuple] adds to the relation object. Returns the new relation. - Source + Source

add-tuples

@@ -320,7 +325,7 @@ the new database. [:rel-name :key-1 2 :key-2 3]) - Source + Source

any-match?

@@ -330,7 +335,7 @@ the new database.
Finds if there are any matching records for the partial tuple
- Source + Source

database-counts

@@ -340,7 +345,7 @@ the new database.
Returns a map with the count of elements in each relation.
- Source + Source

database-merge

@@ -350,7 +355,7 @@ the new database.
Merges databases together
- Source + Source

database-merge-parallel

@@ -360,7 +365,7 @@ the new database.
Merges databases together in parallel
- Source + Source

datalog-relation

@@ -370,7 +375,7 @@ the new database.
Creates a relation
- Source + Source

ensure-relation

@@ -380,7 +385,7 @@ the new database.
If the database lacks the named relation, add it
- Source + Source

get-relation

@@ -390,7 +395,7 @@ the new database.
Get a relation object by name
- Source + Source

make-database

@@ -406,7 +411,7 @@ the new database. (index :sally :becky)) - Source + Source

merge-relations

@@ -416,7 +421,7 @@ the new database.
Merges two relations
- Source + Source

remove-tuple

@@ -433,7 +438,7 @@ returns a new database. relation. - Source + Source

replace-relation

@@ -443,7 +448,7 @@ relation.
Add or replace a fully constructed relation object to the database.
- Source + Source

select

@@ -453,7 +458,7 @@ relation.
finds all matching tuples to the partial tuple (pt) in the relation named (rn)
- Source + Source

datalog.literals


@@ -793,7 +798,7 @@ relation
 (<- (:head :x ?x :y ?y) (:body-1 :x ?x :y ?y) (:body-2 :z ?z) (not! :body-3 :x ?x) (if > ?y ?z))
   
   
-  Source
+  Source
 

?-

@@ -803,7 +808,7 @@ relation
Define a datalog query
- Source + Source

all-predicates

@@ -813,7 +818,7 @@ relation
Given a rules-set, return all defined predicates
- Source + Source

apply-rule

@@ -825,7 +830,7 @@ relation relation in db-2. The relation will be created if needed. - Source + Source

compute-sip

@@ -837,7 +842,7 @@ rule. A set of intensional predicates should be provided to determine what should be adorned. - Source + Source

display-query

@@ -847,7 +852,7 @@ determine what should be adorned.
Return a query in a readable format.
- Source + Source

display-rule

@@ -857,7 +862,7 @@ determine what should be adorned.
Return the rule in a readable format.
- Source + Source

is-safe?

@@ -867,7 +872,7 @@ determine what should be adorned.
Is the rule safe according to the datalog protocol?
- Source + Source

make-rules-set

@@ -878,7 +883,7 @@ determine what should be adorned. printing. - Source + Source

non-base-rules

@@ -888,7 +893,7 @@ printing.
Return a collection of rules that depend, somehow, on other rules
- Source + Source

predicate-map

@@ -899,7 +904,7 @@ printing. Each value will be a set of rules. - Source + Source

return-rule-data

@@ -909,7 +914,7 @@ Each value will be a set of rules.
Returns an untypted rule that will be fully printed
- Source + Source

rules-set

@@ -919,7 +924,7 @@ Each value will be a set of rules.
Given a collection of rules return a rules set
- Source + Source

datalog.softstrat


diff --git a/def-api.html b/def-api.html
index fcf8fefa..0b621057 100644
--- a/def-api.html
+++ b/def-api.html
@@ -1,6 +1,6 @@
 
   
-    def API reference (clojure-contrib)
+    def - clojure-contrib v1.2 API documentation
     
     
     
@@ -30,18 +30,22 @@ namespace.
       
@@ -83,7 +87,8 @@ namespace.

API for def - (master branch)

+ - clojure-contrib v1.2 (beta 1) +
Usage:
@@ -109,7 +114,7 @@ any) and similar metadata. The metadata of the alias is its initial
 metadata (as provided by def) merged into the metadata of the original.
- Source + Source


@@ -122,7 +127,7 @@ 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 - Source + Source


@@ -133,7 +138,7 @@ value of a different type. See ht
Same as defmacro but yields a private definition
-
Source + Source


@@ -144,7 +149,7 @@ value of a different type. See ht
Just like defn, but memoizes the function using clojure.core/memoize
-
Source + Source


@@ -160,7 +165,7 @@ virtue of the symbol corresponding to the keyword (cf. :keys destructuring). defnk accepts an optional docstring as well as an optional metadata map. - Source + Source


@@ -172,7 +177,7 @@ defnk accepts an optional docstring as well as an optional metadata map.
Same as defonce but yields a private definition
- Source + Source


@@ -183,7 +188,7 @@ defnk accepts an optional docstring as well as an optional metadata map.
Same as defstruct but yields a private definition
- Source + Source


@@ -195,7 +200,7 @@ defnk accepts an optional docstring as well as an optional metadata map.
Defines an unbound var with optional doc string
- Source + Source


@@ -206,7 +211,7 @@ defnk accepts an optional docstring as well as an optional metadata map.
Same as defunbound but yields a private definition
- Source + Source


@@ -219,7 +224,7 @@ defnk accepts an optional docstring as well as an optional metadata map.
Defines a var with an optional intializer and doc string
- Source + Source


@@ -230,7 +235,7 @@ defnk accepts an optional docstring as well as an optional metadata map.
Same as defvar but yields a private definition
- Source + Source


@@ -249,7 +254,7 @@ with its extended metadata map and the list of unprocessed macro arguments. - Source + Source
diff --git a/doc/datalog.html b/doc/datalog.html index 6d7f3eb5..f2c8d09f 100644 --- a/doc/datalog.html +++ b/doc/datalog.html @@ -30,18 +30,22 @@ namespace.
diff --git a/doc/pprint/CommonLispFormat.html b/doc/pprint/CommonLispFormat.html index 4fa37bc1..208bf40b 100644 --- a/doc/pprint/CommonLispFormat.html +++ b/doc/pprint/CommonLispFormat.html @@ -30,18 +30,22 @@ namespace.
diff --git a/doc/pprint/PrettyPrinting.html b/doc/pprint/PrettyPrinting.html index 7d8f0013..3f32a3ca 100644 --- a/doc/pprint/PrettyPrinting.html +++ b/doc/pprint/PrettyPrinting.html @@ -30,18 +30,22 @@ namespace.
diff --git a/duck-streams-api.html b/duck-streams-api.html index 22c914d1..37ce6c0e 100644 --- a/duck-streams-api.html +++ b/duck-streams-api.html @@ -1,6 +1,6 @@ - duck-streams API reference (clojure-contrib) + duck-streams - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -99,7 +103,8 @@ namespace.

API for duck-streams - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -131,7 +136,7 @@ or "just-give-me-a-stream", but ducks are funnier.
Defaults to false. Use append-writer or append-spit. - Source + Source


@@ -142,7 +147,7 @@ Defaults to false. Use append-writer or append-spit. copying streams. - Source + Source


@@ -152,7 +157,7 @@ copying streams.
Type object for a Java primitive byte array.
- Source + Source


@@ -163,7 +168,7 @@ copying streams. Default is UTF-8. - Source + Source


@@ -174,7 +179,7 @@ Default is UTF-8.
Like spit but appends to file.
- Source + Source


@@ -186,7 +191,7 @@ Default is UTF-8. that are already open. - Source + Source


@@ -204,7 +209,7 @@ Does not close any streams except those it opens itself Writing a File fails if the parent directory does not exist. - Source + Source


@@ -217,7 +222,7 @@ all / and \ with File/separatorChar. Replaces ~ at the start of the path with the user.home system property. - Source + Source


@@ -228,7 +233,7 @@ the path with the user.home system property.
Creates all parent directories of file.
- Source + Source


@@ -240,7 +245,7 @@ the path with the user.home system property. Note: In Java, you cannot change the current working directory. - Source + Source


@@ -252,7 +257,7 @@ Note: In Java, you cannot change the current working directory. closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE. - Source + Source


@@ -272,7 +277,7 @@ Should be used inside with-open to ensure the Reader is properly closed. - Source + Source


@@ -283,7 +288,7 @@ closed.
Like clojure.core/slurp but opens f with reader.
- Source + Source


@@ -295,7 +300,7 @@ closed. closes f. - Source + Source


@@ -308,7 +313,7 @@ a String, File, InputStream, or Reader. If the argument is already a byte array, returns it. - Source + Source


@@ -319,7 +324,7 @@ a byte array, returns it.
Opens a PushbackReader on f, binds it to *in*, and evaluates body.
- Source + Source


@@ -330,7 +335,7 @@ a byte array, returns it.
Like with-out-writer but appends to file.
- Source + Source


@@ -342,7 +347,7 @@ a byte array, returns it. Anything printed within body will be written to f. - Source + Source


@@ -354,7 +359,7 @@ Anything printed within body will be written to f. writer, and automatically closed at the end of the sequence. - Source + Source


@@ -375,7 +380,7 @@ Should be used inside with-open to ensure the Writer is properly closed. - Source + Source
diff --git a/error-kit-api.html b/error-kit-api.html index ef290be0..cf038cd0 100644 --- a/error-kit-api.html +++ b/error-kit-api.html @@ -1,6 +1,6 @@ - error-kit API reference (clojure-contrib) + error-kit - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -77,7 +81,8 @@ namespace.

API for error-kit - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser

Usage:
@@ -106,7 +111,7 @@ in this with-handler's dynamic scope, when this 'continue-name' is
 given to a 'continue' form.
- Source + Source


@@ -118,7 +123,7 @@ given to a 'continue' form.
Define a new error type
- Source + Source


@@ -132,7 +137,7 @@ appropriate 'handle' form. Allows finer-grain control over catching than just the error type. - Source + Source


@@ -143,7 +148,7 @@ than just the error type.
Base type for all error-kit errors
- Source + Source


@@ -162,7 +167,7 @@ the entire 'with-handler' form, or it may use any of the special return forms, 'do-not-handle', 'continue-with', or 'continue'. - Source + Source


@@ -173,7 +178,7 @@ return forms, 'do-not-handle', 'continue-with', or 'continue'.
Raise an error of the type err-name, constructed with the given args
- Source + Source


@@ -185,7 +190,7 @@ return forms, 'do-not-handle', 'continue-with', or 'continue'. constructor defined with deferror. See also 'raise' macro. - Source + Source


@@ -198,7 +203,7 @@ name. Useful to associate a new error-kit error type with a particular Java Exception class, via the :unhandled error key. - Source + Source


@@ -211,7 +216,7 @@ in a dynamic context that includes all of the following 'handle' and 'bind-continue' forms. - Source + Source
diff --git a/except-api.html b/except-api.html index ab3935ab..350cb6a0 100644 --- a/except-api.html +++ b/except-api.html @@ -1,6 +1,6 @@ - except API reference (clojure-contrib) + except - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -67,7 +71,8 @@ namespace.

API for except - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -99,7 +104,7 @@ formatted using clojure.core/format.
format. - Source + Source


@@ -111,7 +116,7 @@ formatted using clojure.core/format. for throwf. - Source + Source


@@ -123,7 +128,7 @@ for throwf. for throwf. - Source + Source


@@ -144,7 +149,7 @@ clojure.core/format. All arguments are optional: format. - Source + Source
diff --git a/fcase-api.html b/fcase-api.html index fd58de60..2e576402 100644 --- a/fcase-api.html +++ b/fcase-api.html @@ -1,6 +1,6 @@ - fcase API reference (clojure-contrib) + fcase - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -69,7 +73,8 @@ namespace.

API for fcase - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -102,7 +107,7 @@ expression.  Optional last expression is executed if none of the
 test expressions match.
- Source + Source


@@ -136,7 +141,7 @@ order. For a large number of case expressions it may be more efficient to use a hash lookup. - Source + Source


@@ -149,7 +154,7 @@ is true if any item in the sequence is equal (tested with '=') to the test value. - Source + Source


@@ -161,7 +166,7 @@ the test value. 'instance?'. - Source + Source


@@ -173,7 +178,7 @@ the test value. with re-find. - Source + Source
diff --git a/find-namespaces-api.html b/find-namespaces-api.html index 8340f908..c3410f13 100644 --- a/find-namespaces-api.html +++ b/find-namespaces-api.html @@ -1,6 +1,6 @@ - find-namespaces API reference (clojure-contrib) + find-namespaces - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -87,7 +91,8 @@ namespace.

API for find-namespaces - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -110,7 +115,7 @@ namespace.
   
Returns true if file is a normal file with a .clj extension.
- Source + Source


@@ -121,7 +126,7 @@ namespace.
Returns a sequence of filenames ending in .clj found in the JAR file.
- Source + Source


@@ -132,7 +137,7 @@ namespace.
Returns true if form is a (comment ...)
- Source + Source


@@ -144,7 +149,7 @@ namespace. Returns a sequence of File objects, in breadth-first sort order. - Source + Source


@@ -156,7 +161,7 @@ Returns a sequence of File objects, in breadth-first sort order. source files; returns the symbol names of the declared namespaces. - Source + Source


@@ -169,7 +174,7 @@ declarations. Returns a sequence of the symbol names of the declared namespaces. - Source + Source


@@ -182,7 +187,7 @@ source files containing (ns ...) declarations. Returns a sequence of the symbol names of the declared namespaces. - Source + Source


@@ -194,7 +199,7 @@ of the symbol names of the declared namespaces. source files; returns the unevaluated ns declarations. - Source + Source


@@ -206,7 +211,7 @@ source files; returns the unevaluated ns declarations. declarations; returns the unevaluated ns declarations. - Source + Source


@@ -219,7 +224,7 @@ source files containing (ns ...) declarations. Returns a sequence of the unevaluated ns declaration forms. - Source + Source


@@ -230,7 +235,7 @@ of the unevaluated ns declaration forms.
Returns true if form is a (ns ...) declaration.
- Source + Source


@@ -243,7 +248,7 @@ unevaluated form. Returns nil if read fails, or if the first form is not a ns declaration. - Source + Source


@@ -257,7 +262,7 @@ cannot be found. The ns declaration must be the first Clojure form in the file, except for (comment ...) forms. - Source + Source


@@ -270,7 +275,7 @@ JAR file, and returns the unevaluated form. Returns nil if the read fails, or if the first form is not a ns declaration. - Source + Source
diff --git a/fnmap-api.html b/fnmap-api.html index 7ca0dafa..263623c6 100644 --- a/fnmap-api.html +++ b/fnmap-api.html @@ -1,6 +1,6 @@ - fnmap API reference (clojure-contrib) + fnmap - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for fnmap - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -97,7 +102,7 @@ map for m.
 All other map operations are passed through to the internal map.
- Source + Source
diff --git a/gen-html-docs-api.html b/gen-html-docs-api.html index c4f04a68..368fc606 100644 --- a/gen-html-docs-api.html +++ b/gen-html-docs-api.html @@ -1,6 +1,6 @@ - gen-html-docs API reference (clojure-contrib) + gen-html-docs - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for gen-html-docs - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Craig Andera

Usage:
@@ -89,7 +94,7 @@ named by libs. Libs is a vector of symbols identifying Clojure
 libraries.
- Source + Source


@@ -101,7 +106,7 @@ libraries. emits the generated HTML to the path named by path. - Source + Source
diff --git a/generic.arithmetic-api.html b/generic.arithmetic-api.html index 6a7c02d7..e2d37030 100644 --- a/generic.arithmetic-api.html +++ b/generic.arithmetic-api.html @@ -1,6 +1,6 @@ - generic.arithmetic API reference (clojure-contrib) + generic.arithmetic - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -71,7 +75,8 @@ namespace.

API for generic.arithmetic - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -103,7 +108,7 @@ efficiency reasons.
::my-type is the binary form with dispatch value [::my-type ::my-type]. - Source + Source


@@ -117,7 +122,7 @@ efficiency reasons. ::my-type is the binary form with dispatch value [::my-type ::my-type]. - Source + Source


@@ -132,7 +137,7 @@ arguments. The minimal implementation for type ::my-type is the binary form with dispatch value [::my-type ::my-type]. - Source + Source


@@ -147,7 +152,7 @@ arguments. The minimal implementation for type ::my-type is the binary form with dispatch value [::my-type ::my-type]. - Source + Source


@@ -159,7 +164,7 @@ form with dispatch value [::my-type ::my-type]. Required for implementing the division function from another namespace. - Source + Source


@@ -172,7 +177,7 @@ Required to access the division function from another namespace, e.g. as (qsym clojure.contrib.generic.arithmetic /). - Source + Source
diff --git a/generic.collection-api.html b/generic.collection-api.html index 9ea4d751..702da0c3 100644 --- a/generic.collection-api.html +++ b/generic.collection-api.html @@ -1,6 +1,6 @@ - generic.collection API reference (clojure-contrib) + generic.collection - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -73,7 +77,8 @@ namespace.

API for generic.collection - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -101,7 +106,7 @@ given keys are updated by the given values. Each type of collection
 can have specific restrictions on the possible keys.
- Source + Source


@@ -112,7 +117,7 @@ can have specific restrictions on the possible keys.
Returns a new collection resulting from adding all xs to coll.
- Source + Source


@@ -125,7 +130,7 @@ given keys are removed. Each type of collection can have specific restrictions on the possible keys. - Source + Source


@@ -136,7 +141,7 @@ restrictions on the possible keys.
Returns an empty collection of the same kind as the argument
- Source + Source


@@ -149,7 +154,7 @@ restrictions on the possible keys. can have specific restrictions on the possible keys. - Source + Source


@@ -161,7 +166,7 @@ can have specific restrictions on the possible keys. from-coll conjoined. - Source + Source


@@ -172,7 +177,7 @@ from-coll conjoined.
Returns a seq on the object s.
- Source + Source
diff --git a/generic.comparison-api.html b/generic.comparison-api.html index 1e536519..0c559ae0 100644 --- a/generic.comparison-api.html +++ b/generic.comparison-api.html @@ -1,6 +1,6 @@ - generic.comparison API reference (clojure-contrib) + generic.comparison - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -79,7 +83,8 @@ namespace.

API for generic.comparison - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -110,7 +115,7 @@ with dispatch value [::my-type ::my-type]. A default implementation
 is provided in terms of >.
- Source + Source


@@ -126,7 +131,7 @@ with dispatch value [::my-type ::my-type]. A default implementation is provided in terms of >. - Source + Source


@@ -140,7 +145,7 @@ is provided in terms of >. ::my-type is the binary form with dispatch value [::my-type ::my-type]. - Source + Source


@@ -155,7 +160,7 @@ The minimal implementation for type ::my-type is the binary form with dispatch value [::my-type ::my-type]. - Source + Source


@@ -171,7 +176,7 @@ with dispatch value [::my-type ::my-type]. A default implementation is provided in terms of <. - Source + Source


@@ -185,7 +190,7 @@ is provided in terms of <. is uses generic comparison functions implementable for any data type. - Source + Source


@@ -199,7 +204,7 @@ is uses generic comparison functions implementable for any data type. is uses generic comparison functions implementable for any data type. - Source + Source


@@ -210,7 +215,7 @@ is uses generic comparison functions implementable for any data type.
Return true of x is negative.
- Source + Source


@@ -221,7 +226,7 @@ is uses generic comparison functions implementable for any data type.
Return true of x is positive.
- Source + Source


@@ -232,7 +237,7 @@ is uses generic comparison functions implementable for any data type.
Return true of x is zero.
- Source + Source
diff --git a/generic.functor-api.html b/generic.functor-api.html index 1645d1ba..dad0985f 100644 --- a/generic.functor-api.html +++ b/generic.functor-api.html @@ -1,6 +1,6 @@ - generic.functor API reference (clojure-contrib) + generic.functor - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for generic.functor - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -85,7 +90,7 @@ namespace.
 a structure of the same kind.
- Source + Source
diff --git a/generic.math-functions-api.html b/generic.math-functions-api.html index 293f042f..8b38e2d0 100644 --- a/generic.math-functions-api.html +++ b/generic.math-functions-api.html @@ -1,6 +1,6 @@ - generic.math-functions API reference (clojure-contrib) + generic.math-functions - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -99,7 +103,8 @@ namespace.

API for generic.math-functions - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -125,7 +130,7 @@ defined for any type.
Return the abs of x.
- Source + Source


@@ -136,7 +141,7 @@ defined for any type.
Return the acos of x.
- Source + Source


@@ -148,7 +153,7 @@ defined for any type. is less than eps. - Source + Source


@@ -159,7 +164,7 @@ is less than eps.
Return the asin of x.
- Source + Source


@@ -170,7 +175,7 @@ is less than eps.
Return the atan of x.
- Source + Source


@@ -181,7 +186,7 @@ is less than eps.
Return the atan2 of x and y.
- Source + Source


@@ -192,7 +197,7 @@ is less than eps.
Return the ceil of x.
- Source + Source


@@ -203,7 +208,7 @@ is less than eps.
Return the conjugate of x.
- Source + Source


@@ -214,7 +219,7 @@ is less than eps.
Return the cos of x.
- Source + Source


@@ -225,7 +230,7 @@ is less than eps.
Return the exp of x.
- Source + Source


@@ -236,7 +241,7 @@ is less than eps.
Return the floor of x.
- Source + Source


@@ -247,7 +252,7 @@ is less than eps.
Return the log of x.
- Source + Source


@@ -258,7 +263,7 @@ is less than eps.
Return the pow of x and y.
- Source + Source


@@ -269,7 +274,7 @@ is less than eps.
Return the rint of x.
- Source + Source


@@ -280,7 +285,7 @@ is less than eps.
Return the round of x.
- Source + Source


@@ -291,7 +296,7 @@ is less than eps.
Return the sign of x (-1, 0, or 1).
- Source + Source


@@ -302,7 +307,7 @@ is less than eps.
Return the sin of x.
- Source + Source


@@ -313,7 +318,7 @@ is less than eps.
Return the square of x.
- Source + Source


@@ -324,7 +329,7 @@ is less than eps.
Return the sqrt of x.
- Source + Source


@@ -335,7 +340,7 @@ is less than eps.
Return the tan of x.
- Source + Source
diff --git a/graph-api.html b/graph-api.html index 76d219aa..af7e09c4 100644 --- a/graph-api.html +++ b/graph-api.html @@ -1,6 +1,6 @@ - graph API reference (clojure-contrib) + graph - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -87,7 +91,8 @@ namespace.

API for graph - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Jeffrey Straszheim

Usage:
@@ -110,7 +115,7 @@ namespace.
   
For each node n, add the edge n->n if not already present.
- Source + Source


@@ -125,7 +130,7 @@ These sets are the strongly connected components. Each edge will be the union of the corresponding edges of the prior graph. - Source + Source


@@ -140,7 +145,7 @@ a set have no mutual dependencies. Assume the input graph (which much be acyclic) has an edge a->b when a depends on b. - Source + Source


@@ -153,7 +158,7 @@ returns true. If max iterations occur, it will throw an exception. Set max to nil for unlimited iterations. - Source + Source


@@ -164,7 +169,7 @@ exception. Set max to nil for unlimited iterations.
Get the neighbors of a node.
- Source + Source


@@ -178,7 +183,7 @@ provide a set of visited notes (v) and a collection of nodes to visit (ns). - Source + Source


@@ -189,7 +194,7 @@ visit (ns).
Return a sequence of indexes of a post-ordered walk of the graph.
- Source + Source


@@ -200,7 +205,7 @@ visit (ns).
Is the component (recieved from scc) self recursive?
- Source + Source


@@ -211,7 +216,7 @@ visit (ns).
For each node n, remove any edges n->n.
- Source + Source


@@ -223,7 +228,7 @@ visit (ns). order of the edges reversed. - Source + Source


@@ -235,7 +240,7 @@ order of the edges reversed. of g. - Source + Source


@@ -247,7 +252,7 @@ of g. self-recursive. - Source + Source


@@ -262,7 +267,7 @@ depends on node b (meaning an edge a->b exists) in the second graph, node a must be equal or later in the sequence. - Source + Source


@@ -279,7 +284,7 @@ cycles in the graph. If you have code that depends on such behavior, call (-> g transitive-closure add-loops) - Source + Source
diff --git a/greatest-least-api.html b/greatest-least-api.html index 645999b6..ef8cdc3b 100644 --- a/greatest-least-api.html +++ b/greatest-least-api.html @@ -1,6 +1,6 @@ - greatest-least API reference (clojure-contrib) + greatest-least - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -75,7 +79,8 @@ namespace.

API for greatest-least - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Vincent Foley

Usage:
@@ -98,7 +103,7 @@ namespace.
   
Returns all the greatest elements.
- Source + Source


@@ -109,7 +114,7 @@ namespace.
Return all the elements for which f yields the greatest value.
- Source + Source


@@ -120,7 +125,7 @@ namespace.
Returns all the least elements.
- Source + Source


@@ -131,7 +136,7 @@ namespace.
Return all the elements for which f yields the least value.
- Source + Source


@@ -142,7 +147,7 @@ namespace.
Return the greatest argument.
- Source + Source


@@ -153,7 +158,7 @@ namespace.
Return the argument for which f yields the greatest value.
- Source + Source


@@ -164,7 +169,7 @@ namespace.
Return the smallest element.
- Source + Source


@@ -175,7 +180,7 @@ namespace.
Return the argument for which f yields the smallest value.
- Source + Source
diff --git a/http.agent-api.html b/http.agent-api.html index 886b628e..4866904a 100644 --- a/http.agent-api.html +++ b/http.agent-api.html @@ -1,6 +1,6 @@ - http.agent API reference (clojure-contrib) + http.agent - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -99,7 +103,8 @@ namespace.

API for http.agent - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -169,7 +174,7 @@ body in a java.io.ByteArrayOutputStream, which can later be
 retrieved with the 'stream', 'string', and 'bytes' functions.
- Source + Source


@@ -181,7 +186,7 @@ retrieved with the 'stream', 'string', and 'bytes' functions. nil if the content is not yet available. - Source + Source


@@ -192,7 +197,7 @@ nil if the content is not yet available.
Returns true if the HTTP response code was in the 400-499 range.
- Source + Source


@@ -203,7 +208,7 @@ nil if the content is not yet available.
Returns true if the HTTP request/response has completed.
- Source + Source


@@ -215,7 +220,7 @@ nil if the content is not yet available. the 500-599 range. - Source + Source


@@ -228,7 +233,7 @@ to keywords in all lower-case Header values are strings. If a header appears more than once, only the last value is returned. - Source + Source


@@ -241,7 +246,7 @@ header appears more than once, only the last value is returned. HTTP status line. - Source + Source


@@ -299,7 +304,7 @@ response stream in a memory buffer. - Source + Source


@@ -311,7 +316,7 @@ response stream in a memory buffer. request, or nil if the response has not yet been received. - Source + Source


@@ -322,7 +327,7 @@ request, or nil if the response has not yet been received.
Returns the HTTP method name used by this HTTP agent, as a String.
- Source + Source


@@ -337,7 +342,7 @@ redirects will be followed automatically and a the agent will never return a 3xx response code. - Source + Source


@@ -351,7 +356,7 @@ Note: if the request body was an InputStream or a Reader, it will no longer be usable. - Source + Source


@@ -362,7 +367,7 @@ longer be usable.
Returns the request headers specified for this HTTP agent.
- Source + Source


@@ -373,7 +378,7 @@ longer be usable.
Returns the URI/URL requested by this HTTP agent, as a String.
- Source + Source


@@ -386,7 +391,7 @@ agent; blocks until the HTTP request is completed. The default handler function returns a ByteArrayOutputStream. - Source + Source


@@ -397,7 +402,7 @@ handler function returns a ByteArrayOutputStream.
Returns true if the HTTP response code was in the 500-599 range.
- Source + Source


@@ -410,7 +415,7 @@ request, as an Integer, or nil if the status has not yet been received. - Source + Source


@@ -426,7 +431,7 @@ If the default handler function was used, this function returns a ByteArrayInputStream on the buffered response body. - Source + Source


@@ -443,7 +448,7 @@ headers, or clojure.contrib.io/*default-encoding* if it is not specified. - Source + Source


@@ -454,7 +459,7 @@ not specified.
Returns true if the HTTP response code was in the 200-299 range.
- Source + Source
diff --git a/http.connection-api.html b/http.connection-api.html index f25651b6..e2b0c6de 100644 --- a/http.connection-api.html +++ b/http.connection-api.html @@ -1,6 +1,6 @@ - http.connection API reference (clojure-contrib) + http.connection - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for http.connection - (master branch)

+ - clojure-contrib v1.2 (beta 1) +
Usage:
@@ -86,7 +91,7 @@ namespace.
   
Opens an HttpURLConnection at the URL, handled by as-url.
- Source + Source


@@ -96,7 +101,7 @@ namespace.
Transmits a request entity body.
- Source + Source
diff --git a/import-static-api.html b/import-static-api.html index b686d8da..9d0c7e39 100644 --- a/import-static-api.html +++ b/import-static-api.html @@ -1,6 +1,6 @@ - import-static API reference (clojure-contrib) + import-static - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for import-static - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -97,7 +102,7 @@ been imported.  Static methods are defined as MACROS, not
 first-class fns.
- Source + Source
diff --git a/index.html b/index.html index 90d0af27..eb43c5e4 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ - clojure-contrib - Overview + Overview - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -254,10 +258,6 @@ namespace.
pprint -
-
- priority-map -
probabilities.finite-distributions @@ -374,8 +374,7 @@ namespace.
-

An Overview of the clojure-contrib API - (master branch)

+

API Overview - clojure-contrib v1.2 (beta 1)


The user contributions library, clojure.contrib, is a collection of namespaces each of which implements features that we believe may be useful to @@ -1660,7 +1659,26 @@ functions.

ns-utils

by Stephen C. Gilardi
Detailed API documentation
-
Namespace utilities
+
Namespace utilities
+
+get-ns          returns the namespace named by a symbol or throws
+                if the namespace does not exist
+
+ns-vars         returns a sorted seq of symbols naming public vars
+                in a namespace
+
+print-docs      prints documentation for the public vars in a
+                namespace
+
+immigrate       Create a public var in this namespace for each
+                public var in the namespaces named by ns-names.
+                From James Reeves
+
+vars            returns a sorted seq of symbols naming public vars
+                in a namespace (macro)
+
+docs            prints documentation for the public vars in a
+                namespace (macro)
@@ -1681,10 +1699,7 @@ functions. for its Java-based format function. See documentation for those functions for more information or complete -documentation on the the clojure-contrib web site on github. - -As of the 1.2 release, pprint has been moved to clojure.pprint. Please prefer -the clojure.pprint version for new code. +documentation on the the clojure-contrib web site on github. Deprecated since clojure-contrib version 1.2
@@ -1711,19 +1726,6 @@ the clojure.pprint version for new code.
-
-
-
-

priority-map

- - Detailed API documentation
-

-  
-  
-  
-  Public variables and functions:
-  priority-map priority-map-by 
-


diff --git a/io-api.html b/io-api.html index 6ef6dd72..d39b34e6 100644 --- a/io-api.html +++ b/io-api.html @@ -1,6 +1,6 @@ - io API reference (clojure-contrib) + io - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -117,7 +121,8 @@ namespace.

API for io - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -147,7 +152,7 @@ Defaults to false.  Instead of binding this var directly, use append-writer,
 append-output-stream or append-spit.
- Source + Source


@@ -158,7 +163,7 @@ append-output-stream or append-spit. copying streams. - Source + Source


@@ -168,7 +173,7 @@ copying streams.
Type object for a Java primitive byte array.
- Source + Source


@@ -178,7 +183,7 @@ copying streams.
Type object for a Java primitive char array.
- Source + Source


@@ -189,7 +194,7 @@ copying streams. Default is UTF-8. - Source + Source


@@ -201,7 +206,7 @@ Default is UTF-8. that are already open. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -212,7 +217,7 @@ that are already open.
Like spit but appends to file.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -224,7 +229,7 @@ that are already open. that are already open. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -235,7 +240,7 @@ that are already open.
Coerces argument (URL, URI, or String) to a java.net.URL.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -253,7 +258,7 @@ Does not close any streams except those it opens itself Writing a File fails if the parent directory does not exist. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -264,7 +269,7 @@ Writing a File fails if the parent directory does not exist.
Delete file f. Raise an exception if it fails unless silently is true.
- Source + Source


@@ -276,7 +281,7 @@ Writing a File fails if the parent directory does not exist. Raise an exception if any deletion fails unless silently is true. - Source + Source


@@ -289,7 +294,7 @@ Raise an exception if any deletion fails unless silently is true.
Returns a java.io.File from string or file args.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -302,7 +307,7 @@ all / and \ with File/separatorChar. Replaces ~ at the start of the path with the user.home system property. - Source + Source


@@ -336,7 +341,7 @@ closed.
Creates all parent directories of file.
- Source + Source


@@ -371,7 +376,7 @@ properly closed. Note: In Java, you cannot change the current working directory. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -383,7 +388,7 @@ Note: In Java, you cannot change the current working directory. closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE. - Source + Source


@@ -421,7 +426,7 @@ closed. Building block for clojure.contrib.java/file. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -432,7 +437,7 @@ Building block for clojure.contrib.java/file.
Like clojure.core/slurp but opens f with reader.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -444,7 +449,7 @@ Building block for clojure.contrib.java/file. closes f. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -457,7 +462,7 @@ a String, File, InputStream, or Reader. If the argument is already a byte array, returns it. - Source + Source


@@ -468,7 +473,7 @@ a byte array, returns it.
Opens a PushbackReader on f, binds it to *in*, and evaluates body.
- Source + Source


@@ -479,7 +484,7 @@ a byte array, returns it.
Like with-out-writer but appends to file.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -491,7 +496,7 @@ a byte array, returns it. Anything printed within body will be written to f. - Source + Source


@@ -503,7 +508,7 @@ Anything printed within body will be written to f. writer, and automatically closed at the end of the sequence. - Source + Source


diff --git a/jar-api.html b/jar-api.html index a3feb254..746e5a3a 100644 --- a/jar-api.html +++ b/jar-api.html @@ -1,6 +1,6 @@ - jar API reference (clojure-contrib) + jar - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for jar - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -87,7 +92,7 @@ namespace.
 the JAR file.
- Source + Source


@@ -98,7 +103,7 @@ the JAR file.
Returns true if file is a normal file with a .jar or .JAR extension.
- Source + Source
diff --git a/java-utils-api.html b/java-utils-api.html index ce6f4464..dc88f266 100644 --- a/java-utils-api.html +++ b/java-utils-api.html @@ -1,6 +1,6 @@ - java-utils API reference (clojure-contrib) + java-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -89,7 +93,8 @@ namespace.

API for java-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Halloway, Stephen C. Gilardi, Shawn Hoover, Perry Trolard, Stuart Sierra

Usage:
@@ -138,7 +143,7 @@ for clojure.contrib.java-utils/file, which you should prefer
 in most cases.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -150,7 +155,7 @@ in most cases. Uses as-str to convert both keys and values into strings. - Source + Source


@@ -175,7 +180,7 @@ Example: (as-str {:foo :bar}) ;;=> "{:foo :bar}" Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -186,7 +191,7 @@ Example:
Coerces argument (URL, URI, or String) to a java.net.URL.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -197,7 +202,7 @@ Example:
Delete file f. Raise an exception if it fails unless silently is true.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -209,7 +214,7 @@ Example: Raise an exception if any deletion fails unless silently is true. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -222,7 +227,7 @@ Raise an exception if any deletion fails unless silently is true.
Returns a java.io.File from string or file args.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -234,7 +239,7 @@ Raise an exception if any deletion fails unless silently is true.
Get a system property.
- Source + Source


@@ -245,7 +250,7 @@ Raise an exception if any deletion fails unless silently is true.
Read properties from file-able.
- Source + Source


@@ -256,7 +261,7 @@ Raise an exception if any deletion fails unless silently is true. Building block for clojure.contrib.java-utils/file. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -267,7 +272,7 @@ Building block for clojure.contrib.java-utils/file.
Set some system properties. Nil clears a property.
- Source + Source


@@ -278,7 +283,7 @@ Building block for clojure.contrib.java-utils/file.
Access to private or protected field.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -292,7 +297,7 @@ obj is nil for static methods, the instance object otherwise the method name is given as a symbol or a keyword (something Named) Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -307,7 +312,7 @@ sets the properties back to their original values. Values of nil are translated to a clearing of the property. - Source + Source


@@ -319,7 +324,7 @@ translated to a clearing of the property.
Write properties to file-able.
- Source + Source
diff --git a/javadoc.browse-api.html b/javadoc.browse-api.html index 27511b73..ed64003c 100644 --- a/javadoc.browse-api.html +++ b/javadoc.browse-api.html @@ -1,6 +1,6 @@ - javadoc.browse API reference (clojure-contrib) + javadoc.browse - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for javadoc.browse - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Christophe Grand

Usage:
@@ -88,7 +93,7 @@ work on all platforms.  Returns url on success, nil if not
 supported.
- Source + Source


@@ -99,7 +104,7 @@ supported.
Opens url (a string) in a Swing window.
- Source + Source
diff --git a/jmx-api.html b/jmx-api.html index 79b5e8a2..b2f978a6 100644 --- a/jmx-api.html +++ b/jmx-api.html @@ -1,6 +1,6 @@ - jmx API reference (clojure-contrib) + jmx - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -103,7 +107,8 @@ namespace.

API for jmx - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Halloway

Usage:
@@ -185,7 +190,7 @@ in the ref:
   
The connection to be used for JMX ops. Defaults to the local process.
- Source + Source


@@ -218,7 +223,7 @@ in the ref:
All attribute names available on an MBean.
- Source + Source


@@ -312,7 +317,7 @@ a JMX bean's attributes. If an attribute it not supported, value is set to the exception thrown. - Source + Source


@@ -323,7 +328,7 @@ set to the exception thrown.
Finds all MBeans matching a name on the current *connection*.
- Source + Source


@@ -357,7 +362,7 @@ Used for invoke.
All operation names available on an MBean.
- Source + Source


diff --git a/json-api.html b/json-api.html index 676a7308..85a25f80 100644 --- a/json-api.html +++ b/json-api.html @@ -1,6 +1,6 @@ - json API reference (clojure-contrib) + json - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -71,7 +75,8 @@ namespace.

API for json - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -97,7 +102,7 @@ To read JSON, use read-json.
Converts x to a JSON-formatted string.
- Source + Source


@@ -108,7 +113,7 @@ To read JSON, use read-json.
Pretty-prints JSON representation of x to *out*
- Source + Source


@@ -119,7 +124,7 @@ To read JSON, use read-json.
Write JSON-formatted output to *out*
- Source + Source


@@ -135,7 +140,7 @@ keywords. If eof-error? is true (default), empty input will throw an EOFException; if false EOF will return eof-value. - Source + Source


diff --git a/lazy-seqs-api.html b/lazy-seqs-api.html index 08588e3e..87e840b1 100644 --- a/lazy-seqs-api.html +++ b/lazy-seqs-api.html @@ -1,6 +1,6 @@ - lazy-seqs API reference (clojure-contrib) + lazy-seqs - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -65,7 +69,8 @@ namespace.

API for lazy-seqs - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -108,7 +113,7 @@ namespace.
   
Returns a lazy sequence of all the Fibonacci numbers.
- Source + Source


@@ -119,7 +124,7 @@ namespace.
Returns a lazy sequence of all the powers of 2
- Source + Source


@@ -129,7 +134,7 @@ namespace.
Lazy sequence of all the prime numbers.
- Source + Source
diff --git a/lazy-xml-api.html b/lazy-xml-api.html index 3538cb8c..d1048314 100644 --- a/lazy-xml-api.html +++ b/lazy-xml-api.html @@ -1,6 +1,6 @@ - lazy-xml API reference (clojure-contrib) + lazy-xml - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for lazy-xml - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser

Usage:
@@ -96,7 +101,7 @@ is specified and org.xmlpull.v1.XmlPullParser is in the classpath,
 this superior pull parser will be used.
- Source + Source


@@ -120,7 +125,7 @@ org.xmlpull.v1.XmlPullParser is in the classpath, this superior pull parser will be used. - Source + Source
diff --git a/logging-api.html b/logging-api.html index a477de72..84b7ec23 100644 --- a/logging-api.html +++ b/logging-api.html @@ -1,6 +1,6 @@ - logging API reference (clojure-contrib) + logging - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -97,7 +101,8 @@ namespace.

API for logging - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Alex Taggart, Timothy Pratley

Usage:
@@ -151,7 +156,7 @@ needs to be specified to namespace the output.
allowed when not operating from within a transaction. Defaults to true. - Source + Source


@@ -161,7 +166,7 @@ allowed when not operating from within a transaction. Defaults to true.
The name of the logging implementation used.
- Source + Source


@@ -172,7 +177,7 @@ allowed when not operating from within a transaction. Defaults to true. direct logging is disabled. - Source + Source


@@ -184,7 +189,7 @@ direct logging is disabled.
Logs a message at the debug level.
- Source + Source


@@ -198,7 +203,7 @@ should only be necessary if one needs to execute alternate code paths beyond whether the log should be written to. - Source + Source


@@ -210,7 +215,7 @@ whether the log should be written to.
Logs a message at the error level.
- Source + Source


@@ -222,7 +227,7 @@ whether the log should be written to.
Logs a message at the fatal level.
- Source + Source


@@ -233,7 +238,7 @@ whether the log should be written to. should not need to call this. - Source + Source


@@ -244,7 +249,7 @@ should not need to call this. not need to call this. - Source + Source


@@ -255,7 +260,7 @@ not need to call this. call this. - Source + Source


@@ -267,7 +272,7 @@ call this.
Logs a message at the info level.
- Source + Source


@@ -281,7 +286,7 @@ call this. convenience macros. - Source + Source


@@ -295,7 +300,7 @@ be used to namespace all redirected logging. NOTE: this will not redirect output of *out* or *err*; for that, use with-logs. - Source + Source


@@ -307,7 +312,7 @@ output of *out* or *err*; for that, use with-logs. to invoke this. - Source + Source


@@ -318,7 +323,7 @@ to invoke this.
Restores System.out and System.err to their original values.
- Source + Source


@@ -330,7 +335,7 @@ to invoke this. the result of expr. - Source + Source


@@ -342,7 +347,7 @@ the result of expr.
Logs a message at the trace level.
- Source + Source


@@ -354,7 +359,7 @@ the result of expr.
Logs a message at the warn level.
- Source + Source


@@ -367,7 +372,7 @@ the result of expr. namespace all redirected logging. - Source + Source
diff --git a/macro-utils-api.html b/macro-utils-api.html index f2c5bfe3..d5a2d5b0 100644 --- a/macro-utils-api.html +++ b/macro-utils-api.html @@ -1,6 +1,6 @@ - macro-utils API reference (clojure-contrib) + macro-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -75,7 +79,8 @@ namespace.

API for macro-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -111,7 +116,7 @@ Clojure's built-in macro expansion system, they can be used only
 inside a with-symbol-macros form.
- Source + Source


@@ -124,7 +129,7 @@ symbols in params (a vector) by the corresponding parameters given in the macro call. - Source + Source


@@ -136,7 +141,7 @@ given in the macro call. syntax is the same as for letfn forms. - Source + Source


@@ -147,7 +152,7 @@ syntax is the same as for letfn forms.
Like clojure.core/macroexpand, but takes into account symbol macros.
- Source + Source


@@ -158,7 +163,7 @@ syntax is the same as for letfn forms.
Like clojure.core/macroexpand-1, but takes into account symbol macros.
- Source + Source


@@ -169,7 +174,7 @@ syntax is the same as for letfn forms.
Perform a full recursive macro expansion of a form.
- Source + Source


@@ -181,7 +186,7 @@ syntax is the same as for letfn forms. The syntax is the same as for let forms. - Source + Source


@@ -192,7 +197,7 @@ The syntax is the same as for let forms.
Fully expand exprs, including symbol macros.
- Source + Source
diff --git a/macros-api.html b/macros-api.html index 27789b03..17387dc5 100644 --- a/macros-api.html +++ b/macros-api.html @@ -1,6 +1,6 @@ - macros API reference (clojure-contrib) + macros - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -65,7 +69,8 @@ namespace.

API for macros - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -88,7 +93,7 @@ namespace.
   
Evaluate the constant expression expr at compile time.
- Source + Source


@@ -102,7 +107,7 @@ of name/args/body triples, with (letfn [name args body] ...) being equivalent to (let [name (fn name args body)] ...). - Source + Source


@@ -120,7 +125,7 @@ the default value ['clojure.core] is used. The symbol *ns* can be used to refer to the current namespace. - Source + Source
diff --git a/map-utils-api.html b/map-utils-api.html index 16d5ce9d..f21e5f20 100644 --- a/map-utils-api.html +++ b/map-utils-api.html @@ -1,6 +1,6 @@ - map-utils API reference (clojure-contrib) + map-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -67,7 +71,8 @@ namespace.

API for map-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Jason Wolfe, Chris Houser

Usage:
@@ -95,7 +100,7 @@ only when there's a non-map at a particular level.
 -> {:a {:b {:z 3, :c 3, :d {:z 9, :x 1, :y 2}}, :e 103}, :f 4}
- Source + Source


@@ -106,7 +111,7 @@ only when there's a non-map at a particular level.
Like get, but doesn't evaluate not-found unless it is needed.
- Source + Source


@@ -117,7 +122,7 @@ only when there's a non-map at a particular level.
Like get, but throws an exception if the key is not found.
- Source + Source


@@ -128,7 +133,7 @@ only when there's a non-map at a particular level.
Like get-in, but throws an exception if any key is not found.
- Source + Source
diff --git a/math-api.html b/math-api.html index ca56d056..82a4a070 100644 --- a/math-api.html +++ b/math-api.html @@ -1,6 +1,6 @@ - math API reference (clojure-contrib) + math - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -77,7 +81,8 @@ namespace.

API for math - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Mark Engelberg

Usage:
@@ -140,7 +145,7 @@ exact-integer-sqrt - Implements a math function from the R6RS Scheme
   
(abs n) is the absolute value of n
- Source + Source


@@ -152,7 +157,7 @@ exact-integer-sqrt - Implements a math function from the R6RS Scheme If n is an exact number, ceil returns an integer, otherwise a double. - Source + Source


@@ -164,7 +169,7 @@ If n is an exact number, ceil returns an integer, otherwise a double. For example, (exact-integer-sqrt 15) is [3 6] because 15 = 3^2+6. - Source + Source


@@ -176,7 +181,7 @@ For example, (exact-integer-sqrt 15) is [3 6] because 15 = 3^2+6. Returns an exact number if the base is an exact number and the power is an integer, otherwise returns a double. - Source + Source


@@ -188,7 +193,7 @@ Returns an exact number if the base is an exact number and the power is an integ If n is an exact number, floor returns an integer, otherwise a double. - Source + Source


@@ -199,7 +204,7 @@ If n is an exact number, floor returns an integer, otherwise a double.
(gcd a b) returns the greatest common divisor of a and b
- Source + Source


@@ -210,7 +215,7 @@ If n is an exact number, floor returns an integer, otherwise a double.
(lcm a b) returns the least common multiple of a and b
- Source + Source


@@ -222,7 +227,7 @@ If n is an exact number, floor returns an integer, otherwise a double. round always returns an integer. Rounds up for values exactly in between two integers. - Source + Source


@@ -233,7 +238,7 @@ round always returns an integer. Rounds up for values exactly in between two in
Square root, but returns exact number if possible.
- Source + Source
diff --git a/miglayout-api.html b/miglayout-api.html index b6a6ac4c..72a97dc0 100644 --- a/miglayout-api.html +++ b/miglayout-api.html @@ -1,6 +1,6 @@ - miglayout API reference (clojure-contrib) + miglayout - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -95,7 +99,8 @@ namespace.

API for miglayout - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -125,7 +130,7 @@ Example:
 an id constraint set
- Source + Source


@@ -166,7 +171,7 @@ id to component attached to the container. The map can be retrieved using clojure.contrib.miglayout/components. - Source + Source

miglayout.example


@@ -219,7 +224,7 @@ strings. Returns "input?" if the input can't be parsed as a Double.
   
Adds components with constraints to a container
- Source + Source

component?

@@ -229,7 +234,7 @@ strings. Returns "input?" if the input can't be parsed as a Double.
Returns true if x is a java.awt.Component
- Source + Source

constraint?

@@ -239,7 +244,7 @@ strings. Returns "input?" if the input can't be parsed as a Double.
Returns true if x is not a keyword-item or component
- Source + Source

do-layout

@@ -250,7 +255,7 @@ strings. Returns "input?" if the input can't be parsed as a Double. with constraints - Source + Source

format-constraint

@@ -262,7 +267,7 @@ separated by commas. Constraints may be specified in Clojure using strings, keywords, vectors, maps, and/or sets. - Source + Source

format-constraints

@@ -273,7 +278,7 @@ strings, keywords, vectors, maps, and/or sets. or component formatted for miglayout. - Source + Source

get-components

@@ -283,7 +288,7 @@ or component formatted for miglayout.
Returns a map from id to component for all components with an id
- Source + Source

parse-component-constraint

@@ -293,7 +298,7 @@ or component formatted for miglayout.
Parses a component constraint string returning a CC object
- Source + Source

parse-item-constraints

@@ -306,7 +311,7 @@ items to constraints strings. The value for :components is a vector of vectors each associating a component with its constraints string. - Source + Source
diff --git a/mmap-api.html b/mmap-api.html index a3b28e6d..a498a7a3 100644 --- a/mmap-api.html +++ b/mmap-api.html @@ -1,6 +1,6 @@ - mmap API reference (clojure-contrib) + mmap - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -65,7 +69,8 @@ namespace.

API for mmap - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser

Usage:
@@ -89,7 +94,7 @@ mmaped file for "normal" activies -- slurp, load-file, etc.
Returns an InputStream for a ByteBuffer, such as returned by mmap.
- Source + Source


@@ -100,7 +105,7 @@ mmaped file for "normal" activies -- slurp, load-file, etc.
Memory-map the file named f.  Returns a ByteBuffer.
- Source + Source


@@ -111,7 +116,7 @@ mmaped file for "normal" activies -- slurp, load-file, etc.
Reads the file named by f and returns it as a string.
- Source + Source
diff --git a/mock-api.html b/mock-api.html index 00c56a6c..ef32c460 100644 --- a/mock-api.html +++ b/mock-api.html @@ -1,6 +1,6 @@ - mock API reference (clojure-contrib) + mock - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -103,7 +107,8 @@ namespace.

API for mock - (master branch)

+ - clojure-contrib v1.2 (beta 1) +
Usage:
@@ -132,7 +137,7 @@ Usage:
 (calls some-fn expectation-hash?)
- Source + Source


@@ -149,7 +154,7 @@ Usage: (function-under-test a b c)) - Source + Source


@@ -168,7 +173,7 @@ Usage: (has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?) - Source + Source


@@ -181,7 +186,7 @@ function. If no argslist meta data is available for the function, it is not called. - Source + Source


@@ -196,7 +201,7 @@ designed to be called from the mock function generated in the first argument of the mock info object created by make-mock. - Source + Source


@@ -209,7 +214,7 @@ the code under test has all been executed. The function returned takes the name of the associated dependency and the invocation count as arguments. - Source + Source


@@ -225,7 +230,7 @@ increases count, returns return value. 4. a symbol of the name of the function being replaced. - Source + Source


@@ -241,7 +246,7 @@ Usage: (returns ret-value expectation-hash?) - Source + Source


@@ -263,7 +268,7 @@ Usage: (times n expectation-hash) - Source + Source


@@ -275,7 +280,7 @@ Usage: count checker for each dependency. - Source + Source

mock.test-adapter


@@ -297,7 +302,7 @@ Usage:
 (calls some-fn expectation-hash?)
   
   
-  Source
+  Source
 

has-args

@@ -315,7 +320,7 @@ Usage: (has-args [arg-pred-1 arg-pred-2 ... arg-pred-n] expectation-hash?) - Source + Source

has-matching-signature?

@@ -327,7 +332,7 @@ function. If no argslist meta data is available for the function, it is not called. - Source + Source

make-arg-checker

@@ -341,7 +346,7 @@ designed to be called from the mock function generated in the first argument of the mock info object created by make-mock. - Source + Source

make-count-checker

@@ -353,7 +358,7 @@ the code under test has all been executed. The function returned takes the name of the associated dependency and the invocation count as arguments. - Source + Source

make-mock

@@ -368,7 +373,7 @@ increases count, returns return value. 4. a symbol of the name of the function being replaced. - Source + Source

report-problem

@@ -395,7 +400,7 @@ Usage: (returns ret-value expectation-hash?) - Source + Source

times

@@ -416,7 +421,7 @@ Usage: (times n expectation-hash) - Source + Source

validate-counts

@@ -427,7 +432,7 @@ Usage: count checker for each dependency. - Source + Source
diff --git a/monadic-io-streams-api.html b/monadic-io-streams-api.html index a4051e9a..db51b058 100644 --- a/monadic-io-streams-api.html +++ b/monadic-io-streams-api.html @@ -1,6 +1,6 @@ - monadic-io-streams API reference (clojure-contrib) + monadic-io-streams - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -81,7 +85,8 @@ namespace.

API for monadic-io-streams - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -111,7 +116,7 @@ monadic statement sequence.
Flush
- Source + Source


@@ -122,7 +127,7 @@ monadic statement sequence.
Print obj
- Source + Source


@@ -134,7 +139,7 @@ monadic statement sequence.
Print obj followed by a newline
- Source + Source


@@ -145,7 +150,7 @@ monadic statement sequence.
Read a single character
- Source + Source


@@ -156,7 +161,7 @@ monadic statement sequence.
Read a single line
- Source + Source


@@ -167,7 +172,7 @@ monadic statement sequence.
Read all lines and return them in a vector
- Source + Source


@@ -178,7 +183,7 @@ monadic statement sequence.
Skip n characters
- Source + Source


@@ -198,7 +203,7 @@ streams. Single-stream monadic I/O statements must be wrapped with clojure.contrib.monads/with-state-field. - Source + Source


@@ -211,7 +216,7 @@ on it, and close the reader. reader-spec can be any object accepted by clojure.contrib.io/reader. - Source + Source


@@ -224,7 +229,7 @@ on it, and close the writer. writer-spec can be any object accepted by clojure.contrib.io/writer. - Source + Source


@@ -235,7 +240,7 @@ by clojure.contrib.io/writer.
Write text (a string)
- Source + Source
diff --git a/monads-api.html b/monads-api.html index 8f0eaeec..8b790b1b 100644 --- a/monads-api.html +++ b/monads-api.html @@ -1,6 +1,6 @@ - monads API reference (clojure-contrib) + monads - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -131,7 +135,8 @@ namespace.

API for monads - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -173,7 +178,7 @@ return a continuation (which becomes the return value of call-cc),
 or call the passed-in current continuation to terminate.
- Source + Source


@@ -185,7 +190,7 @@ values are functions that are called with a single argument representing the continuation of the computation, to which they pass their result. - Source + Source


@@ -199,7 +204,7 @@ are written like bindings to the monad operations m-bind and m-result (required) and m-zero and m-plus (optional). - Source + Source


@@ -212,7 +217,7 @@ m-result (required) and m-zero and m-plus (optional). a with-monad block. - Source + Source


@@ -233,7 +238,7 @@ are given as a vector as for the use in let, establishes additional bindings that can be used in the following steps. - Source + Source


@@ -245,7 +250,7 @@ bindings that can be used in the following steps. modify it. - Source + Source


@@ -257,7 +262,7 @@ modify it. returns the value corresponding to the given key. The state is not modified. - Source + Source


@@ -269,7 +274,7 @@ at all. It is useful for testing, for combination with monad transformers, and for code that is parameterized with a monad. - Source + Source


@@ -282,7 +287,7 @@ step as its argument. (m-chain (step1 step2)) is equivalent to (fn [x] (domonad [r1 (step1 x) r2 (step2 r1)] r2)). - Source + Source


@@ -292,7 +297,7 @@ step as its argument. (m-chain (step1 step2)) is equivalent to
Bind the monadic value m to the function returning (f x) for argument x
- Source + Source


@@ -303,7 +308,7 @@ step as its argument. (m-chain (step1 step2)) is equivalent to monadic value. - Source + Source


@@ -315,7 +320,7 @@ monadic value. monadic arguments returning a monadic value. - Source + Source


@@ -326,7 +331,7 @@ monadic arguments returning a monadic value. f onto the values xs. f must return a monadic value. - Source + Source


@@ -337,7 +342,7 @@ f onto the values xs. f must return a monadic value. with initial value (m-result val). - Source + Source


@@ -348,7 +353,7 @@ with initial value (m-result val). basic values contained in them. - Source + Source


@@ -360,7 +365,7 @@ monadic computation (f x). Return (m-result x) for the first x for which (p x) is true. - Source + Source


@@ -372,7 +377,7 @@ x for which (p x) is true. (m-result nil). - Source + Source


@@ -384,7 +389,7 @@ x for which (p x) is true. (m-result nil). - Source + Source


@@ -396,7 +401,7 @@ represented by nil, any other value is considered valid. As soon as a step returns nil, the whole computation will yield nil as well. - Source + Source


@@ -415,7 +420,7 @@ if the base monad m has a definition for m-plus, and :m-plus-from-transformer otherwise. - Source + Source


@@ -428,7 +433,7 @@ are written like bindings to the monad operations m-bind and m-result (required) and m-zero and m-plus (optional). - Source + Source


@@ -441,7 +446,7 @@ monad. The argument which-m-plus chooses if m-zero and m-plus are taken from the base monad or from the transformer. - Source + Source


@@ -452,7 +457,7 @@ from the base monad or from the transformer.
Execute the computation c in the cont monad and return its result.
- Source + Source


@@ -464,7 +469,7 @@ that can yield multiple values. Any object implementing the seq protocol can be used as a monadic value. - Source + Source


@@ -482,7 +487,7 @@ if the base monad m has a definition for m-plus, and :m-plus-from-transformer otherwise. - Source + Source


@@ -493,7 +498,7 @@ if the base monad m has a definition for m-plus, and but returning sets of results instead of sequences of results. - Source + Source


@@ -505,7 +510,7 @@ but returning sets of results instead of sequences of results. returns the previous state. - Source + Source


@@ -517,7 +522,7 @@ returns the previous state. replaces the value associated with key by val. The old value is returned. - Source + Source


@@ -528,7 +533,7 @@ replaces the value associated with key by val. The old value is returned. structure (fn [old-state] [result new-state]). - Source + Source


@@ -540,7 +545,7 @@ structure (fn [old-state] [result new-state]). replaces recursion by a loop. - Source + Source


@@ -552,7 +557,7 @@ replaces recursion by a loop. computations that have the base monad type as their result. - Source + Source


@@ -564,7 +569,7 @@ computations that have the base monad type as their result. result of f applied to the current state and that returns the old state. - Source + Source


@@ -577,7 +582,7 @@ replaces the value associated with the given key by the return value of f applied to the old value. The old value is returned. - Source + Source


@@ -590,7 +595,7 @@ monad operations by the functions associated with these keywords in the monad definition given by name. - Source + Source


@@ -604,7 +609,7 @@ the map entry corresponding to key. The map entry is updated with the new state returned by statement. - Source + Source


@@ -618,7 +623,7 @@ accumulators from clojure.contrib.accumulators can be used for storing the log data. Its empty value is passed as a parameter. - Source + Source
diff --git a/ns-utils-api.html b/ns-utils-api.html index 40af1468..f64170d7 100644 --- a/ns-utils-api.html +++ b/ns-utils-api.html @@ -1,6 +1,6 @@ - ns-utils API reference (clojure-contrib) + ns-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -75,7 +79,8 @@ namespace.

API for ns-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -83,7 +88,26 @@ namespace.
   (:require clojure.contrib.ns-utils))
 
 

Overview

-
Namespace utilities
+
Namespace utilities
+
+get-ns          returns the namespace named by a symbol or throws
+                if the namespace does not exist
+
+ns-vars         returns a sorted seq of symbols naming public vars
+                in a namespace
+
+print-docs      prints documentation for the public vars in a
+                namespace
+
+immigrate       Create a public var in this namespace for each
+                public var in the namespaces named by ns-names.
+                From James Reeves
+
+vars            returns a sorted seq of symbols naming public vars
+                in a namespace (macro)
+
+docs            prints documentation for the public vars in a
+                namespace (macro)

@@ -97,8 +121,8 @@ namespace.
Prints a sorted directory of public vars in a namespace
- - Source + Deprecated since clojure-contrib version 1.2
+ Source


@@ -109,7 +133,7 @@ namespace.
Prints documentation for the public vars in a namespace
- Source + Source


@@ -121,7 +145,7 @@ namespace. namespace does not exist - Source + Source


@@ -135,7 +159,7 @@ binding, and metadata as the original except that their :ns metadata value is this namespace. - Source + Source


@@ -147,7 +171,7 @@ value is this namespace. a namespace - Source + Source


@@ -157,8 +181,8 @@ a namespace
Prints a sorted directory of public vars in a namespace
- - Source + Deprecated since clojure-contrib version 1.2
+ Source


@@ -169,7 +193,7 @@ a namespace
Prints documentation for the public vars in a namespace
- Source + Source


@@ -181,7 +205,7 @@ a namespace a namespace - Source + Source
diff --git a/pprint-api.html b/pprint-api.html index 74340610..0260f4fd 100644 --- a/pprint-api.html +++ b/pprint-api.html @@ -1,6 +1,6 @@ - pprint API reference (clojure-contrib) + pprint - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -135,7 +139,8 @@ namespace.

API for pprint - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Tom Faulhaber

Usage:
@@ -151,10 +156,7 @@ namespace.
    for its Java-based format function.
 
 See documentation for those functions for more information or complete 
-documentation on the the clojure-contrib web site on github.
-
-As of the 1.2 release, pprint has been moved to clojure.pprint. Please prefer
-the clojure.pprint version for new code.
+documentation on the the clojure-contrib web site on github. Deprecated since clojure-contrib version 1.2

@@ -175,7 +177,7 @@ the clojure.pprint version for new code.
The pretty print dispatch function for pretty printing Clojure code.
- Source + Source


@@ -185,7 +187,7 @@ the clojure.pprint version for new code.
The base to use for printing integers and rationals.
- Source + Source


@@ -195,7 +197,7 @@ the clojure.pprint version for new code.
Mark circular structures (N.B. This is not yet used)
- Source + Source


@@ -205,7 +207,7 @@ the clojure.pprint version for new code.
Maximum number of lines to print in a pretty print instance (N.B. This is not yet used)
- Source + Source


@@ -217,7 +219,7 @@ miser style add newlines in more places to try to keep lines short allowing for levels of nesting. - Source + Source


@@ -228,7 +230,7 @@ levels of nesting. to modify. - Source + Source


@@ -238,7 +240,7 @@ to modify.
Bind to true if you want write to use pretty printing
- Source + Source


@@ -250,7 +252,7 @@ or 16, then the radix specifier used is #b, #o, or #x, respectively. Otherwise t radix specifier is in the form #XXr where XX is the decimal value of *print-base* - Source + Source


@@ -262,7 +264,7 @@ Set it to nil to have pprint let the line be arbitrarily long. This will ignore non-mandatory newlines. - Source + Source


@@ -272,7 +274,7 @@ non-mandatory newlines.
Mark repeated structures rather than repeat them (N.B. This is not yet used)
- Source + Source


@@ -283,7 +285,7 @@ non-mandatory newlines. pretty printing the results of macro expansions - Source + Source


@@ -294,7 +296,7 @@ pretty printing the results of macro expansions
The pretty print dispatch function for simple data structure format.
- Source + Source


@@ -331,7 +333,7 @@ and in the Common Lisp HyperSpec at http://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm - Source + Source


@@ -344,7 +346,7 @@ to cl-format just like a plain format string. Use this function for improved performance when you're using the same format string repeatedly - Source + Source


@@ -359,7 +361,7 @@ 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. - Source + Source


@@ -375,7 +377,7 @@ 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. - Source + Source


@@ -387,7 +389,7 @@ format-in can be either a control string or a previously compiled format. N.B. Only works on ColumnWriters right now. - Source + Source


@@ -399,7 +401,7 @@ N.B. Only works on ColumnWriters right now. exactly equivalent to (pprint *1). - Source + Source


@@ -412,7 +414,7 @@ exactly equivalent to (pprint *1). print the object to the currently bound value of *out*. - Source + Source


@@ -428,7 +430,7 @@ the current column position. n is an offset. Output is sent to *out* which must be a pretty printing writer. - Source + Source


@@ -444,7 +446,7 @@ Before the body, the caller can optionally specify options: :prefix, :per-line-p and :suffix. - Source + Source


@@ -458,7 +460,7 @@ newline is :linear, :miser, :fill, or :mandatory. Output is sent to *out* which must be a pretty printing writer. - Source + Source


@@ -477,7 +479,7 @@ Output is sent to *out* which must be a pretty printing writer. THIS FUNCTION IS NOT YET IMPLEMENTED. - Source + Source


@@ -493,7 +495,7 @@ For example functions, see *simple-dispatch* and *code-dispatch* in clojure.contrib.pprint.dispatch.clj. - Source + Source


@@ -504,7 +506,7 @@ clojure.contrib.pprint.dispatch.clj.
Installs a function as a new method of multimethod associated with dispatch-value. 
- Source + Source


@@ -515,7 +517,7 @@ clojure.contrib.pprint.dispatch.clj.
Execute body with the pretty print dispatch function bound to function.
- Source + Source


@@ -546,7 +548,7 @@ The following keyword arguments can be passed with values: * = not yet supported - Source + Source


@@ -566,7 +568,7 @@ already know that the pretty printer will have set up their environment appropri Normal library clients should use the standard "write" interface. - Source + Source

pprint.examples.json

Pretty printing JavaScript Object Notation (JSON) generator.
diff --git a/priority-map-api.html b/priority-map-api.html
deleted file mode 100644
index 3e3c10a5..00000000
--- a/priority-map-api.html
+++ /dev/null
@@ -1,121 +0,0 @@
-
-  
-    priority-map API reference (clojure-contrib)
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-  
-
-  
-    
- - -
-
-
-
- -

API for priority-map - (master branch)

- -
Usage: -
-(ns your-namespace
-  (:require clojure.contrib.priority-map))
-
-

Overview

-

-
-
-
-

Public Variables and Functions

-
-
-
-

priority-map

- function
-
Usage: (priority-map & keyvals)
-
-
keyval => key val
-Returns a new priority map with supplied mappings
- - - Source -
-
-
-

priority-map-by

- function
-
Usage: (priority-map-by comparator & keyvals)
-
-
keyval => key val
-Returns a new priority map with supplied mappings
- - - Source -
- - -
-
-
-
-
- -
-
Logo & site design by Tom Hickey.
- Clojure auto-documentation system by Tom Faulhaber.
-
- - - - \ No newline at end of file diff --git a/probabilities.finite-distributions-api.html b/probabilities.finite-distributions-api.html index 5602e9dd..f2c1ef8b 100644 --- a/probabilities.finite-distributions-api.html +++ b/probabilities.finite-distributions-api.html @@ -1,6 +1,6 @@ - probabilities.finite-distributions API reference (clojure-contrib) + probabilities.finite-distributions - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -81,7 +85,8 @@ namespace.

API for probabilities.finite-distributions - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -106,7 +111,7 @@ distributions.
Returns a distribution in which the single value v has probability 1.
- Source + Source


@@ -120,7 +125,7 @@ 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.
- Source + Source


@@ -130,7 +135,7 @@ pairs. In the last pair, the probability can be given by the keyword
Variant of the dist monad that can handle undefined values.
- Source + Source


@@ -142,7 +147,7 @@ pairs. In the last pair, the probability can be given by the keyword the predicate pred. - Source + Source


@@ -154,7 +159,7 @@ probability distribution for the possible values. A distribution is represented by a map from values to probabilities. - Source + Source


@@ -165,7 +170,7 @@ represented by a map from values to probabilities.
Returns the distribution of (f x y) with x from dist1 and y from dist2.
- Source + Source


@@ -177,7 +182,7 @@ represented by a map from values to probabilities. has a probability proportional to (f x) - Source + Source


@@ -192,7 +197,7 @@ it is used for normalization. Otherwise, the sum is calculated explicitly. The :total key is removed from the resulting distribution. - Source + Source


@@ -205,7 +210,7 @@ distribution dist, i.e. the sum of the probabilities of the values that satisfy pred. - Source + Source


@@ -217,7 +222,7 @@ that satisfy pred. has the same probability. - Source + Source


@@ -229,7 +234,7 @@ has the same probability. probabilities proportional to 1/k^s. - Source + Source
diff --git a/probabilities.monte-carlo-api.html b/probabilities.monte-carlo-api.html index 845e8c6c..4b759edd 100644 --- a/probabilities.monte-carlo-api.html +++ b/probabilities.monte-carlo-api.html @@ -1,6 +1,6 @@ - probabilities.monte-carlo API reference (clojure-contrib) + probabilities.monte-carlo - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -85,7 +89,8 @@ namespace.

API for probabilities.monte-carlo - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -125,7 +130,7 @@ composed using operations defined in clojure.contrib.monads.
to probabilities. The sum of probabilities must be one. - Source + Source


@@ -137,7 +142,7 @@ to probabilities. The sum of probabilities must be one. into a sequence of exponential random numbers with parameter lambda. - Source + Source


@@ -150,7 +155,7 @@ into a sequence of lognormal random numbers with mean mu and standard deviation sigma. - Source + Source


@@ -162,7 +167,7 @@ deviation sigma. n-sphere of radius r. - Source + Source


@@ -175,7 +180,7 @@ into a sequence of normal random numbers with mean mu and standard deviation sigma. - Source + Source


@@ -188,7 +193,7 @@ into a sequence of normal random numbers with mean mu and standard deviation sigma. - Source + Source


@@ -200,7 +205,7 @@ deviation sigma. random number stream with uniform distribution in [0, 1). - Source + Source


@@ -212,7 +217,7 @@ random number stream with uniform distribution in [0, 1). dist that do not satisfy predicate p. - Source + Source


@@ -224,7 +229,7 @@ dist that do not satisfy predicate p. distribution dist - Source + Source


@@ -236,7 +241,7 @@ distribution dist distribution dist - Source + Source


@@ -248,7 +253,7 @@ distribution dist the mean and the variance) over n samples from the distribution dist - Source + Source


@@ -261,7 +266,7 @@ the mean and the variance) over n samples from the distribution dist distribution dist. - Source + Source


@@ -273,7 +278,7 @@ distribution dist. distribution dist. - Source + Source
diff --git a/probabilities.random-numbers-api.html b/probabilities.random-numbers-api.html index b0524e04..c89e652b 100644 --- a/probabilities.random-numbers-api.html +++ b/probabilities.random-numbers-api.html @@ -1,6 +1,6 @@ - probabilities.random-numbers API reference (clojure-contrib) + probabilities.random-numbers - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for probabilities.random-numbers - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -95,7 +100,7 @@ linear congruential generator.
Create a linear congruential generator
- Source + Source


@@ -107,7 +112,7 @@ generator uses an internal mutable state. The state is thus not stored in the stream object and cannot be restored. - Source + Source
diff --git a/profile-api.html b/profile-api.html index cd2ef6ac..66af9051 100644 --- a/profile-api.html +++ b/profile-api.html @@ -1,6 +1,6 @@ - profile API reference (clojure-contrib) + profile - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -71,7 +75,8 @@ namespace.

API for profile - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -114,7 +119,7 @@ under the JVM.  See the function documentation for more details.
profiling code. - Source + Source


@@ -125,7 +130,7 @@ profiling code.
Prints a table of the results returned by summarize.
- Source + Source


@@ -139,7 +144,7 @@ Returns the result of body. Profile timings will be stored in Timings are measured with System/nanoTime. - Source + Source


@@ -151,7 +156,7 @@ Timings are measured with System/nanoTime. results. Returns nil. - Source + Source


@@ -171,7 +176,7 @@ section was executed. :sum is the total amount of time spent in the profiled section, in nanoseconds. - Source + Source


@@ -185,7 +190,7 @@ names (keywords), and values are lists of elapsed time, in nanoseconds. - Source + Source
diff --git a/properties-api.html b/properties-api.html index a2ea53ad..e9e69842 100644 --- a/properties-api.html +++ b/properties-api.html @@ -1,6 +1,6 @@ - properties API reference (clojure-contrib) + properties - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -71,7 +75,8 @@ namespace.

API for properties - (master branch)

+ - clojure-contrib v1.2 (beta 1) +
Usage:
@@ -95,7 +100,7 @@ namespace.
 Uses as-str to convert both keys and values into strings.
- Source + Source


@@ -107,7 +112,7 @@ Uses as-str to convert both keys and values into strings.
Get a system property.
- Source + Source


@@ -118,7 +123,7 @@ Uses as-str to convert both keys and values into strings.
Read properties from file-able.
- Source + Source


@@ -129,7 +134,7 @@ Uses as-str to convert both keys and values into strings.
Set some system properties. Nil clears a property.
- Source + Source


@@ -144,7 +149,7 @@ sets the properties back to their original values. Values of nil are translated to a clearing of the property. - Source + Source


@@ -156,7 +161,7 @@ translated to a clearing of the property.
Write properties to file-able.
- Source + Source
diff --git a/prxml-api.html b/prxml-api.html index 3e4da0ca..8821354a 100644 --- a/prxml-api.html +++ b/prxml-api.html @@ -1,6 +1,6 @@ - prxml API reference (clojure-contrib) + prxml - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -65,7 +69,8 @@ namespace.

API for prxml - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -88,7 +93,7 @@ for details.
If true, empty tags will have a space before the closing />
- Source + Source


@@ -99,7 +104,7 @@ for details. and no extra line-breaks. - Source + Source


@@ -131,7 +136,7 @@ PSEUDO-TAGS: some keywords have special meaning: ; => <?xml version="1.1" encoding="UTF-8"?> - Source + Source
diff --git a/reflect-api.html b/reflect-api.html index 56be26d9..06eabfd9 100644 --- a/reflect-api.html +++ b/reflect-api.html @@ -1,6 +1,6 @@ - reflect API reference (clojure-contrib) + reflect - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for reflect - (master branch)

+ - clojure-contrib v1.2 (beta 1) +
Usage:
diff --git a/repl-ln-api.html b/repl-ln-api.html
index 15f80e9e..cd3f3ed9 100644
--- a/repl-ln-api.html
+++ b/repl-ln-api.html
@@ -1,6 +1,6 @@
 
   
-    repl-ln API reference (clojure-contrib)
+    repl-ln - clojure-contrib v1.2 API documentation
     
     
     
@@ -30,18 +30,22 @@ namespace.
       
@@ -73,7 +77,8 @@ namespace.

API for repl-ln - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -97,7 +102,7 @@ input stream.
Prints info about the current repl
- Source + Source


@@ -121,7 +126,7 @@ for clojure.main/repl with the following change and additions: default: the prompt-fmt of the parent repl, or "%S:%L %N=> " - Source + Source


@@ -132,7 +137,7 @@ for clojure.main/repl with the following change and additions:
Returns a map of info about the current repl
- Source + Source


@@ -143,7 +148,7 @@ for clojure.main/repl with the following change and additions:
Returns the current repl prompt based on this repl's prompt-fmt
- Source + Source


@@ -162,7 +167,7 @@ codes in the name to make the corresponding dynamic values part of it: With no arguments, resets the repl name to its default: "repl-%S" - Source + Source


@@ -183,7 +188,7 @@ the corresponding dynamic values part of it: With no arguments, resets the repl pompt to its default: "%S:%L %N=> " - Source + Source


@@ -198,7 +203,7 @@ System/out, and System/err using UTF-8 encoding. Also supports all the options provided by clojure.contrib.repl-ln/repl. - Source + Source
diff --git a/repl-utils-api.html b/repl-utils-api.html index 0fcc0409..c9fa5e65 100644 --- a/repl-utils-api.html +++ b/repl-utils-api.html @@ -1,6 +1,6 @@ - repl-utils API reference (clojure-contrib) + repl-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -91,7 +95,8 @@ namespace.

API for repl-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser, Christophe Grand, Stephen Gilardi, Michel Salim

Usage:
@@ -114,7 +119,7 @@ namespace.
 files.
- Source + Source


@@ -125,7 +130,7 @@ files. Javadocs. - Source + Source


@@ -139,7 +144,7 @@ any time the user presses Ctrl-C. Calls start-handling-break for you. Adds the current thread if none is given. - Source + Source


@@ -150,7 +155,7 @@ you. Adds the current thread if none is given.
Adds to the list of local Javadoc paths.
- Source + Source


@@ -162,7 +167,7 @@ you. Adds the current thread if none is given. beginning of the package name that has docs at this URL. - Source + Source


@@ -175,7 +180,7 @@ all definitions in all currently-loaded namespaces that match the str-or-pattern. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -185,7 +190,7 @@ str-or-pattern.
Threads to stop when Ctrl-C is pressed.  See 'add-break-thread!'
- Source + Source


@@ -202,7 +207,7 @@ Example: (expression-info '(+ (int 5) (float 10))) Returns: {:class float, :primitive? true} - Source + Source


@@ -214,7 +219,7 @@ Returns: {:class float, :primitive? true} *local-javadocs* first, then *remote-javadocs*. Returns a string. - Source + Source


@@ -231,7 +236,7 @@ convenient. Example: (get-source 'filter) Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -243,7 +248,7 @@ Example: (get-source 'filter) Tries *local-javadocs* first, then *remote-javadocs*. - Source + Source


@@ -255,7 +260,7 @@ Tries *local-javadocs* first, then *remote-javadocs*. optional args. ns-name is not evaluated. - Source + Source


@@ -267,7 +272,7 @@ optional args. ns-name is not evaluated. optional args. - Source + Source


@@ -294,7 +299,7 @@ all the properies of the member object as translated by 'bean'. Examples: (show Integer) (show []) (show String 23) (show String "case") - Source + Source


@@ -309,7 +314,7 @@ namespace for which the .clj is in the classpath. Example: (source filter) Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -321,7 +326,7 @@ Example: (source filter) all break-threads to be stopped. See 'add-break-thread!' - Source + Source
diff --git a/seq-api.html b/seq-api.html index 432e8e4d..3a488f42 100644 --- a/seq-api.html +++ b/seq-api.html @@ -1,6 +1,6 @@ - seq API reference (clojure-contrib) + seq - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -95,7 +99,8 @@ namespace.

API for seq - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra (and others)

Usage:
@@ -123,7 +128,7 @@ filler-func has pushed onto the queue, blocking if needed until each
 next element becomes available.  filler-func's return value is ignored.
- Source + Source


@@ -136,7 +141,7 @@ Consumes sequences up to the first match, will consume the entire sequence and return nil if no match is found. - Source + Source


@@ -150,7 +155,7 @@ etc.) and returns their contents as a single, flat sequence. (flatten nil) returns nil. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -163,7 +168,7 @@ Returns a map from distinct items in coll to the number of times they appear. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -177,7 +182,7 @@ f on each element. The value at each key will be a vector of the corresponding elements, in the order they appeared in coll. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -190,7 +195,7 @@ in linear time. Deprecated. Prefer 'contains?' for key testing, or 'some' for ad hoc linear searches. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -204,7 +209,7 @@ from 's' and indexes count up from zero. (indexed '(a b c d)) => ([0 a] [1 b] [2 c] [3 d]) - Source + Source


@@ -218,7 +223,7 @@ Returns a lazy sequence of lists like clojure.core/partition, but may include lists with fewer than n items at the end. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -231,7 +236,7 @@ Applies f to each value in coll, splitting it each time f returns a new value. Returns a lazy seq of lazy seqs. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -243,7 +248,7 @@ a new value. Returns a lazy seq of lazy seqs. is true for items in coll. - Source + Source


@@ -255,7 +260,7 @@ is true for items in coll. Return a random element of this seq Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -267,7 +272,7 @@ Return a random element of this seq binding-name, allowing for recursive expressions. - Source + Source


@@ -279,7 +284,7 @@ binding-name, allowing for recursive expressions. binding-name, allowing for recursive expressions. - Source + Source


@@ -293,7 +298,7 @@ Returns a lazy seq of the intermediate values of the reduction (as per reduce) of coll by f, starting with init. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -304,7 +309,7 @@ per reduce) of coll by f, starting with init.
Returns a lazy seq of all rotations of a seq
- Source + Source


@@ -316,7 +321,7 @@ per reduce) of coll by f, starting with init. [ (filter f s), (filter (complement f) s) ] - Source + Source


@@ -328,7 +333,7 @@ per reduce) of coll by f, starting with init. a multimethod that can have implementations for new classes and types. - Source + Source


@@ -340,7 +345,7 @@ a multimethod that can have implementations for new classes and types. Return a random permutation of coll Deprecated since clojure-contrib version 1.2
- Source + Source
diff --git a/seq-utils-api.html b/seq-utils-api.html index bd1b03fa..0743c494 100644 --- a/seq-utils-api.html +++ b/seq-utils-api.html @@ -1,6 +1,6 @@ - seq-utils API reference (clojure-contrib) + seq-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -95,7 +99,8 @@ namespace.

API for seq-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra (and others)

Usage:
@@ -123,7 +128,7 @@ filler-func has pushed onto the queue, blocking if needed until each
 next element becomes available.  filler-func's return value is ignored.
- Source + Source


@@ -136,7 +141,7 @@ Consumes sequences up to the first match, will consume the entire sequence and return nil if no match is found. - Source + Source


@@ -150,7 +155,7 @@ etc.) and returns their contents as a single, flat sequence. (flatten nil) returns nil. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -163,7 +168,7 @@ Returns a map from distinct items in coll to the number of times they appear. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -177,7 +182,7 @@ f on each element. The value at each key will be a vector of the corresponding elements, in the order they appeared in coll. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -190,7 +195,7 @@ in linear time. Deprecated. Prefer 'contains?' for key testing, or 'some' for ad hoc linear searches. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -204,7 +209,7 @@ from 's' and indexes count up from zero. (indexed '(a b c d)) => ([0 a] [1 b] [2 c] [3 d]) - Source + Source


@@ -218,7 +223,7 @@ Returns a lazy sequence of lists like clojure.core/partition, but may include lists with fewer than n items at the end. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -231,7 +236,7 @@ Applies f to each value in coll, splitting it each time f returns a new value. Returns a lazy seq of lazy seqs. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -243,7 +248,7 @@ a new value. Returns a lazy seq of lazy seqs. is true for items in coll. - Source + Source


@@ -255,7 +260,7 @@ is true for items in coll. Return a random element of this seq Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -267,7 +272,7 @@ Return a random element of this seq binding-name, allowing for recursive expressions. - Source + Source


@@ -279,7 +284,7 @@ binding-name, allowing for recursive expressions. binding-name, allowing for recursive expressions. - Source + Source


@@ -293,7 +298,7 @@ Returns a lazy seq of the intermediate values of the reduction (as per reduce) of coll by f, starting with init. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -304,7 +309,7 @@ per reduce) of coll by f, starting with init.
Returns a lazy seq of all rotations of a seq
- Source + Source


@@ -316,7 +321,7 @@ per reduce) of coll by f, starting with init. [ (filter f s), (filter (complement f) s) ] - Source + Source


@@ -328,7 +333,7 @@ per reduce) of coll by f, starting with init. a multimethod that can have implementations for new classes and types. - Source + Source


@@ -340,7 +345,7 @@ a multimethod that can have implementations for new classes and types. Return a random permutation of coll Deprecated since clojure-contrib version 1.2
- Source + Source
diff --git a/server-socket-api.html b/server-socket-api.html index f20deda0..f5906664 100644 --- a/server-socket-api.html +++ b/server-socket-api.html @@ -1,6 +1,6 @@ - server-socket API reference (clojure-contrib) + server-socket - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for server-socket - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Craig McDaniel

Usage:
@@ -88,7 +93,7 @@ namespace.
   
create a repl on a socket
- Source + Source


@@ -107,7 +112,7 @@ Optional arguments support specifying a listen backlog and binding to a specific endpoint. - Source + Source
diff --git a/set-api.html b/set-api.html index c3be25c0..365ecace 100644 --- a/set-api.html +++ b/set-api.html @@ -1,6 +1,6 @@ - set API reference (clojure-contrib) + set - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -67,7 +71,8 @@ namespace.

API for set - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Jason Wolfe

Usage:
@@ -90,7 +95,7 @@ namespace.
   
Is s1 a proper subset of s2?
- Source + Source


@@ -101,7 +106,7 @@ namespace.
Is s1 a proper superset of s2?
- Source + Source


@@ -112,7 +117,7 @@ namespace.
Is set1 a subset of set2?
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -123,7 +128,7 @@ namespace.
Is set1 a superset of set2?
Deprecated since clojure-contrib version 1.2
- Source + Source
diff --git a/shell-api.html b/shell-api.html index fe9f06de..03d3909e 100644 --- a/shell-api.html +++ b/shell-api.html @@ -1,6 +1,6 @@ - shell API reference (clojure-contrib) + shell - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for shell - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser

Usage:
@@ -110,7 +115,7 @@ You can bind :env or :dir for multiple operations using with-sh-env
 and with-sh-dir.
- Source + Source
diff --git a/shell-out-api.html b/shell-out-api.html index 614d4a84..7288b1f0 100644 --- a/shell-out-api.html +++ b/shell-out-api.html @@ -1,6 +1,6 @@ - shell-out API reference (clojure-contrib) + shell-out - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for shell-out - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser

Usage:
@@ -110,7 +115,7 @@ You can bind :env or :dir for multiple operations using with-sh-env
 and with-sh-dir.
- Source + Source
diff --git a/singleton-api.html b/singleton-api.html index 8873e3a1..2945fd54 100644 --- a/singleton-api.html +++ b/singleton-api.html @@ -1,6 +1,6 @@ - singleton API reference (clojure-contrib) + singleton - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for singleton - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -92,7 +97,7 @@ Warning: global singletons are often unsafe in multi-threaded code.
 Consider per-thread-singleton instead.
- Source + Source


@@ -112,7 +117,7 @@ per-thread-singleton. See http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5025230 - Source + Source
diff --git a/sql-api.html b/sql-api.html index 7df538d0..686e8cc9 100644 --- a/sql-api.html +++ b/sql-api.html @@ -1,6 +1,6 @@ - sql API reference (clojure-contrib) + sql - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -119,7 +123,8 @@ namespace.

API for sql - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stephen C. Gilardi

Usage:
@@ -146,7 +151,7 @@ namespace.
   
Returns the current database connection (or throws if there is none)
- Source + Source


@@ -161,7 +166,7 @@ constraint: a vector containing words that express the constraint. All words used to describe the table may be supplied as strings or keywords. - Source + Source


@@ -174,7 +179,7 @@ providing the (optionally parameterized) selection criteria followed by values for any parameters. - Source + Source


@@ -185,7 +190,7 @@ values for any parameters.
Executes SQL commands on the open database connection.
- Source + Source


@@ -198,7 +203,7 @@ open database connection. Each param-group is a seq of values for all of the parameters. - Source + Source


@@ -210,7 +215,7 @@ the parameters. or keyword - Source + Source


@@ -221,7 +226,7 @@ or keyword
Returns the current database connection (or nil if there is none)
- Source + Source


@@ -233,7 +238,7 @@ or keyword keywords (identifying columns) to values. - Source + Source


@@ -245,7 +250,7 @@ keywords (identifying columns) to values. each of the table's columns in order. - Source + Source


@@ -260,7 +265,7 @@ order. When inserting complete rows (all columns), consider using insert-rows instead. - Source + Source


@@ -272,7 +277,7 @@ insert-rows instead. commit when complete - Source + Source


@@ -284,7 +289,7 @@ commit when complete commit when complete - Source + Source


@@ -301,7 +306,7 @@ transaction, the entire transaction will be rolled back rather than committed when complete. - Source + Source


@@ -316,7 +321,7 @@ criteria followed by values for any parameters. record is a map from strings or keywords (identifying columns) to updated values. - Source + Source


@@ -330,7 +335,7 @@ criteria followed by values for any parameters. record is a map from strings or keywords (identifying columns) to updated values. - Source + Source


@@ -362,7 +367,7 @@ JNDI: :environment (optional) a java.util.Map - Source + Source


@@ -376,7 +381,7 @@ the (optionally parameterized) SQL query followed by values for any parameters. - Source + Source

sql.internal


diff --git a/static/clojure.css b/static/clojure.css
index 5e3e6633..d40ea359 100644
--- a/static/clojure.css
+++ b/static/clojure.css
@@ -1,7 +1,7 @@
 
 body {margin: 0;padding: 0;background-color: #e3e3e3;border-top: 4px solid #b3ccfe;color: #272727}
 body, .wiki, #Content, .wikipage {font-family: "Lucida Grande","Trebuchet MS","Bitstream Vera Sans",Verdana,Helvetica,sans-serif;font-size: 12px;line-height: 18px;}
-#leftcolumn .wiki_link, #toc, #toc a {font-size: 11px;line-height: 18px;text-decoration: none}
+#leftcolumn .wiki_link, #toc, #toc a, .toc-header {font-size: 11px;line-height: 18px;text-decoration: none}
 img {border: 0;}
 #AllContentContainer {max-width: 96em;min-width: 663px;background: #fff url(space/content-background.gif) right repeat-y;padding: 0 40px 18px 0;}
 
@@ -20,7 +20,7 @@ img {border: 0;}
 
 #leftcolumn ul {list-style: none;margin: 0;padding: 0;}
 
-#leftcolumn a {font-weight: bold;display: block;background: transparent url(space/left-nav-divider.gif) repeat-x;padding: 6px 0 0 17px;margin: 12px 0 0 0;}
+#leftcolumn a, #leftcolumn .toc-header {font-weight: bold;display: block;background: transparent url(space/left-nav-divider.gif) repeat-x;padding: 6px 0 0 17px;margin: 12px 0 0 0;}
 #leftcolumn li a {font-weight: normal;background:none;margin: 0;padding: 0 0 0 17px;}
 #leftcolumn br {display: none;}
 #leftcolumn .menu {margin-top: 14px;background: #fff url(space/left-nav-background.gif) repeat-y;}
diff --git a/str-utils-api.html b/str-utils-api.html
index 56f340b3..fef9ca69 100644
--- a/str-utils-api.html
+++ b/str-utils-api.html
@@ -1,6 +1,6 @@
 
   
-    str-utils API reference (clojure-contrib)
+    str-utils - clojure-contrib v1.2 API documentation
     
     
     
@@ -30,18 +30,22 @@ namespace.
       
@@ -73,7 +77,8 @@ namespace.

API for str-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -97,7 +102,7 @@ namespace.
 string.  Note: String.trim() is similar and faster.
- Source + Source


@@ -108,7 +113,7 @@ string. Note: String.trim() is similar and faster.
Removes the last character of string.
- Source + Source


@@ -124,7 +129,7 @@ match. - Source + Source


@@ -143,7 +148,7 @@ For example: (re-partition #"[a-z]+" "abc123def") Returns: ("" "abc" "123" "def") - Source + Source


@@ -157,7 +162,7 @@ strings. Optional 'limit' argument is the maximum number of splits. Like Perl's 'split'. - Source + Source


@@ -173,7 +178,7 @@ the match. - Source + Source


@@ -185,7 +190,7 @@ the match. 'separator'. Like Perl's 'join'. - Source + Source
diff --git a/str-utils2-api.html b/str-utils2-api.html index f669afdd..8dc5b546 100644 --- a/str-utils2-api.html +++ b/str-utils2-api.html @@ -1,6 +1,6 @@ - str-utils2 API reference (clojure-contrib) + str-utils2 - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -121,7 +125,8 @@ namespace.

API for str-utils2 - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -158,7 +163,7 @@ Some ideas are borrowed from
   
True if s is nil, empty, or contains only whitespace.
- Source + Source


@@ -173,7 +178,7 @@ Note the argument order is the opposite of clojure.core/butlast; this is to keep the string as the first argument for use with -> - Source + Source


@@ -185,7 +190,7 @@ this is to keep the string as the first argument for use with -> characters to lower-case. - Source + Source


@@ -197,7 +202,7 @@ characters to lower-case. string. Note: String.trim() is similar and faster. - Source + Source


@@ -209,7 +214,7 @@ string. Note: String.trim() is similar and faster. string. - Source + Source


@@ -221,7 +226,7 @@ string. Unicode supplementary characters (above U+FFFF) correctly. - Source + Source


@@ -232,7 +237,7 @@ Unicode supplementary characters (above U+FFFF) correctly.
True if s contains the substring.
- Source + Source


@@ -247,7 +252,7 @@ string. Does NOT handle Unicode supplementary characters (above U+FFFF). - Source + Source


@@ -262,7 +267,7 @@ of each Unicode character in the string. Handles Unicode supplementary characters (above U+FFFF) correctly. - Source + Source


@@ -277,7 +282,7 @@ Note the argument order is the opposite of clojure.core/drop; this is to keep the string as the first argument for use with -> - Source + Source


@@ -290,7 +295,7 @@ character in s. If cmap returns nil, the original character is added to the output unchanged. - Source + Source


@@ -301,7 +306,7 @@ added to the output unchanged.
Gets the i'th character in string.
- Source + Source


@@ -313,7 +318,7 @@ added to the output unchanged. representation (with str) of each element is tested with re-find. - Source + Source


@@ -325,7 +330,7 @@ representation (with str) of each element is tested with re-find. separator. Like Perl's join. - Source + Source


@@ -336,7 +341,7 @@ separator. Like Perl's join.
Converts string to all lower-case.
- Source + Source


@@ -347,7 +352,7 @@ separator. Like Perl's join.
Removes whitespace from the left side of string.
- Source + Source


@@ -359,7 +364,7 @@ separator. Like Perl's join. String. - Source + Source


@@ -378,7 +383,7 @@ Example: (str-utils2/partial str-utils2/take 2) ;;=> (fn [s] (str-utils2/take s 2)) - Source + Source


@@ -396,7 +401,7 @@ For example: (partition "abc123def" #"[a-z]+") returns: ("" "abc" "123" "def") - Source + Source


@@ -407,7 +412,7 @@ returns: ("" "abc" "123" "def")
Returns a new String containing s repeated n times.
- Source + Source


@@ -427,7 +432,7 @@ Allowed argument types for pattern and replacement are: value as replacement.) - Source + Source


@@ -444,7 +449,7 @@ Allowed argument types for pattern and replacement are: 3. regex Pattern and function - Source + Source


@@ -455,7 +460,7 @@ Allowed argument types for pattern and replacement are:
Returns s with its characters reversed.
- Source + Source


@@ -466,7 +471,7 @@ Allowed argument types for pattern and replacement are:
Removes whitespace from the right side of string.
- Source + Source


@@ -479,7 +484,7 @@ Allowed argument types for pattern and replacement are: the maximum number of splits. - Source + Source


@@ -490,7 +495,7 @@ the maximum number of splits.
Splits s on \n or \r\n.
- Source + Source


@@ -504,7 +509,7 @@ locale-sensitive String.toUpperCase() and String.toLowerCase() methods. - Source + Source


@@ -515,7 +520,7 @@ methods.
Returns the last n characters of s.
- Source + Source


@@ -529,7 +534,7 @@ Note the argument order is the opposite of clojure.core/take; this is to keep the string as the first argument for use with -> - Source + Source


@@ -540,7 +545,7 @@ is to keep the string as the first argument for use with ->
Removes whitespace from both ends of string.
- Source + Source


@@ -551,7 +556,7 @@ is to keep the string as the first argument for use with ->
Converts string to all upper-case.
- Source + Source
diff --git a/stream-utils-api.html b/stream-utils-api.html index 4181aadd..a44af5ed 100644 --- a/stream-utils-api.html +++ b/stream-utils-api.html @@ -1,6 +1,6 @@ - stream-utils API reference (clojure-contrib) + stream-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -83,7 +87,8 @@ namespace.

API for stream-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -148,7 +153,7 @@ The non-stream arguments args and the stream arguments streams
 are given separately, with args being possibly empty.
- Source + Source


@@ -162,7 +167,7 @@ a type-specific method for stream-next and derives type from stream-type. - Source + Source


@@ -175,7 +180,7 @@ transformer. When used inside of defst, the name of the stream argument can be used instead of its index n. - Source + Source


@@ -187,7 +192,7 @@ argument can be used instead of its index n. inside a stream transformer. - Source + Source


@@ -198,7 +203,7 @@ inside a stream transformer.
Return a stream containing all but the first n elements of stream.
- Source + Source


@@ -210,7 +215,7 @@ inside a stream transformer. that satisfy the predicate p. - Source + Source


@@ -223,7 +228,7 @@ sequences. Flattening is not recursive, only one level of nesting will be removed. - Source + Source


@@ -234,7 +239,7 @@ will be removed. of any type handled by stream-next. - Source + Source


@@ -245,7 +250,7 @@ of any type handled by stream-next.
Return a new stream by mapping the function f on the given stream.
- Source + Source


@@ -259,7 +264,7 @@ is the new state of the stream. At the end of the stream, next-value and new-state are nil. - Source + Source


@@ -272,7 +277,7 @@ clojure.contrib.seq/seq-on and clojure.contrib.generic.collection/seq for streams. - Source + Source


@@ -283,7 +288,7 @@ clojure.contrib.generic.collection/seq for streams. add a derivation from this type. - Source + Source
diff --git a/string-api.html b/string-api.html index aeda2013..30759b68 100644 --- a/string-api.html +++ b/string-api.html @@ -1,6 +1,6 @@ - string API reference (clojure-contrib) + string - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -131,7 +135,8 @@ namespace.

API for string - (master branch)

+ - clojure-contrib v1.2 (beta 1) +
Usage:
@@ -168,7 +173,7 @@ Example:
    (as-str {:foo :bar})  ;;=> "{:foo :bar}" 
- Source + Source


@@ -179,7 +184,7 @@ Example:
True if s is nil, empty, or contains only whitespace.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -191,7 +196,7 @@ Example: if n is greater than the length of s. - Source + Source


@@ -203,7 +208,7 @@ if n is greater than the length of s. characters to lower-case. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -216,7 +221,7 @@ string. Note: String.trim() is similar and faster. Deprecated in 1.2. Use clojure.string/trim-newline Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -228,7 +233,7 @@ Deprecated in 1.2. Use clojure.string/trim-newline string. - Source + Source


@@ -240,7 +245,7 @@ string. Unicode supplementary characters (above U+FFFF) correctly. - Source + Source


@@ -255,7 +260,7 @@ string. Does NOT handle Unicode supplementary characters (above U+FFFF). - Source + Source


@@ -270,7 +275,7 @@ of each Unicode character in the string. Handles Unicode supplementary characters (above U+FFFF) correctly. - Source + Source


@@ -282,7 +287,7 @@ supplementary characters (above U+FFFF) correctly. greater than the length of s. - Source + Source


@@ -295,7 +300,7 @@ character in s. If cmap returns nil, the original character is added to the output unchanged. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -306,7 +311,7 @@ added to the output unchanged.
Gets the i'th character in string.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -318,7 +323,7 @@ added to the output unchanged. representation (with str) of each element is tested with re-find. - Source + Source


@@ -330,7 +335,7 @@ representation (with str) of each element is tested with re-find. separator. Like Perl's join. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -341,7 +346,7 @@ separator. Like Perl's join.
Converts string to all lower-case.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -353,7 +358,7 @@ separator. Like Perl's join. Deprecated in 1.2. Use clojure.string/triml. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -365,7 +370,7 @@ Deprecated in 1.2. Use clojure.string/triml. String. - Source + Source


@@ -383,7 +388,7 @@ For example: (partition #"[a-z]+" "abc123def") returns: ("" "abc" "123" "def") - Source + Source


@@ -394,7 +399,7 @@ returns: ("" "abc" "123" "def")
Returns a new String containing s repeated n times.
- Source + Source


@@ -406,7 +411,7 @@ returns: ("" "abc" "123" "def") (f (re-groups the-match)). Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -417,7 +422,7 @@ returns: ("" "abc" "123" "def")
Replaces all instances of character a with character b in s.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -429,7 +434,7 @@ returns: ("" "abc" "123" "def") (f (re-groups the-match)). Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -440,7 +445,7 @@ returns: ("" "abc" "123" "def")
Replace first match of re in s.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -451,7 +456,7 @@ returns: ("" "abc" "123" "def")
Replace first occurance of substring a with b in s.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -462,7 +467,7 @@ returns: ("" "abc" "123" "def")
Replaces all matches of re with replacement in s.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -473,7 +478,7 @@ returns: ("" "abc" "123" "def")
Replaces all instances of substring a with b in s.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -484,7 +489,7 @@ returns: ("" "abc" "123" "def")
Returns s with its characters reversed.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -496,7 +501,7 @@ returns: ("" "abc" "123" "def") Deprecated in 1.2. Use clojure.string/trimr. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -509,7 +514,7 @@ Deprecated in 1.2. Use clojure.string/trimr. the maximum number of splits. Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -520,7 +525,7 @@ the maximum number of splits.
Splits s on \n or \r\n.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -531,7 +536,7 @@ the maximum number of splits.
True if s contains the substring.
- Source + Source


@@ -545,7 +550,7 @@ locale-sensitive String.toUpperCase() and String.toLowerCase() methods. - Source + Source


@@ -556,7 +561,7 @@ methods.
Returns the last n characters of s.
- Source + Source


@@ -567,7 +572,7 @@ methods.
Take first n characters from s, up to the length of s.
- Source + Source


@@ -578,7 +583,7 @@ methods.
Removes whitespace from both ends of string.
Deprecated since clojure-contrib version 1.2
- Source + Source


@@ -589,7 +594,7 @@ methods.
Converts string to all upper-case.
Deprecated since clojure-contrib version 1.2
- Source + Source
diff --git a/strint-api.html b/strint-api.html index e68c6cb0..ab878843 100644 --- a/strint-api.html +++ b/strint-api.html @@ -1,6 +1,6 @@ - strint API reference (clojure-contrib) + strint - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -61,7 +65,8 @@ namespace.

API for strint - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chas Emerick

Usage:
@@ -103,7 +108,7 @@ Note that quotes surrounding string literals within ~() forms must be
 escaped.
- Source + Source
diff --git a/swing-utils-api.html b/swing-utils-api.html index 207ae02a..12041e39 100644 --- a/swing-utils-api.html +++ b/swing-utils-api.html @@ -1,6 +1,6 @@ - swing-utils API reference (clojure-contrib) + swing-utils - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -79,7 +83,8 @@ namespace.

API for swing-utils - (master branch)

+ - clojure-contrib v1.2 (beta 1) +
Usage:
diff --git a/test-is-api.html b/test-is-api.html
index 6a2a0c4c..3c0d8054 100644
--- a/test-is-api.html
+++ b/test-is-api.html
@@ -1,6 +1,6 @@
 
   
-    test-is API reference (clojure-contrib)
+    test-is - clojure-contrib v1.2 API documentation
     
     
     
@@ -30,18 +30,22 @@ namespace.
       
@@ -131,7 +135,8 @@ namespace.

API for test-is - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -193,7 +198,7 @@ complete stack trace.
values. Returns the modified expression. For use in macros. - Source + Source


@@ -215,7 +220,7 @@ Expands to: Note: This breaks some reporting features, such as line numbers. - Source + Source


@@ -299,7 +304,7 @@ Example: (do-template (check _1 _2) :a :b :c :d) expands to (do (check :a :b) (check :c :d)) - Source + Source


@@ -322,7 +327,7 @@ stack.
Recursively finds all symbols starting with _ in form.
- Source + Source


@@ -334,7 +339,7 @@ stack. any symbols starting with _ - Source + Source


@@ -345,7 +350,7 @@ any symbols starting with _
Recursively finds all symbols in form.
- Source + Source


@@ -356,7 +361,7 @@ any symbols starting with _
Transforms a map into a vector like [key value key value].
- Source + Source


@@ -509,7 +514,7 @@ were successful, false otherwise.
Returns true if form is a valid template expression.
- Source + Source


diff --git a/trace-api.html b/trace-api.html index 4d22ada1..7940ff6d 100644 --- a/trace-api.html +++ b/trace-api.html @@ -1,6 +1,6 @@ - trace API reference (clojure-contrib) + trace - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -73,7 +77,8 @@ namespace.

API for trace - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra, Michel Salim

Usage:
@@ -96,7 +101,7 @@ code is doing.
Current stack depth of traced function calls.
- Source + Source


@@ -109,7 +114,7 @@ arguments. Nested calls to deftrace'd functions will print a tree-like structure. - Source + Source


@@ -123,7 +128,7 @@ the traced functions. Does not work on inlined functions, such as clojure.core/+ - Source + Source


@@ -137,7 +142,7 @@ returns value. May be wrapped around any expression without affecting the result. - Source + Source


@@ -149,7 +154,7 @@ affecting the result. symbol name of the function. - Source + Source


@@ -160,7 +165,7 @@ symbol name of the function.
Returns an indentation string based on *trace-depth*
- Source + Source


@@ -172,7 +177,7 @@ symbol name of the function. may be rebound to do anything you like. 'name' is optional. - Source + Source
diff --git a/types-api.html b/types-api.html index 026022d7..fa05886d 100644 --- a/types-api.html +++ b/types-api.html @@ -1,6 +1,6 @@ - types API reference (clojure-contrib) + types - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -67,7 +71,8 @@ namespace.

API for types - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Konrad Hinsen

Usage:
@@ -93,7 +98,7 @@ list consisting of a tag symbol followed by the argument symbols.
 The data type tag must be a keyword.
- Source + Source


@@ -114,7 +119,7 @@ to be passed to the constructor in order to create an equivalent object. It is used for printing and matching. - Source + Source


@@ -125,7 +130,7 @@ object. It is used for printing and matching.
Same as deftype but the constructor is private.
- Source + Source


@@ -151,7 +156,7 @@ template the corresponding elements of the object must be equal for the template to match. - Source + Source
diff --git a/with-ns-api.html b/with-ns-api.html index 847baa58..ec257c90 100644 --- a/with-ns-api.html +++ b/with-ns-api.html @@ -1,6 +1,6 @@ - with-ns API reference (clojure-contrib) + with-ns - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -63,7 +67,8 @@ namespace.

API for with-ns - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Stuart Sierra

Usage:
@@ -88,7 +93,7 @@ object or a symbol.  This makes it possible to define functions in
 namespaces other than the current one.
- Source + Source


@@ -100,7 +105,7 @@ namespaces other than the current one. removed. The temporary namespace will 'refer' clojure.core. - Source + Source
diff --git a/zip-filter-api.html b/zip-filter-api.html index ca848f0f..85978b9c 100644 --- a/zip-filter-api.html +++ b/zip-filter-api.html @@ -1,6 +1,6 @@ - zip-filter API reference (clojure-contrib) + zip-filter - clojure-contrib v1.2 API documentation @@ -30,18 +30,22 @@ namespace.
@@ -95,7 +99,8 @@ namespace.

API for zip-filter - (master branch)

+ - clojure-contrib v1.2 (beta 1) + by Chris Houser

Usage:
@@ -121,7 +126,7 @@ with loc and proceeding to loc's parent node and on through to the
 root of the tree.
- Source + Source


@@ -133,7 +138,7 @@ root of the tree. left-to-right. - Source + Source


@@ -145,7 +150,7 @@ left-to-right. left-to-right, marked so that a following tag= predicate will auto-descend. - Source + Source


@@ -157,7 +162,7 @@ left-to-right, marked so that a following tag= predicate will auto-descend. - Source + Source


@@ -168,7 +173,7 @@ depth-first order, left-to-right, starting with loc.
Returns a lazy sequence of locations to the left of loc, starting with loc.
- Source + Source


@@ -179,7 +184,7 @@ depth-first order, left-to-right, starting with loc.
Returns true if there are no more nodes to the left of location loc.
- Source + Source


@@ -190,7 +195,7 @@ depth-first order, left-to-right, starting with loc.
Returns a lazy sequence of locations to the right of loc, starting with loc.
- Source + Source


@@ -201,7 +206,7 @@ depth-first order, left-to-right, starting with loc.
Returns true if there are no more nodes to the right of location loc.
- Source + Source

zip-filter.xml


@@ -218,7 +223,7 @@ depth-first order, left-to-right, starting with loc.
   
Returns the xml attribute named attrname, of the xml node at location loc.
- Source + Source

attr=

@@ -229,7 +234,7 @@ depth-first order, left-to-right, starting with loc. attribute named attrname whose value is attrval. - Source + Source

seq-test

@@ -240,7 +245,7 @@ attribute named attrname whose value is attrval. matches the query expresions given. - Source + Source

tag=

@@ -251,7 +256,7 @@ matches the query expresions given. named tagname. - Source + Source

text

@@ -262,7 +267,7 @@ named tagname. xpaths's value-of - Source + Source

text=

@@ -273,7 +278,7 @@ xpaths's value-of content equals s. - Source + Source

xml->

@@ -298,7 +303,7 @@ they match. See the footer of zip-query.clj for examples. - Source + Source

xml1->

@@ -309,7 +314,7 @@ See the footer of zip-query.clj for examples. given. See xml-> - Source + Source
-- cgit v1.2.3-18-g5258