Liking cljdoc? Tell your friends :D
Clojure only.

clojure.core

Fundamental library of the Clojure language

Fundamental library of the Clojure language

*

(*)
(* x)
(* x y)
(* x y & more)

Returns the product of nums. (*) returns 1. Does not auto-promote longs, will throw on overflow. See also: *'

Returns the product of nums. (*) returns 1. Does not auto-promote
longs, will throw on overflow. See also: *'
sourceraw docstring

*'

(*')
(*' x)
(*' x y)
(*' x y & more)

Returns the product of nums. (*') returns 1. Supports arbitrary precision. See also: *

Returns the product of nums. (*') returns 1. Supports arbitrary precision.
See also: *
sourceraw docstring

*1

bound in a repl thread to the most recent value printed

bound in a repl thread to the most recent value printed
sourceraw docstring

*2

bound in a repl thread to the second most recent value printed

bound in a repl thread to the second most recent value printed
sourceraw docstring

*3

bound in a repl thread to the third most recent value printed

bound in a repl thread to the third most recent value printed
sourceraw docstring

*agent*

The agent currently running an action on this thread, else nil

The agent currently running an action on this thread, else nil
sourceraw docstring

*allow-unresolved-vars*

source

*assert*

source

*clojure-version*

The version info for Clojure core, as a map containing :major :minor :incremental and :qualifier keys. Feature releases may increment :minor and/or :major, bugfix releases will increment :incremental. Possible values of :qualifier include "GA", "SNAPSHOT", "RC-x" "BETA-x"

The version info for Clojure core, as a map containing :major :minor 
:incremental and :qualifier keys. Feature releases may increment 
:minor and/or :major, bugfix releases will increment :incremental. 
Possible values of :qualifier include "GA", "SNAPSHOT", "RC-x" "BETA-x"
sourceraw docstring

*command-line-args*

A sequence of the supplied command line arguments, or nil if none were supplied

A sequence of the supplied command line arguments, or nil if
none were supplied
sourceraw docstring

*compile-files*

Set to true when compiling files, false otherwise.

Set to true when compiling files, false otherwise.
sourceraw docstring

*compile-path*

Specifies the directory where 'compile' will write out .class files. This directory must be in the classpath for 'compile' to work.

Defaults to "classes"

Specifies the directory where 'compile' will write out .class
files. This directory must be in the classpath for 'compile' to
work.

Defaults to "classes"
sourceraw docstring

*compiler-options*

A map of keys to options. Note, when binding dynamically make sure to merge with previous value. Supported options: :elide-meta - a collection of metadata keys to elide during compilation. :disable-locals-clearing - set to true to disable clearing, useful for using a debugger Alpha, subject to change.

A map of keys to options.
Note, when binding dynamically make sure to merge with previous value.
Supported options:
:elide-meta - a collection of metadata keys to elide during compilation.
:disable-locals-clearing - set to true to disable clearing, useful for using a debugger
Alpha, subject to change.
sourceraw docstring

*data-readers*

Map from reader tag symbols to data reader Vars.

When Clojure starts, it searches for files named 'data_readers.clj' and 'data_readers.cljc' at the root of the classpath. Each such file must contain a literal map of symbols, like this:

{foo/bar my.project.foo/bar
 foo/baz my.project/baz}

The first symbol in each pair is a tag that will be recognized by the Clojure reader. The second symbol in the pair is the fully-qualified name of a Var which will be invoked by the reader to parse the form following the tag. For example, given the data_readers.clj file above, the Clojure reader would parse this form:

#foo/bar [1 2 3]

by invoking the Var #'my.project.foo/bar on the vector [1 2 3]. The data reader function is invoked on the form AFTER it has been read as a normal Clojure data structure by the reader.

Reader tags without namespace qualifiers are reserved for Clojure. Default reader tags are defined in clojure.core/default-data-readers but may be overridden in data_readers.clj, data_readers.cljc, or by rebinding this Var.

Map from reader tag symbols to data reader Vars.

When Clojure starts, it searches for files named 'data_readers.clj'
and 'data_readers.cljc' at the root of the classpath. Each such file
must contain a literal map of symbols, like this:

    {foo/bar my.project.foo/bar
     foo/baz my.project/baz}

The first symbol in each pair is a tag that will be recognized by
the Clojure reader. The second symbol in the pair is the
fully-qualified name of a Var which will be invoked by the reader to
parse the form following the tag. For example, given the
data_readers.clj file above, the Clojure reader would parse this
form:

    #foo/bar [1 2 3]

by invoking the Var #'my.project.foo/bar on the vector [1 2 3]. The
data reader function is invoked on the form AFTER it has been read
as a normal Clojure data structure by the reader.

Reader tags without namespace qualifiers are reserved for
Clojure. Default reader tags are defined in
clojure.core/default-data-readers but may be overridden in
data_readers.clj, data_readers.cljc, or by rebinding this Var.
sourceraw docstring

*default-data-reader-fn*

When no data reader is found for a tag and default-data-reader-fn is non-nil, it will be called with two arguments, the tag and the value. If default-data-reader-fn is nil (the default), an exception will be thrown for the unknown tag.

When no data reader is found for a tag and *default-data-reader-fn*
is non-nil, it will be called with two arguments,
the tag and the value.  If *default-data-reader-fn* is nil (the
default), an exception will be thrown for the unknown tag.
sourceraw docstring

*e

bound in a repl thread to the most recent exception caught by the repl

bound in a repl thread to the most recent exception caught by the repl
sourceraw docstring

*err*

A java.io.Writer object representing standard error for print operations.

Defaults to System/err, wrapped in a PrintWriter

A java.io.Writer object representing standard error for print operations.

Defaults to System/err, wrapped in a PrintWriter
sourceraw docstring

*file*

The path of the file being evaluated, as a String.

When there is no file, e.g. in the REPL, the value is not defined.

The path of the file being evaluated, as a String.

When there is no file, e.g. in the REPL, the value is not defined.
sourceraw docstring

*flush-on-newline*

When set to true, output will be flushed whenever a newline is printed.

Defaults to true.

When set to true, output will be flushed whenever a newline is printed.

Defaults to true.
sourceraw docstring

*fn-loader*

source

*in*

A java.io.Reader object representing standard input for read operations.

Defaults to System/in, wrapped in a LineNumberingPushbackReader

A java.io.Reader object representing standard input for read operations.

Defaults to System/in, wrapped in a LineNumberingPushbackReader
sourceraw docstring

*math-context*

source

*ns*

A clojure.lang.Namespace object representing the current namespace.

A clojure.lang.Namespace object representing the current namespace.
sourceraw docstring

*out*

A java.io.Writer object representing standard output for print operations.

Defaults to System/out, wrapped in an OutputStreamWriter

A java.io.Writer object representing standard output for print operations.

Defaults to System/out, wrapped in an OutputStreamWriter
sourceraw docstring

*print-dup*

When set to logical true, objects will be printed in a way that preserves their type when read in later.

Defaults to false.

When set to logical true, objects will be printed in a way that preserves
their type when read in later.

Defaults to false.
sourceraw docstring

*print-length*

print-length controls how many items of each collection the printer will print. If it is bound to logical false, there is no limit. Otherwise, it must be bound to an integer indicating the maximum number of items of each collection to print. If a collection contains more items, the printer will print items up to the limit followed by '...' to represent the remaining items. The root binding is nil indicating no limit.

*print-length* controls how many items of each collection the
printer will print. If it is bound to logical false, there is no
limit. Otherwise, it must be bound to an integer indicating the maximum
number of items of each collection to print. If a collection contains
more items, the printer will print items up to the limit followed by
'...' to represent the remaining items. The root binding is nil
indicating no limit.
sourceraw docstring

*print-level*

print-level controls how many levels deep the printer will print nested objects. If it is bound to logical false, there is no limit. Otherwise, it must be bound to an integer indicating the maximum level to print. Each argument to print is at level 0; if an argument is a collection, its items are at level 1; and so on. If an object is a collection and is at a level greater than or equal to the value bound to print-level, the printer prints '#' to represent it. The root binding is nil indicating no limit.

*print-level* controls how many levels deep the printer will
print nested objects. If it is bound to logical false, there is no
limit. Otherwise, it must be bound to an integer indicating the maximum
level to print. Each argument to print is at level 0; if an argument is a
collection, its items are at level 1; and so on. If an object is a
collection and is at a level greater than or equal to the value bound to
*print-level*, the printer prints '#' to represent it. The root binding
is nil indicating no limit.
sourceraw docstring

*print-meta*

If set to logical true, when printing an object, its metadata will also be printed in a form that can be read back by the reader.

Defaults to false.

If set to logical true, when printing an object, its metadata will also
be printed in a form that can be read back by the reader.

Defaults to false.
sourceraw docstring

*print-namespace-maps*

print-namespace-maps controls whether the printer will print namespace map literal syntax. It defaults to false, but the REPL binds to true.

*print-namespace-maps* controls whether the printer will print
namespace map literal syntax. It defaults to false, but the REPL binds
to true.
sourceraw docstring

*print-readably*

When set to logical false, strings and characters will be printed with non-alphanumeric characters converted to the appropriate escape sequences.

Defaults to true

When set to logical false, strings and characters will be printed with
non-alphanumeric characters converted to the appropriate escape sequences.

Defaults to true
sourceraw docstring

*read-eval*

Defaults to true (or value specified by system property, see below) This setting implies that the full power of the reader is in play, including syntax that can cause code to execute. It should never be used with untrusted sources. See also: clojure.edn/read.

When set to logical false in the thread-local binding, the eval reader (#=) and record/type literal syntax are disabled in read/load. Example (will fail): (binding [read-eval false] (read-string "#=(* 2 21)"))

The default binding can be controlled by the system property 'clojure.read.eval' System properties can be set on the command line like this:

java -Dclojure.read.eval=false ...

The system property can also be set to 'unknown' via -Dclojure.read.eval=unknown, in which case the default binding is :unknown and all reads will fail in contexts where read-eval has not been explicitly bound to either true or false. This setting can be a useful diagnostic tool to ensure that all of your reads occur in considered contexts. You can also accomplish this in a particular scope by binding read-eval to :unknown

Defaults to true (or value specified by system property, see below)
***This setting implies that the full power of the reader is in play,
including syntax that can cause code to execute. It should never be
used with untrusted sources. See also: clojure.edn/read.***

When set to logical false in the thread-local binding,
the eval reader (#=) and record/type literal syntax are disabled in read/load.
Example (will fail): (binding [*read-eval* false] (read-string "#=(* 2 21)"))

The default binding can be controlled by the system property
'clojure.read.eval' System properties can be set on the command line
like this:

java -Dclojure.read.eval=false ...

The system property can also be set to 'unknown' via
-Dclojure.read.eval=unknown, in which case the default binding
is :unknown and all reads will fail in contexts where *read-eval*
has not been explicitly bound to either true or false. This setting
can be a useful diagnostic tool to ensure that all of your reads
occur in considered contexts. You can also accomplish this in a
particular scope by binding *read-eval* to :unknown
sourceraw docstring

*reader-resolver*

source

*source-path*

source

*suppress-read*

source

*unchecked-math*

While bound to true, compilations of +, -, *, inc, dec and the coercions will be done without overflow checks. While bound to :warn-on-boxed, same behavior as true, and a warning is emitted when compilation uses boxed math. Default: false.

While bound to true, compilations of +, -, *, inc, dec and the
coercions will be done without overflow checks. While bound
to :warn-on-boxed, same behavior as true, and a warning is emitted
when compilation uses boxed math. Default: false.
sourceraw docstring

*use-context-classloader*

source

*verbose-defrecords*

source

*warn-on-reflection*

When set to true, the compiler will emit warnings when reflection is needed to resolve Java method calls or field accesses.

Defaults to false.

When set to true, the compiler will emit warnings when reflection is
needed to resolve Java method calls or field accesses.

Defaults to false.
sourceraw docstring

+

(+)
(+ x)
(+ x y)
(+ x y & more)

Returns the sum of nums. (+) returns 0. Does not auto-promote longs, will throw on overflow. See also: +'

Returns the sum of nums. (+) returns 0. Does not auto-promote
longs, will throw on overflow. See also: +'
sourceraw docstring

+'

(+')
(+' x)
(+' x y)
(+' x y & more)

Returns the sum of nums. (+') returns 0. Supports arbitrary precision. See also: +

Returns the sum of nums. (+') returns 0. Supports arbitrary precision.
See also: +
sourceraw docstring

-

(- x)
(- x y)
(- x y & more)

If no ys are supplied, returns the negation of x, else subtracts the ys from x and returns the result. Does not auto-promote longs, will throw on overflow. See also: -'

If no ys are supplied, returns the negation of x, else subtracts
the ys from x and returns the result. Does not auto-promote
longs, will throw on overflow. See also: -'
sourceraw docstring

-'

(-' x)
(-' x y)
(-' x y & more)

If no ys are supplied, returns the negation of x, else subtracts the ys from x and returns the result. Supports arbitrary precision. See also: -

If no ys are supplied, returns the negation of x, else subtracts
the ys from x and returns the result. Supports arbitrary precision.
See also: -
sourceraw docstring

->macro

(-> x
    &
    forms)

Threads the expr through the forms. Inserts x as the second item in the first form, making a list of it if it is not a list already. If there are more forms, inserts the first form as the second item in second form, etc.

Threads the expr through the forms. Inserts x as the
second item in the first form, making a list of it if it is not a
list already. If there are more forms, inserts the first form as the
second item in second form, etc.
sourceraw docstring

->>macro

(->> x
     &
     forms)

Threads the expr through the forms. Inserts x as the last item in the first form, making a list of it if it is not a list already. If there are more forms, inserts the first form as the last item in second form, etc.

Threads the expr through the forms. Inserts x as the
last item in the first form, making a list of it if it is not a
list already. If there are more forms, inserts the first form as the
last item in second form, etc.
sourceraw docstring

-cache-protocol-fn

(-cache-protocol-fn pf x c interf)
source

-reset-methods

(-reset-methods protocol)
source

..macro

(.. x form)
(.. x form & more)

form => fieldName-symbol or (instanceMethodName-symbol args*)

Expands into a member access (.) of the first member on the first argument, followed by the next member on the result, etc. For instance:

(.. System (getProperties) (get "os.name"))

expands to:

(. (. System (getProperties)) (get "os.name"))

but is easier to write, read, and understand.

form => fieldName-symbol or (instanceMethodName-symbol args*)

Expands into a member access (.) of the first member on the first
argument, followed by the next member on the result, etc. For
instance:

(.. System (getProperties) (get "os.name"))

expands to:

(. (. System (getProperties)) (get "os.name"))

but is easier to write, read, and understand.
sourceraw docstring

/

(/ x)
(/ x y)
(/ x y & more)

If no denominators are supplied, returns 1/numerator, else returns numerator divided by all of the denominators.

If no denominators are supplied, returns 1/numerator,
else returns numerator divided by all of the denominators.
sourceraw docstring

<

(< x)
(< x y)
(< x y & more)

Returns non-nil if nums are in monotonically increasing order, otherwise false.

Returns non-nil if nums are in monotonically increasing order,
otherwise false.
sourceraw docstring

<=

(<= x)
(<= x y)
(<= x y & more)

Returns non-nil if nums are in monotonically non-decreasing order, otherwise false.

Returns non-nil if nums are in monotonically non-decreasing order,
otherwise false.
sourceraw docstring

=

(= x)
(= x y)
(= x y & more)

Equality. Returns true if x equals y, false if not. Same as Java x.equals(y) except it also works for nil, and compares numbers and collections in a type-independent manner. Clojure's immutable data structures define equals() (and thus =) as a value, not an identity, comparison.

Equality. Returns true if x equals y, false if not. Same as
Java x.equals(y) except it also works for nil, and compares
numbers and collections in a type-independent manner.  Clojure's immutable data
structures define equals() (and thus =) as a value, not an identity,
comparison.
sourceraw docstring

==

(== x)
(== x y)
(== x y & more)

Returns non-nil if nums all have the equivalent value (type-independent), otherwise false

Returns non-nil if nums all have the equivalent
value (type-independent), otherwise false
sourceraw docstring

>

(> x)
(> x y)
(> x y & more)

Returns non-nil if nums are in monotonically decreasing order, otherwise false.

Returns non-nil if nums are in monotonically decreasing order,
otherwise false.
sourceraw docstring

>=

(>= x)
(>= x y)
(>= x y & more)

Returns non-nil if nums are in monotonically non-increasing order, otherwise false.

Returns non-nil if nums are in monotonically non-increasing order,
otherwise false.
sourceraw docstring

accessor

(accessor s key)

Returns a fn that, given an instance of a structmap with the basis, returns the value at the key. The key must be in the basis. The returned function should be (slightly) more efficient than using get, but such use of accessors should be limited to known performance-critical areas.

Returns a fn that, given an instance of a structmap with the basis,
returns the value at the key.  The key must be in the basis. The
returned function should be (slightly) more efficient than using
get, but such use of accessors should be limited to known
performance-critical areas.
sourceraw docstring

aclone

(aclone array)

Returns a clone of the Java array. Works on arrays of known types.

Returns a clone of the Java array. Works on arrays of known
types.
sourceraw docstring

add-classpathdeprecated

(add-classpath url)

DEPRECATED

Adds the url (String or URL object) to the classpath per URLClassLoader.addURL

DEPRECATED 

Adds the url (String or URL object) to the classpath per
URLClassLoader.addURL
sourceraw docstring

add-tap

(add-tap f)

adds f, a fn of one argument, to the tap set. This function will be called with anything sent via tap>. This function may (briefly) block (e.g. for streams), and will never impede calls to tap>, but blocking indefinitely may cause tap values to be dropped. Remember f in order to remove-tap

adds f, a fn of one argument, to the tap set. This function will be called with anything sent via tap>.
This function may (briefly) block (e.g. for streams), and will never impede calls to tap>,
but blocking indefinitely may cause tap values to be dropped.
Remember f in order to remove-tap
sourceraw docstring

add-watch

(add-watch reference key fn)

Adds a watch function to an agent/atom/var/ref reference. The watch fn must be a fn of 4 args: a key, the reference, its old-state, its new-state. Whenever the reference's state might have been changed, any registered watches will have their functions called. The watch fn will be called synchronously, on the agent's thread if an agent, before any pending sends if agent or ref. Note that an atom's or ref's state may have changed again prior to the fn call, so use old/new-state rather than derefing the reference. Note also that watch fns may be called from multiple threads simultaneously. Var watchers are triggered only by root binding changes, not thread-local set!s. Keys must be unique per reference, and can be used to remove the watch with remove-watch, but are otherwise considered opaque by the watch mechanism.

Adds a watch function to an agent/atom/var/ref reference. The watch
fn must be a fn of 4 args: a key, the reference, its old-state, its
new-state. Whenever the reference's state might have been changed,
any registered watches will have their functions called. The watch fn
will be called synchronously, on the agent's thread if an agent,
before any pending sends if agent or ref. Note that an atom's or
ref's state may have changed again prior to the fn call, so use
old/new-state rather than derefing the reference. Note also that watch
fns may be called from multiple threads simultaneously. Var watchers
are triggered only by root binding changes, not thread-local
set!s. Keys must be unique per reference, and can be used to remove
the watch with remove-watch, but are otherwise considered opaque by
the watch mechanism.
sourceraw docstring

agent

(agent state & options)

Creates and returns an agent with an initial value of state and zero or more options (in any order):

:meta metadata-map

:validator validate-fn

:error-handler handler-fn

:error-mode mode-keyword

If metadata-map is supplied, it will become the metadata on the agent. validate-fn must be nil or a side-effect-free fn of one argument, which will be passed the intended new state on any state change. If the new state is unacceptable, the validate-fn should return false or throw an exception. handler-fn is called if an action throws an exception or if validate-fn rejects a new state -- see set-error-handler! for details. The mode-keyword may be either :continue (the default if an error-handler is given) or :fail (the default if no error-handler is given) -- see set-error-mode! for details.

Creates and returns an agent with an initial value of state and
zero or more options (in any order):

:meta metadata-map

:validator validate-fn

:error-handler handler-fn

:error-mode mode-keyword

If metadata-map is supplied, it will become the metadata on the
agent. validate-fn must be nil or a side-effect-free fn of one
argument, which will be passed the intended new state on any state
change. If the new state is unacceptable, the validate-fn should
return false or throw an exception.  handler-fn is called if an
action throws an exception or if validate-fn rejects a new state --
see set-error-handler! for details.  The mode-keyword may be either
:continue (the default if an error-handler is given) or :fail (the
default if no error-handler is given) -- see set-error-mode! for
details.
sourceraw docstring

agent-error

(agent-error a)

Returns the exception thrown during an asynchronous action of the agent if the agent is failed. Returns nil if the agent is not failed.

Returns the exception thrown during an asynchronous action of the
agent if the agent is failed.  Returns nil if the agent is not
failed.
sourceraw docstring

agent-errorsdeprecated

(agent-errors a)

DEPRECATED: Use 'agent-error' instead. Returns a sequence of the exceptions thrown during asynchronous actions of the agent.

DEPRECATED: Use 'agent-error' instead.
Returns a sequence of the exceptions thrown during asynchronous
actions of the agent.
sourceraw docstring

aget

(aget array idx)
(aget array idx & idxs)

Returns the value at the index/indices. Works on Java arrays of all types.

Returns the value at the index/indices. Works on Java arrays of all
types.
sourceraw docstring

alength

(alength array)

Returns the length of the Java array. Works on arrays of all types.

Returns the length of the Java array. Works on arrays of all
types.
sourceraw docstring

alias

(alias alias namespace-sym)

Add an alias in the current namespace to another namespace. Arguments are two symbols: the alias to be used, and the symbolic name of the target namespace. Use :as in the ns macro in preference to calling this directly.

Add an alias in the current namespace to another
namespace. Arguments are two symbols: the alias to be used, and
the symbolic name of the target namespace. Use :as in the ns macro in preference
to calling this directly.
sourceraw docstring

all-ns

(all-ns)

Returns a sequence of all namespaces.

Returns a sequence of all namespaces.
sourceraw docstring

alter

(alter ref fun & args)

Must be called in a transaction. Sets the in-transaction-value of ref to:

(apply fun in-transaction-value-of-ref args)

and returns the in-transaction-value of ref.

Must be called in a transaction. Sets the in-transaction-value of
ref to:

(apply fun in-transaction-value-of-ref args)

and returns the in-transaction-value of ref.
sourceraw docstring

alter-meta!

(alter-meta! iref f & args)

Atomically sets the metadata for a namespace/var/ref/agent/atom to be:

(apply f its-current-meta args)

f must be free of side-effects

Atomically sets the metadata for a namespace/var/ref/agent/atom to be:

(apply f its-current-meta args)

f must be free of side-effects
sourceraw docstring

alter-var-root

(alter-var-root v f & args)

Atomically alters the root binding of var v by applying f to its current value plus any args

Atomically alters the root binding of var v by applying f to its
current value plus any args
sourceraw docstring

amapmacro

(amap a idx ret expr)

Maps an expression across an array a, using an index named idx, and return value named ret, initialized to a clone of a, then setting each element of ret to the evaluation of expr, returning the new array ret.

Maps an expression across an array a, using an index named idx, and
return value named ret, initialized to a clone of a, then setting 
each element of ret to the evaluation of expr, returning the new 
array ret.
sourceraw docstring

ancestors

(ancestors tag)
(ancestors h tag)

Returns the immediate and indirect parents of tag, either via a Java type inheritance relationship or a relationship established via derive. h must be a hierarchy obtained from make-hierarchy, if not supplied defaults to the global hierarchy

Returns the immediate and indirect parents of tag, either via a Java type
inheritance relationship or a relationship established via derive. h
must be a hierarchy obtained from make-hierarchy, if not supplied
defaults to the global hierarchy
sourceraw docstring

andmacro

(and)
(and x)
(and x & next)

Evaluates exprs one at a time, from left to right. If a form returns logical false (nil or false), and returns that value and doesn't evaluate any of the other expressions, otherwise it returns the value of the last expr. (and) returns true.

Evaluates exprs one at a time, from left to right. If a form
returns logical false (nil or false), and returns that value and
doesn't evaluate any of the other expressions, otherwise it returns
the value of the last expr. (and) returns true.
sourceraw docstring

any?

(any? x)

Returns true given any argument.

Returns true given any argument.
sourceraw docstring

apply

(apply f args)
(apply f x args)
(apply f x y args)
(apply f x y z args)
(apply f a b c d & args)

Applies fn f to the argument list formed by prepending intervening arguments to args.

Applies fn f to the argument list formed by prepending intervening arguments to args.
sourceraw docstring

areducemacro

(areduce a idx ret init expr)

Reduces an expression across an array a, using an index named idx, and return value named ret, initialized to init, setting ret to the evaluation of expr at each step, returning ret.

Reduces an expression across an array a, using an index named idx,
and return value named ret, initialized to init, setting ret to the 
evaluation of expr at each step, returning ret.
sourceraw docstring

array-map

(array-map)
(array-map & keyvals)

Constructs an array-map. If any keys are equal, they are handled as if by repeated uses of assoc.

Constructs an array-map. If any keys are equal, they are handled as
if by repeated uses of assoc.
sourceraw docstring

as->macro

(as-> expr name & forms)

Binds name to expr, evaluates the first form in the lexical context of that binding, then binds name to that result, repeating for each successive form, returning the result of the last form.

Binds name to expr, evaluates the first form in the lexical context
of that binding, then binds name to that result, repeating for each
successive form, returning the result of the last form.
sourceraw docstring

aset

(aset array idx val)
(aset array idx idx2 & idxv)

Sets the value at the index/indices. Works on Java arrays of reference types. Returns val.

Sets the value at the index/indices. Works on Java arrays of
reference types. Returns val.
sourceraw docstring

aset-boolean

(aset-boolean array idx val)
(aset-boolean array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of boolean. Returns val.

Sets the value at the index/indices. Works on arrays of boolean. Returns val.
sourceraw docstring

aset-byte

(aset-byte array idx val)
(aset-byte array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of byte. Returns val.

Sets the value at the index/indices. Works on arrays of byte. Returns val.
sourceraw docstring

aset-char

(aset-char array idx val)
(aset-char array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of char. Returns val.

Sets the value at the index/indices. Works on arrays of char. Returns val.
sourceraw docstring

aset-double

(aset-double array idx val)
(aset-double array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of double. Returns val.

Sets the value at the index/indices. Works on arrays of double. Returns val.
sourceraw docstring

aset-float

(aset-float array idx val)
(aset-float array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of float. Returns val.

Sets the value at the index/indices. Works on arrays of float. Returns val.
sourceraw docstring

aset-int

(aset-int array idx val)
(aset-int array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of int. Returns val.

Sets the value at the index/indices. Works on arrays of int. Returns val.
sourceraw docstring

aset-long

(aset-long array idx val)
(aset-long array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of long. Returns val.

Sets the value at the index/indices. Works on arrays of long. Returns val.
sourceraw docstring

aset-short

(aset-short array idx val)
(aset-short array idx idx2 & idxv)

Sets the value at the index/indices. Works on arrays of short. Returns val.

Sets the value at the index/indices. Works on arrays of short. Returns val.
sourceraw docstring

assertmacro

(assert x)
(assert x message)

Evaluates expr and throws an exception if it does not evaluate to logical true.

Evaluates expr and throws an exception if it does not evaluate to
logical true.
sourceraw docstring

assoc

(assoc map key val)
(assoc map
  key val
  & kvs)

assoc[iate]. When applied to a map, returns a new map of the same (hashed/sorted) type, that contains the mapping of key(s) to val(s). When applied to a vector, returns a new vector that contains val at index. Note - index must be <= (count vector).

assoc[iate]. When applied to a map, returns a new map of the
same (hashed/sorted) type, that contains the mapping of key(s) to
val(s). When applied to a vector, returns a new vector that
contains val at index. Note - index must be <= (count vector).
sourceraw docstring

assoc!

(assoc! coll key val)
(assoc! coll key val & kvs)

When applied to a transient map, adds mapping of key(s) to val(s). When applied to a transient vector, sets the val at index. Note - index must be <= (count vector). Returns coll.

When applied to a transient map, adds mapping of key(s) to
val(s). When applied to a transient vector, sets the val at index.
Note - index must be <= (count vector). Returns coll.
sourceraw docstring

assoc-in

(assoc-in m [k & ks] v)

Associates a value in a nested associative structure, where ks is a sequence of keys and v is the new value and returns a new nested structure. If any levels do not exist, hash-maps will be created.

Associates a value in a nested associative structure, where ks is a
sequence of keys and v is the new value and returns a new nested structure.
If any levels do not exist, hash-maps will be created.
sourceraw docstring

associative?

(associative? coll)

Returns true if coll implements Associative

Returns true if coll implements Associative
sourceraw docstring

atom

(atom x)
(atom x & options)

Creates and returns an Atom with an initial value of x and zero or more options (in any order):

:meta metadata-map

:validator validate-fn

If metadata-map is supplied, it will become the metadata on the atom. validate-fn must be nil or a side-effect-free fn of one argument, which will be passed the intended new state on any state change. If the new state is unacceptable, the validate-fn should return false or throw an exception.

Creates and returns an Atom with an initial value of x and zero or
more options (in any order):

:meta metadata-map

:validator validate-fn

If metadata-map is supplied, it will become the metadata on the
atom. validate-fn must be nil or a side-effect-free fn of one
argument, which will be passed the intended new state on any state
change. If the new state is unacceptable, the validate-fn should
return false or throw an exception.
sourceraw docstring

await

(await & agents)

Blocks the current thread (indefinitely!) until all actions dispatched thus far, from this thread or agent, to the agent(s) have occurred. Will block on failed agents. Will never return if a failed agent is restarted with :clear-actions true or shutdown-agents was called.

Blocks the current thread (indefinitely!) until all actions
dispatched thus far, from this thread or agent, to the agent(s) have
occurred.  Will block on failed agents.  Will never return if
a failed agent is restarted with :clear-actions true or shutdown-agents was called.
sourceraw docstring

await-for

(await-for timeout-ms & agents)

Blocks the current thread until all actions dispatched thus far (from this thread or agent) to the agents have occurred, or the timeout (in milliseconds) has elapsed. Returns logical false if returning due to timeout, logical true otherwise.

Blocks the current thread until all actions dispatched thus
far (from this thread or agent) to the agents have occurred, or the
timeout (in milliseconds) has elapsed. Returns logical false if
returning due to timeout, logical true otherwise.
sourceraw docstring

await1

(await1 a)
source

bases

(bases c)

Returns the immediate superclass and direct interfaces of c, if any

Returns the immediate superclass and direct interfaces of c, if any
sourceraw docstring

bean

(bean x)

Takes a Java object and returns a read-only implementation of the map abstraction based upon its JavaBean properties.

Takes a Java object and returns a read-only implementation of the
map abstraction based upon its JavaBean properties.
sourceraw docstring

bigdec

(bigdec x)

Coerce to BigDecimal

Coerce to BigDecimal
sourceraw docstring

bigint

(bigint x)

Coerce to BigInt

Coerce to BigInt
sourceraw docstring

biginteger

(biginteger x)

Coerce to BigInteger

Coerce to BigInteger
sourceraw docstring

bindingmacro

(binding bindings
         &
         body)

binding => var-symbol init-expr

Creates new bindings for the (already-existing) vars, with the supplied initial values, executes the exprs in an implicit do, then re-establishes the bindings that existed before. The new bindings are made in parallel (unlike let); all init-exprs are evaluated before the vars are bound to their new values.

binding => var-symbol init-expr

Creates new bindings for the (already-existing) vars, with the
supplied initial values, executes the exprs in an implicit do, then
re-establishes the bindings that existed before.  The new bindings
are made in parallel (unlike let); all init-exprs are evaluated
before the vars are bound to their new values.
sourceraw docstring

bit-and

(bit-and x y)
(bit-and x y & more)

Bitwise and

Bitwise and
sourceraw docstring

bit-and-not

(bit-and-not x y)
(bit-and-not x y & more)

Bitwise and with complement

Bitwise and with complement
sourceraw docstring

bit-clear

(bit-clear x n)

Clear bit at index n

Clear bit at index n
sourceraw docstring

bit-flip

(bit-flip x n)

Flip bit at index n

Flip bit at index n
sourceraw docstring

bit-not

(bit-not x)

Bitwise complement

Bitwise complement
sourceraw docstring

bit-or

(bit-or x y)
(bit-or x y & more)

Bitwise or

Bitwise or
sourceraw docstring

bit-set

(bit-set x n)

Set bit at index n

Set bit at index n
sourceraw docstring

bit-shift-left

(bit-shift-left x n)

Bitwise shift left

Bitwise shift left
sourceraw docstring

bit-shift-right

(bit-shift-right x n)

Bitwise shift right

Bitwise shift right
sourceraw docstring

bit-test

(bit-test x n)

Test bit at index n

Test bit at index n
sourceraw docstring

bit-xor

(bit-xor x y)
(bit-xor x y & more)

Bitwise exclusive or

Bitwise exclusive or
sourceraw docstring

boolean

(boolean x)

Coerce to boolean

Coerce to boolean
sourceraw docstring

boolean-array

(boolean-array size-or-seq)
(boolean-array size init-val-or-seq)

Creates an array of booleans

Creates an array of booleans
sourceraw docstring

boolean?

(boolean? x)

Return true if x is a Boolean

Return true if x is a Boolean
sourceraw docstring

booleans

(booleans xs)

Casts to boolean[]

Casts to boolean[]
sourceraw docstring

bound-fnmacro

(bound-fn & fntail)

Returns a function defined by the given fntail, which will install the same bindings in effect as in the thread at the time bound-fn was called. This may be used to define a helper function which runs on a different thread, but needs the same bindings in place.

Returns a function defined by the given fntail, which will install the
same bindings in effect as in the thread at the time bound-fn was called.
This may be used to define a helper function which runs on a different
thread, but needs the same bindings in place.
sourceraw docstring

bound-fn*

(bound-fn* f)

Returns a function, which will install the same bindings in effect as in the thread at the time bound-fn* was called and then call f with any given arguments. This may be used to define a helper function which runs on a different thread, but needs the same bindings in place.

Returns a function, which will install the same bindings in effect as in
the thread at the time bound-fn* was called and then call f with any given
arguments. This may be used to define a helper function which runs on a
different thread, but needs the same bindings in place.
sourceraw docstring

bound?

(bound? & vars)

Returns true if all of the vars provided as arguments have any bound value, root or thread-local. Implies that deref'ing the provided vars will succeed. Returns true if no vars are provided.

Returns true if all of the vars provided as arguments have any bound value, root or thread-local.
Implies that deref'ing the provided vars will succeed. Returns true if no vars are provided.
sourceraw docstring

bounded-count

(bounded-count n coll)

If coll is counted? returns its count, else will count at most the first n elements of coll using its seq

If coll is counted? returns its count, else will count at most the first n
elements of coll using its seq
sourceraw docstring

butlast

(butlast coll)

Return a seq of all but the last item in coll, in linear time

Return a seq of all but the last item in coll, in linear time
sourceraw docstring

byte

(byte x)

Coerce to byte

Coerce to byte
sourceraw docstring

byte-array

(byte-array size-or-seq)
(byte-array size init-val-or-seq)

Creates an array of bytes

Creates an array of bytes
sourceraw docstring

bytes

(bytes xs)

Casts to bytes[]

Casts to bytes[]
sourceraw docstring

bytes?

(bytes? x)

Return true if x is a byte array

Return true if x is a byte array
sourceraw docstring

casemacro

(case e & clauses)

Takes an expression, and a set of clauses.

Each clause can take the form of either:

test-constant result-expr

(test-constant1 ... test-constantN) result-expr

The test-constants are not evaluated. They must be compile-time literals, and need not be quoted. If the expression is equal to a test-constant, the corresponding result-expr is returned. A single default expression can follow the clauses, and its value will be returned if no clause matches. If no default expression is provided and no clause matches, an IllegalArgumentException is thrown.

Unlike cond and condp, case does a constant-time dispatch, the clauses are not considered sequentially. All manner of constant expressions are acceptable in case, including numbers, strings, symbols, keywords, and (Clojure) composites thereof. Note that since lists are used to group multiple constants that map to the same expression, a vector can be used to match a list if needed. The test-constants need not be all of the same type.

Takes an expression, and a set of clauses.

Each clause can take the form of either:

test-constant result-expr

(test-constant1 ... test-constantN)  result-expr

The test-constants are not evaluated. They must be compile-time
literals, and need not be quoted.  If the expression is equal to a
test-constant, the corresponding result-expr is returned. A single
default expression can follow the clauses, and its value will be
returned if no clause matches. If no default expression is provided
and no clause matches, an IllegalArgumentException is thrown.

Unlike cond and condp, case does a constant-time dispatch, the
clauses are not considered sequentially.  All manner of constant
expressions are acceptable in case, including numbers, strings,
symbols, keywords, and (Clojure) composites thereof. Note that since
lists are used to group multiple constants that map to the same
expression, a vector can be used to match a list if needed. The
test-constants need not be all of the same type.
sourceraw docstring

cast

(cast c x)

Throws a ClassCastException if x is not a c, else returns x.

Throws a ClassCastException if x is not a c, else returns x.
sourceraw docstring

cat

(cat rf)

A transducer which concatenates the contents of each input, which must be a collection, into the reduction.

A transducer which concatenates the contents of each input, which must be a
collection, into the reduction.
sourceraw docstring

char

(char x)

Coerce to char

Coerce to char
sourceraw docstring

char-array

(char-array size-or-seq)
(char-array size init-val-or-seq)

Creates an array of chars

Creates an array of chars
sourceraw docstring

char-escape-string

Returns escape string for char or nil if none

Returns escape string for char or nil if none
sourceraw docstring

char-name-string

Returns name string for char or nil if none

Returns name string for char or nil if none
sourceraw docstring

char?

(char? x)

Return true if x is a Character

Return true if x is a Character
sourceraw docstring

chars

(chars xs)

Casts to chars[]

Casts to chars[]
sourceraw docstring

chunk

(chunk b)
source

chunk-append

(chunk-append b x)
source

chunk-buffer

(chunk-buffer capacity)
source

chunk-cons

(chunk-cons chunk rest)
source

chunk-first

(chunk-first s)
source

chunk-next

(chunk-next s)
source

chunk-rest

(chunk-rest s)
source

chunked-seq?

(chunked-seq? s)
source

class

(class x)

Returns the Class of x

Returns the Class of x
sourceraw docstring

class?

(class? x)

Returns true if x is an instance of Class

Returns true if x is an instance of Class
sourceraw docstring

clear-agent-errorsdeprecated

(clear-agent-errors a)

DEPRECATED: Use 'restart-agent' instead. Clears any exceptions thrown during asynchronous actions of the agent, allowing subsequent actions to occur.

DEPRECATED: Use 'restart-agent' instead.
Clears any exceptions thrown during asynchronous actions of the
agent, allowing subsequent actions to occur.
sourceraw docstring

clojure-version

(clojure-version)

Returns clojure version as a printable string.

Returns clojure version as a printable string.
sourceraw docstring

coll?

(coll? x)

Returns true if x implements IPersistentCollection

Returns true if x implements IPersistentCollection
sourceraw docstring

commentmacro

(comment & body)

Ignores body, yields nil

Ignores body, yields nil
sourceraw docstring

commute

(commute ref fun & args)

Must be called in a transaction. Sets the in-transaction-value of ref to:

(apply fun in-transaction-value-of-ref args)

and returns the in-transaction-value of ref.

At the commit point of the transaction, sets the value of ref to be:

(apply fun most-recently-committed-value-of-ref args)

Thus fun should be commutative, or, failing that, you must accept last-one-in-wins behavior. commute allows for more concurrency than ref-set.

Must be called in a transaction. Sets the in-transaction-value of
ref to:

(apply fun in-transaction-value-of-ref args)

and returns the in-transaction-value of ref.

At the commit point of the transaction, sets the value of ref to be:

(apply fun most-recently-committed-value-of-ref args)

Thus fun should be commutative, or, failing that, you must accept
last-one-in-wins behavior.  commute allows for more concurrency than
ref-set.
sourceraw docstring

comp

(comp)
(comp f)
(comp f g)
(comp f g & fs)

Takes a set of functions and returns a fn that is the composition of those fns. The returned fn takes a variable number of args, applies the rightmost of fns to the args, the next fn (right-to-left) to the result, etc.

Takes a set of functions and returns a fn that is the composition
of those fns.  The returned fn takes a variable number of args,
applies the rightmost of fns to the args, the next
fn (right-to-left) to the result, etc.
sourceraw docstring

comparator

(comparator pred)

Returns an implementation of java.util.Comparator based upon pred.

Returns an implementation of java.util.Comparator based upon pred.
sourceraw docstring

compare

(compare x y)

Comparator. Returns a negative number, zero, or a positive number when x is logically 'less than', 'equal to', or 'greater than' y. Same as Java x.compareTo(y) except it also works for nil, and compares numbers and collections in a type-independent manner. x must implement Comparable

Comparator. Returns a negative number, zero, or a positive number
when x is logically 'less than', 'equal to', or 'greater than'
y. Same as Java x.compareTo(y) except it also works for nil, and
compares numbers and collections in a type-independent manner. x
must implement Comparable
sourceraw docstring

compare-and-set!

(compare-and-set! atom oldval newval)

Atomically sets the value of atom to newval if and only if the current value of the atom is identical to oldval. Returns true if set happened, else false

Atomically sets the value of atom to newval if and only if the
current value of the atom is identical to oldval. Returns true if
set happened, else false
sourceraw docstring

compile

(compile lib)

Compiles the namespace named by the symbol lib into a set of classfiles. The source for the lib must be in a proper classpath-relative directory. The output files will go into the directory specified by compile-path, and that directory too must be in the classpath.

Compiles the namespace named by the symbol lib into a set of
classfiles. The source for the lib must be in a proper
classpath-relative directory. The output files will go into the
directory specified by *compile-path*, and that directory too must
be in the classpath.
sourceraw docstring

complement

(complement f)

Takes a fn f and returns a fn that takes the same arguments as f, has the same effects, if any, and returns the opposite truth value.

Takes a fn f and returns a fn that takes the same arguments as f,
has the same effects, if any, and returns the opposite truth value.
sourceraw docstring

completing

(completing f)
(completing f cf)

Takes a reducing function f of 2 args and returns a fn suitable for transduce by adding an arity-1 signature that calls cf (default - identity) on the result argument.

Takes a reducing function f of 2 args and returns a fn suitable for
transduce by adding an arity-1 signature that calls cf (default -
identity) on the result argument.
sourceraw docstring

concat

(concat)
(concat x)
(concat x y)
(concat x y & zs)

Returns a lazy seq representing the concatenation of the elements in the supplied colls.

Returns a lazy seq representing the concatenation of the elements in the supplied colls.
sourceraw docstring

condmacro

(cond & clauses)

Takes a set of test/expr pairs. It evaluates each test one at a time. If a test returns logical true, cond evaluates and returns the value of the corresponding expr and doesn't evaluate any of the other tests or exprs. (cond) returns nil.

Takes a set of test/expr pairs. It evaluates each test one at a
time.  If a test returns logical true, cond evaluates and returns
the value of the corresponding expr and doesn't evaluate any of the
other tests or exprs. (cond) returns nil.
sourceraw docstring

cond->macro

(cond-> expr & clauses)

Takes an expression and a set of test/form pairs. Threads expr (via ->) through each form for which the corresponding test expression is true. Note that, unlike cond branching, cond-> threading does not short circuit after the first true test expression.

Takes an expression and a set of test/form pairs. Threads expr (via ->)
through each form for which the corresponding test
expression is true. Note that, unlike cond branching, cond-> threading does
not short circuit after the first true test expression.
sourceraw docstring

cond->>macro

(cond->> expr & clauses)

Takes an expression and a set of test/form pairs. Threads expr (via ->>) through each form for which the corresponding test expression is true. Note that, unlike cond branching, cond->> threading does not short circuit after the first true test expression.

Takes an expression and a set of test/form pairs. Threads expr (via ->>)
through each form for which the corresponding test expression
is true.  Note that, unlike cond branching, cond->> threading does not short circuit
after the first true test expression.
sourceraw docstring

condpmacro

(condp pred expr & clauses)

Takes a binary predicate, an expression, and a set of clauses. Each clause can take the form of either:

test-expr result-expr

test-expr :>> result-fn

Note :>> is an ordinary keyword.

For each clause, (pred test-expr expr) is evaluated. If it returns logical true, the clause is a match. If a binary clause matches, the result-expr is returned, if a ternary clause matches, its result-fn, which must be a unary function, is called with the result of the predicate as its argument, the result of that call being the return value of condp. A single default expression can follow the clauses, and its value will be returned if no clause matches. If no default expression is provided and no clause matches, an IllegalArgumentException is thrown.

Takes a binary predicate, an expression, and a set of clauses.
Each clause can take the form of either:

test-expr result-expr

test-expr :>> result-fn

Note :>> is an ordinary keyword.

For each clause, (pred test-expr expr) is evaluated. If it returns
logical true, the clause is a match. If a binary clause matches, the
result-expr is returned, if a ternary clause matches, its result-fn,
which must be a unary function, is called with the result of the
predicate as its argument, the result of that call being the return
value of condp. A single default expression can follow the clauses,
and its value will be returned if no clause matches. If no default
expression is provided and no clause matches, an
IllegalArgumentException is thrown.
sourceraw docstring

conj

(conj coll x)
(conj coll x & xs)

conj[oin]. Returns a new collection with the xs 'added'. (conj nil item) returns (item). The 'addition' may happen at different 'places' depending on the concrete type.

conj[oin]. Returns a new collection with the xs
'added'. (conj nil item) returns (item).  The 'addition' may
happen at different 'places' depending on the concrete type.
sourceraw docstring

conj!

(conj!)
(conj! coll)
(conj! coll x)

Adds x to the transient collection, and return coll. The 'addition' may happen at different 'places' depending on the concrete type.

Adds x to the transient collection, and return coll. The 'addition'
may happen at different 'places' depending on the concrete type.
sourceraw docstring

cons

(cons x seq)

Returns a new seq where x is the first element and seq is the rest.

Returns a new seq where x is the first element and seq is
the rest.
sourceraw docstring

constantly

(constantly x)

Returns a function that takes any number of arguments and returns x.

Returns a function that takes any number of arguments and returns x.
sourceraw docstring

construct-proxy

(construct-proxy c & ctor-args)

Takes a proxy class and any arguments for its superclass ctor and creates and returns an instance of the proxy.

Takes a proxy class and any arguments for its superclass ctor and
creates and returns an instance of the proxy.
sourceraw docstring

contains?

(contains? coll key)

Returns true if key is present in the given collection, otherwise returns false. Note that for numerically indexed collections like vectors and Java arrays, this tests if the numeric key is within the range of indexes. 'contains?' operates constant or logarithmic time; it will not perform a linear search for a value. See also 'some'.

Returns true if key is present in the given collection, otherwise
returns false.  Note that for numerically indexed collections like
vectors and Java arrays, this tests if the numeric key is within the
range of indexes. 'contains?' operates constant or logarithmic time;
it will not perform a linear search for a value.  See also 'some'.
sourceraw docstring

count

(count coll)

Returns the number of items in the collection. (count nil) returns 0. Also works on strings, arrays, and Java Collections and Maps

Returns the number of items in the collection. (count nil) returns
0.  Also works on strings, arrays, and Java Collections and Maps
sourceraw docstring

counted?

(counted? coll)

Returns true if coll implements count in constant time

Returns true if coll implements count in constant time
sourceraw docstring

create-ns

(create-ns sym)

Create a new namespace named by the symbol if one doesn't already exist, returns it or the already-existing namespace of the same name.

Create a new namespace named by the symbol if one doesn't already
exist, returns it or the already-existing namespace of the same
name.
sourceraw docstring

create-struct

(create-struct & keys)

Returns a structure basis object.

Returns a structure basis object.
sourceraw docstring

cycle

(cycle coll)

Returns a lazy (infinite!) sequence of repetitions of the items in coll.

Returns a lazy (infinite!) sequence of repetitions of the items in coll.
sourceraw docstring

dec

(dec x)

Returns a number one less than num. Does not auto-promote longs, will throw on overflow. See also: dec'

Returns a number one less than num. Does not auto-promote
longs, will throw on overflow. See also: dec'
sourceraw docstring

dec'

(dec' x)

Returns a number one less than num. Supports arbitrary precision. See also: dec

Returns a number one less than num. Supports arbitrary precision.
See also: dec
sourceraw docstring

decimal?

(decimal? n)

Returns true if n is a BigDecimal

Returns true if n is a BigDecimal
sourceraw docstring

declaremacro

(declare & names)

defs the supplied var names with no bindings, useful for making forward declarations.

defs the supplied var names with no bindings, useful for making forward declarations.
sourceraw docstring

dedupe

(dedupe)
(dedupe coll)

Returns a lazy sequence removing consecutive duplicates in coll. Returns a transducer when no collection is provided.

Returns a lazy sequence removing consecutive duplicates in coll.
Returns a transducer when no collection is provided.
sourceraw docstring

default-data-readers

Default map of data reader functions provided by Clojure. May be overridden by binding data-readers.

Default map of data reader functions provided by Clojure. May be
overridden by binding *data-readers*.
sourceraw docstring

definlinemacro

(definline name & decl)

Experimental - like defmacro, except defines a named function whose body is the expansion, calls to which may be expanded inline as if it were a macro. Cannot be used with variadic (&) args.

Experimental - like defmacro, except defines a named function whose
body is the expansion, calls to which may be expanded inline as if
it were a macro. Cannot be used with variadic (&) args.
sourceraw docstring

definterfacemacro

(definterface name & sigs)

Creates a new Java interface with the given name and method sigs. The method return types and parameter types may be specified with type hints, defaulting to Object if omitted.

(definterface MyInterface (^int method1 [x]) (^Bar method2 [^Baz b ^Quux q]))

Creates a new Java interface with the given name and method sigs.
The method return types and parameter types may be specified with type hints,
defaulting to Object if omitted.

(definterface MyInterface
  (^int method1 [x])
  (^Bar method2 [^Baz b ^Quux q]))
sourceraw docstring

defmacromacro

(defmacro name doc-string? attr-map? [params*] body)
(defmacro name doc-string? attr-map? ([params*] body) + attr-map?)

Like defn, but the resulting function name is declared as a macro and will be used as a macro by the compiler when it is called.

Like defn, but the resulting function name is declared as a
macro and will be used as a macro by the compiler when it is
called.
sourceraw docstring

defmethodmacro

(defmethod multifn dispatch-val & fn-tail)

Creates and installs a new method of multimethod associated with dispatch-value.

Creates and installs a new method of multimethod associated with dispatch-value. 
sourceraw docstring

defmultimacro

(defmulti name docstring? attr-map? dispatch-fn & options)

Creates a new multimethod with the associated dispatch function. The docstring and attr-map are optional.

Options are key-value pairs and may be one of:

:default

The default dispatch value, defaults to :default

:hierarchy

The value used for hierarchical dispatch (e.g. ::square is-a ::shape)

Hierarchies are type-like relationships that do not depend upon type inheritance. By default Clojure's multimethods dispatch off of a global hierarchy map. However, a hierarchy relationship can be created with the derive function used to augment the root ancestor created with make-hierarchy.

Multimethods expect the value of the hierarchy option to be supplied as a reference type e.g. a var (i.e. via the Var-quote dispatch macro #' or the var special form).

Creates a new multimethod with the associated dispatch function.
The docstring and attr-map are optional.

Options are key-value pairs and may be one of:

:default

The default dispatch value, defaults to :default

:hierarchy

The value used for hierarchical dispatch (e.g. ::square is-a ::shape)

Hierarchies are type-like relationships that do not depend upon type
inheritance. By default Clojure's multimethods dispatch off of a
global hierarchy map.  However, a hierarchy relationship can be
created with the derive function used to augment the root ancestor
created with make-hierarchy.

Multimethods expect the value of the hierarchy option to be supplied as
a reference type e.g. a var (i.e. via the Var-quote dispatch macro #'
or the var special form).
sourceraw docstring

defnmacro

(defn name doc-string? attr-map? [params*] prepost-map? body)
(defn name
  doc-string?
  attr-map?
  ([params*] prepost-map? body)
  +
  attr-map?)

Same as (def name (fn [params* ] exprs*)) or (def name (fn ([params* ] exprs*)+)) with any doc-string or attrs added to the var metadata. prepost-map defines a map with optional keys :pre and :post that contain collections of pre or post conditions.

Same as (def name (fn [params* ] exprs*)) or (def
name (fn ([params* ] exprs*)+)) with any doc-string or attrs added
to the var metadata. prepost-map defines a map with optional keys
:pre and :post that contain collections of pre or post conditions.
sourceraw docstring

defn-macro

(defn- name & decls)

same as defn, yielding non-public def

same as defn, yielding non-public def
sourceraw docstring

defoncemacro

(defonce name expr)

defs name to have the root value of the expr iff the named var has no root value, else expr is unevaluated

defs name to have the root value of the expr iff the named var has no root value,
else expr is unevaluated
sourceraw docstring

defprotocolmacro

(defprotocol name
  &
  opts+sigs)

A protocol is a named set of named methods and their signatures: (defprotocol AProtocolName

;optional doc string "A doc string for AProtocol abstraction"

;method signatures (bar [this a b] "bar docs") (baz [this a] [this a b] [this a b c] "baz docs"))

No implementations are provided. Docs can be specified for the protocol overall and for each method. The above yields a set of polymorphic functions and a protocol object. All are namespace-qualified by the ns enclosing the definition The resulting functions dispatch on the type of their first argument, which is required and corresponds to the implicit target object ('this' in Java parlance). defprotocol is dynamic, has no special compile-time effect, and defines no new types or classes. Implementations of the protocol methods can be provided using extend.

defprotocol will automatically generate a corresponding interface, with the same name as the protocol, i.e. given a protocol: my.ns/Protocol, an interface: my.ns.Protocol. The interface will have methods corresponding to the protocol functions, and the protocol will automatically work with instances of the interface.

Note that you should not use this interface with deftype or reify, as they support the protocol directly:

(defprotocol P (foo [this]) (bar-me [this] [this y]))

(deftype Foo [a b c] P (foo [this] a) (bar-me [this] b) (bar-me [this y] (+ c y)))

(bar-me (Foo. 1 2 3) 42) => 45

(foo (let [x 42] (reify P (foo [this] 17) (bar-me [this] x) (bar-me [this y] x)))) => 17

A protocol is a named set of named methods and their signatures:
(defprotocol AProtocolName

  ;optional doc string
  "A doc string for AProtocol abstraction"

;method signatures
  (bar [this a b] "bar docs")
  (baz [this a] [this a b] [this a b c] "baz docs"))

No implementations are provided. Docs can be specified for the
protocol overall and for each method. The above yields a set of
polymorphic functions and a protocol object. All are
namespace-qualified by the ns enclosing the definition The resulting
functions dispatch on the type of their first argument, which is
required and corresponds to the implicit target object ('this' in 
Java parlance). defprotocol is dynamic, has no special compile-time 
effect, and defines no new types or classes. Implementations of 
the protocol methods can be provided using extend.

defprotocol will automatically generate a corresponding interface,
with the same name as the protocol, i.e. given a protocol:
my.ns/Protocol, an interface: my.ns.Protocol. The interface will
have methods corresponding to the protocol functions, and the
protocol will automatically work with instances of the interface.

Note that you should not use this interface with deftype or
reify, as they support the protocol directly:

(defprotocol P 
  (foo [this]) 
  (bar-me [this] [this y]))

(deftype Foo [a b c] 
 P
  (foo [this] a)
  (bar-me [this] b)
  (bar-me [this y] (+ c y)))

(bar-me (Foo. 1 2 3) 42)
=> 45

(foo 
  (let [x 42]
    (reify P 
      (foo [this] 17)
      (bar-me [this] x)
      (bar-me [this y] x))))
=> 17
sourceraw docstring

defrecordmacro

(defrecord name [& fields]
  &
    opts+specs)

(defrecord name [fields*] options* specs*)

Options are expressed as sequential keywords and arguments (in any order).

Supported options: :load-ns - if true, importing the record class will cause the namespace in which the record was defined to be loaded. Defaults to false.

Each spec consists of a protocol or interface name followed by zero or more method bodies:

protocol-or-interface-or-Object (methodName [args*] body)*

Dynamically generates compiled bytecode for class with the given name, in a package with the same name as the current namespace, the given fields, and, optionally, methods for protocols and/or interfaces.

The class will have the (immutable) fields named by fields, which can have type hints. Protocols/interfaces and methods are optional. The only methods that can be supplied are those declared in the protocols/interfaces. Note that method bodies are not closures, the local environment includes only the named fields, and those fields can be accessed directly.

Method definitions take the form:

(methodname [args*] body)

The argument and return types can be hinted on the arg and methodname symbols. If not supplied, they will be inferred, so type hints should be reserved for disambiguation.

Methods should be supplied for all methods of the desired protocol(s) and interface(s). You can also define overrides for methods of Object. Note that a parameter must be supplied to correspond to the target object ('this' in Java parlance). Thus methods for interfaces will take one more argument than do the interface declarations. Note also that recur calls to the method head should not pass the target object, it will be supplied automatically and can not be substituted.

In the method bodies, the (unqualified) name can be used to name the class (for calls to new, instance? etc).

The class will have implementations of several (clojure.lang) interfaces generated automatically: IObj (metadata support) and IPersistentMap, and all of their superinterfaces.

In addition, defrecord will define type-and-value-based =, and will defined Java .hashCode and .equals consistent with the contract for java.util.Map.

When AOT compiling, generates compiled bytecode for a class with the given name (a symbol), prepends the current ns as the package, and writes the .class file to the compile-path directory.

Two constructors will be defined, one taking the designated fields followed by a metadata map (nil for none) and an extension field map (nil for none), and one taking only the fields (using nil for meta and extension fields). Note that the field names __meta, __extmap, __hash and __hasheq are currently reserved and should not be used when defining your own records.

Given (defrecord TypeName ...), two factory functions will be defined: ->TypeName, taking positional parameters for the fields, and map->TypeName, taking a map of keywords to field values.

(defrecord name [fields*]  options* specs*)

Options are expressed as sequential keywords and arguments (in any order).

Supported options:
:load-ns - if true, importing the record class will cause the
           namespace in which the record was defined to be loaded.
           Defaults to false.

Each spec consists of a protocol or interface name followed by zero
or more method bodies:

protocol-or-interface-or-Object
(methodName [args*] body)*

Dynamically generates compiled bytecode for class with the given
name, in a package with the same name as the current namespace, the
given fields, and, optionally, methods for protocols and/or
interfaces.

The class will have the (immutable) fields named by
fields, which can have type hints. Protocols/interfaces and methods
are optional. The only methods that can be supplied are those
declared in the protocols/interfaces.  Note that method bodies are
not closures, the local environment includes only the named fields,
and those fields can be accessed directly.

Method definitions take the form:

(methodname [args*] body)

The argument and return types can be hinted on the arg and
methodname symbols. If not supplied, they will be inferred, so type
hints should be reserved for disambiguation.

Methods should be supplied for all methods of the desired
protocol(s) and interface(s). You can also define overrides for
methods of Object. Note that a parameter must be supplied to
correspond to the target object ('this' in Java parlance). Thus
methods for interfaces will take one more argument than do the
interface declarations. Note also that recur calls to the method
head should *not* pass the target object, it will be supplied
automatically and can not be substituted.

In the method bodies, the (unqualified) name can be used to name the
class (for calls to new, instance? etc).

The class will have implementations of several (clojure.lang)
interfaces generated automatically: IObj (metadata support) and
IPersistentMap, and all of their superinterfaces.

In addition, defrecord will define type-and-value-based =,
and will defined Java .hashCode and .equals consistent with the
contract for java.util.Map.

When AOT compiling, generates compiled bytecode for a class with the
given name (a symbol), prepends the current ns as the package, and
writes the .class file to the *compile-path* directory.

Two constructors will be defined, one taking the designated fields
followed by a metadata map (nil for none) and an extension field
map (nil for none), and one taking only the fields (using nil for
meta and extension fields). Note that the field names __meta,
__extmap, __hash and __hasheq are currently reserved and should not
be used when defining your own records.

Given (defrecord TypeName ...), two factory functions will be
defined: ->TypeName, taking positional parameters for the fields,
and map->TypeName, taking a map of keywords to field values.
sourceraw docstring

defstructmacro

(defstruct name & keys)

Same as (def name (create-struct keys...))

Same as (def name (create-struct keys...))
sourceraw docstring

deftypemacro

(deftype name [& fields]
  &
    opts+specs)

(deftype name [fields*] options* specs*)

Options are expressed as sequential keywords and arguments (in any order).

Supported options: :load-ns - if true, importing the type class will cause the namespace in which the type was defined to be loaded. Defaults to false.

Each spec consists of a protocol or interface name followed by zero or more method bodies:

protocol-or-interface-or-Object (methodName [args*] body)*

Dynamically generates compiled bytecode for class with the given name, in a package with the same name as the current namespace, the given fields, and, optionally, methods for protocols and/or interfaces.

The class will have the (by default, immutable) fields named by fields, which can have type hints. Protocols/interfaces and methods are optional. The only methods that can be supplied are those declared in the protocols/interfaces. Note that method bodies are not closures, the local environment includes only the named fields, and those fields can be accessed directly. Fields can be qualified with the metadata :volatile-mutable true or :unsynchronized-mutable true, at which point (set! afield aval) will be supported in method bodies. Note well that mutable fields are extremely difficult to use correctly, and are present only to facilitate the building of higher level constructs, such as Clojure's reference types, in Clojure itself. They are for experts only - if the semantics and implications of :volatile-mutable or :unsynchronized-mutable are not immediately apparent to you, you should not be using them.

Method definitions take the form:

(methodname [args*] body)

The argument and return types can be hinted on the arg and methodname symbols. If not supplied, they will be inferred, so type hints should be reserved for disambiguation.

Methods should be supplied for all methods of the desired protocol(s) and interface(s). You can also define overrides for methods of Object. Note that a parameter must be supplied to correspond to the target object ('this' in Java parlance). Thus methods for interfaces will take one more argument than do the interface declarations. Note also that recur calls to the method head should not pass the target object, it will be supplied automatically and can not be substituted.

In the method bodies, the (unqualified) name can be used to name the class (for calls to new, instance? etc).

When AOT compiling, generates compiled bytecode for a class with the given name (a symbol), prepends the current ns as the package, and writes the .class file to the compile-path directory.

One constructor will be defined, taking the designated fields. Note that the field names __meta, __extmap, __hash and __hasheq are currently reserved and should not be used when defining your own types.

Given (deftype TypeName ...), a factory function called ->TypeName will be defined, taking positional parameters for the fields

(deftype name [fields*]  options* specs*)

Options are expressed as sequential keywords and arguments (in any order).

Supported options:
:load-ns - if true, importing the type class will cause the
           namespace in which the type was defined to be loaded.
           Defaults to false.

Each spec consists of a protocol or interface name followed by zero
or more method bodies:

protocol-or-interface-or-Object
(methodName [args*] body)*

Dynamically generates compiled bytecode for class with the given
name, in a package with the same name as the current namespace, the
given fields, and, optionally, methods for protocols and/or
interfaces. 

The class will have the (by default, immutable) fields named by
fields, which can have type hints. Protocols/interfaces and methods
are optional. The only methods that can be supplied are those
declared in the protocols/interfaces.  Note that method bodies are
not closures, the local environment includes only the named fields,
and those fields can be accessed directly. Fields can be qualified
with the metadata :volatile-mutable true or :unsynchronized-mutable
true, at which point (set! afield aval) will be supported in method
bodies. Note well that mutable fields are extremely difficult to use
correctly, and are present only to facilitate the building of higher
level constructs, such as Clojure's reference types, in Clojure
itself. They are for experts only - if the semantics and
implications of :volatile-mutable or :unsynchronized-mutable are not
immediately apparent to you, you should not be using them.

Method definitions take the form:

(methodname [args*] body)

The argument and return types can be hinted on the arg and
methodname symbols. If not supplied, they will be inferred, so type
hints should be reserved for disambiguation.

Methods should be supplied for all methods of the desired
protocol(s) and interface(s). You can also define overrides for
methods of Object. Note that a parameter must be supplied to
correspond to the target object ('this' in Java parlance). Thus
methods for interfaces will take one more argument than do the
interface declarations. Note also that recur calls to the method
head should *not* pass the target object, it will be supplied
automatically and can not be substituted.

In the method bodies, the (unqualified) name can be used to name the
class (for calls to new, instance? etc).

When AOT compiling, generates compiled bytecode for a class with the
given name (a symbol), prepends the current ns as the package, and
writes the .class file to the *compile-path* directory.

One constructor will be defined, taking the designated fields.  Note
that the field names __meta, __extmap, __hash and __hasheq are currently
reserved and should not be used when defining your own types.

Given (deftype TypeName ...), a factory function called ->TypeName
will be defined, taking positional parameters for the fields
sourceraw docstring

delaymacro

(delay & body)

Takes a body of expressions and yields a Delay object that will invoke the body only the first time it is forced (with force or deref/@), and will cache the result and return it on all subsequent force calls. See also - realized?

Takes a body of expressions and yields a Delay object that will
invoke the body only the first time it is forced (with force or deref/@), and
will cache the result and return it on all subsequent force
calls. See also - realized?
sourceraw docstring

delay?

(delay? x)

returns true if x is a Delay created with delay

returns true if x is a Delay created with delay
sourceraw docstring

deliver

(deliver promise val)

Delivers the supplied value to the promise, releasing any pending derefs. A subsequent call to deliver on a promise will have no effect.

Delivers the supplied value to the promise, releasing any pending
derefs. A subsequent call to deliver on a promise will have no effect.
sourceraw docstring

denominator

(denominator r)

Returns the denominator part of a Ratio.

Returns the denominator part of a Ratio.
sourceraw docstring

deref

(deref ref)
(deref ref timeout-ms timeout-val)

Also reader macro: @ref/@agent/@var/@atom/@delay/@future/@promise. Within a transaction, returns the in-transaction-value of ref, else returns the most-recently-committed value of ref. When applied to a var, agent or atom, returns its current state. When applied to a delay, forces it if not already forced. When applied to a future, will block if computation not complete. When applied to a promise, will block until a value is delivered. The variant taking a timeout can be used for blocking references (futures and promises), and will return timeout-val if the timeout (in milliseconds) is reached before a value is available. See also - realized?.

Also reader macro: @ref/@agent/@var/@atom/@delay/@future/@promise. Within a transaction,
returns the in-transaction-value of ref, else returns the
most-recently-committed value of ref. When applied to a var, agent
or atom, returns its current state. When applied to a delay, forces
it if not already forced. When applied to a future, will block if
computation not complete. When applied to a promise, will block
until a value is delivered.  The variant taking a timeout can be
used for blocking references (futures and promises), and will return
timeout-val if the timeout (in milliseconds) is reached before a
value is available. See also - realized?.
sourceraw docstring

derive

(derive tag parent)
(derive h tag parent)

Establishes a parent/child relationship between parent and tag. Parent must be a namespace-qualified symbol or keyword and child can be either a namespace-qualified symbol or keyword or a class. h must be a hierarchy obtained from make-hierarchy, if not supplied defaults to, and modifies, the global hierarchy.

Establishes a parent/child relationship between parent and
tag. Parent must be a namespace-qualified symbol or keyword and
child can be either a namespace-qualified symbol or keyword or a
class. h must be a hierarchy obtained from make-hierarchy, if not
supplied defaults to, and modifies, the global hierarchy.
sourceraw docstring

descendants

(descendants tag)
(descendants h tag)

Returns the immediate and indirect children of tag, through a relationship established via derive. h must be a hierarchy obtained from make-hierarchy, if not supplied defaults to the global hierarchy. Note: does not work on Java type inheritance relationships.

Returns the immediate and indirect children of tag, through a
relationship established via derive. h must be a hierarchy obtained
from make-hierarchy, if not supplied defaults to the global
hierarchy. Note: does not work on Java type inheritance
relationships.
sourceraw docstring

destructure

(destructure bindings)
source

disj

(disj set)
(disj set key)
(disj set key & ks)

disj[oin]. Returns a new set of the same (hashed/sorted) type, that does not contain key(s).

disj[oin]. Returns a new set of the same (hashed/sorted) type, that
does not contain key(s).
sourceraw docstring

disj!

(disj! set)
(disj! set key)
(disj! set key & ks)

disj[oin]. Returns a transient set of the same (hashed/sorted) type, that does not contain key(s).

disj[oin]. Returns a transient set of the same (hashed/sorted) type, that
does not contain key(s).
sourceraw docstring

dissoc

(dissoc map)
(dissoc map key)
(dissoc map key & ks)

dissoc[iate]. Returns a new map of the same (hashed/sorted) type, that does not contain a mapping for key(s).

dissoc[iate]. Returns a new map of the same (hashed/sorted) type,
that does not contain a mapping for key(s).
sourceraw docstring

dissoc!

(dissoc! map key)
(dissoc! map key & ks)

Returns a transient map that doesn't contain a mapping for key(s).

Returns a transient map that doesn't contain a mapping for key(s).
sourceraw docstring

distinct

(distinct)
(distinct coll)

Returns a lazy sequence of the elements of coll with duplicates removed. Returns a stateful transducer when no collection is provided.

Returns a lazy sequence of the elements of coll with duplicates removed.
Returns a stateful transducer when no collection is provided.
sourceraw docstring

distinct?

(distinct? x)
(distinct? x y)
(distinct? x y & more)

Returns true if no two of the arguments are =

Returns true if no two of the arguments are =
sourceraw docstring

doall

(doall coll)
(doall n coll)

When lazy sequences are produced via functions that have side effects, any effects other than those needed to produce the first element in the seq do not occur until the seq is consumed. doall can be used to force any effects. Walks through the successive nexts of the seq, retains the head and returns it, thus causing the entire seq to reside in memory at one time.

When lazy sequences are produced via functions that have side
effects, any effects other than those needed to produce the first
element in the seq do not occur until the seq is consumed. doall can
be used to force any effects. Walks through the successive nexts of
the seq, retains the head and returns it, thus causing the entire
seq to reside in memory at one time.
sourceraw docstring

dorun

(dorun coll)
(dorun n coll)

When lazy sequences are produced via functions that have side effects, any effects other than those needed to produce the first element in the seq do not occur until the seq is consumed. dorun can be used to force any effects. Walks through the successive nexts of the seq, does not retain the head and returns nil.

When lazy sequences are produced via functions that have side
effects, any effects other than those needed to produce the first
element in the seq do not occur until the seq is consumed. dorun can
be used to force any effects. Walks through the successive nexts of
the seq, does not retain the head and returns nil.
sourceraw docstring

doseqmacro

(doseq seq-exprs
       &
       body)

Repeatedly executes body (presumably for side-effects) with bindings and filtering as provided by "for". Does not retain the head of the sequence. Returns nil.

Repeatedly executes body (presumably for side-effects) with
bindings and filtering as provided by "for".  Does not retain
the head of the sequence. Returns nil.
sourceraw docstring

dosyncmacro

(dosync & exprs)

Runs the exprs (in an implicit do) in a transaction that encompasses exprs and any nested calls. Starts a transaction if none is already running on this thread. Any uncaught exception will abort the transaction and flow out of dosync. The exprs may be run more than once, but any effects on Refs will be atomic.

Runs the exprs (in an implicit do) in a transaction that encompasses
exprs and any nested calls.  Starts a transaction if none is already
running on this thread. Any uncaught exception will abort the
transaction and flow out of dosync. The exprs may be run more than
once, but any effects on Refs will be atomic.
sourceraw docstring

dotimesmacro

(dotimes bindings
         &
         body)

bindings => name n

Repeatedly executes body (presumably for side-effects) with name bound to integers from 0 through n-1.

bindings => name n

Repeatedly executes body (presumably for side-effects) with name
bound to integers from 0 through n-1.
sourceraw docstring

dotomacro

(doto x & forms)

Evaluates x then calls all of the methods and functions with the value of x supplied at the front of the given arguments. The forms are evaluated in order. Returns x.

(doto (new java.util.HashMap) (.put "a" 1) (.put "b" 2))

Evaluates x then calls all of the methods and functions with the
value of x supplied at the front of the given arguments.  The forms
are evaluated in order.  Returns x.

(doto (new java.util.HashMap) (.put "a" 1) (.put "b" 2))
sourceraw docstring

double

(double x)

Coerce to double

Coerce to double
sourceraw docstring

double-array

(double-array size-or-seq)
(double-array size init-val-or-seq)

Creates an array of doubles

Creates an array of doubles
sourceraw docstring

double?

(double? x)

Return true if x is a Double

Return true if x is a Double
sourceraw docstring

doubles

(doubles xs)

Casts to double[]

Casts to double[]
sourceraw docstring

drop

(drop n)
(drop n coll)

Returns a lazy sequence of all but the first n items in coll. Returns a stateful transducer when no collection is provided.

Returns a lazy sequence of all but the first n items in coll.
Returns a stateful transducer when no collection is provided.
sourceraw docstring

drop-last

(drop-last coll)
(drop-last n coll)

Return a lazy sequence of all but the last n (default 1) items in coll

Return a lazy sequence of all but the last n (default 1) items in coll
sourceraw docstring

drop-while

(drop-while pred)
(drop-while pred coll)

Returns a lazy sequence of the items in coll starting from the first item for which (pred item) returns logical false. Returns a stateful transducer when no collection is provided.

Returns a lazy sequence of the items in coll starting from the
first item for which (pred item) returns logical false.  Returns a
stateful transducer when no collection is provided.
sourceraw docstring

eduction

(eduction xform* coll)

Returns a reducible/iterable application of the transducers to the items in coll. Transducers are applied in order as if combined with comp. Note that these applications will be performed every time reduce/iterator is called.

Returns a reducible/iterable application of the transducers
to the items in coll. Transducers are applied in order as if
combined with comp. Note that these applications will be
performed every time reduce/iterator is called.
sourceraw docstring

empty

(empty coll)

Returns an empty collection of the same category as coll, or nil

Returns an empty collection of the same category as coll, or nil
sourceraw docstring

EMPTY-NODE

source

empty?

(empty? coll)

Returns true if coll has no items - same as (not (seq coll)). Please use the idiom (seq x) rather than (not (empty? x))

Returns true if coll has no items - same as (not (seq coll)).
Please use the idiom (seq x) rather than (not (empty? x))
sourceraw docstring

ensure

(ensure ref)

Must be called in a transaction. Protects the ref from modification by other transactions. Returns the in-transaction-value of ref. Allows for more concurrency than (ref-set ref @ref)

Must be called in a transaction. Protects the ref from modification
by other transactions.  Returns the in-transaction-value of
ref. Allows for more concurrency than (ref-set ref @ref)
sourceraw docstring

ensure-reduced

(ensure-reduced x)

If x is already reduced?, returns it, else returns (reduced x)

If x is already reduced?, returns it, else returns (reduced x)
sourceraw docstring

enumeration-seq

(enumeration-seq e)

Returns a seq on a java.util.Enumeration

Returns a seq on a java.util.Enumeration
sourceraw docstring

error-handler

(error-handler a)

Returns the error-handler of agent a, or nil if there is none. See set-error-handler!

Returns the error-handler of agent a, or nil if there is none.
See set-error-handler!
sourceraw docstring

error-mode

(error-mode a)

Returns the error-mode of agent a. See set-error-mode!

Returns the error-mode of agent a.  See set-error-mode!
sourceraw docstring

eval

(eval form)

Evaluates the form data structure (not text!) and returns the result.

Evaluates the form data structure (not text!) and returns the result.
sourceraw docstring

even?

(even? n)

Returns true if n is even, throws an exception if n is not an integer

Returns true if n is even, throws an exception if n is not an integer
sourceraw docstring

every-pred

(every-pred p)
(every-pred p1 p2)
(every-pred p1 p2 p3)
(every-pred p1 p2 p3 & ps)

Takes a set of predicates and returns a function f that returns true if all of its composing predicates return a logical true value against all of its arguments, else it returns false. Note that f is short-circuiting in that it will stop execution on the first argument that triggers a logical false result against the original predicates.

Takes a set of predicates and returns a function f that returns true if all of its
composing predicates return a logical true value against all of its arguments, else it returns
false. Note that f is short-circuiting in that it will stop execution on the first
argument that triggers a logical false result against the original predicates.
sourceraw docstring

every?

(every? pred coll)

Returns true if (pred x) is logical true for every x in coll, else false.

Returns true if (pred x) is logical true for every x in coll, else
false.
sourceraw docstring

ex-cause

(ex-cause ex)

Returns the cause of ex if ex is a Throwable. Otherwise returns nil.

Returns the cause of ex if ex is a Throwable.
Otherwise returns nil.
sourceraw docstring

ex-data

(ex-data ex)

Returns exception data (a map) if ex is an IExceptionInfo. Otherwise returns nil.

Returns exception data (a map) if ex is an IExceptionInfo.
Otherwise returns nil.
sourceraw docstring

ex-info

(ex-info msg map)
(ex-info msg map cause)

Create an instance of ExceptionInfo, a RuntimeException subclass that carries a map of additional data.

Create an instance of ExceptionInfo, a RuntimeException subclass
that carries a map of additional data.
sourceraw docstring

ex-message

(ex-message ex)

Returns the message attached to ex if ex is a Throwable. Otherwise returns nil.

Returns the message attached to ex if ex is a Throwable.
Otherwise returns nil.
sourceraw docstring

extend

(extend atype
  &
    proto+mmaps)

Implementations of protocol methods can be provided using the extend construct:

(extend AType AProtocol {:foo an-existing-fn :bar (fn [a b] ...) :baz (fn ([a]...) ([a b] ...)...)} BProtocol {...} ...)

extend takes a type/class (or interface, see below), and one or more protocol + method map pairs. It will extend the polymorphism of the protocol's methods to call the supplied methods when an AType is provided as the first argument.

Method maps are maps of the keyword-ized method names to ordinary fns. This facilitates easy reuse of existing fns and fn maps, for code reuse/mixins without derivation or composition. You can extend an interface to a protocol. This is primarily to facilitate interop with the host (e.g. Java) but opens the door to incidental multiple inheritance of implementation since a class can inherit from more than one interface, both of which extend the protocol. It is TBD how to specify which impl to use. You can extend a protocol on nil.

If you are supplying the definitions explicitly (i.e. not reusing exsting functions or mixin maps), you may find it more convenient to use the extend-type or extend-protocol macros.

Note that multiple independent extend clauses can exist for the same type, not all protocols need be defined in a single extend call.

See also: extends?, satisfies?, extenders

Implementations of protocol methods can be provided using the extend construct:

(extend AType
  AProtocol
   {:foo an-existing-fn
    :bar (fn [a b] ...)
    :baz (fn ([a]...) ([a b] ...)...)}
  BProtocol 
    {...} 
  ...)

extend takes a type/class (or interface, see below), and one or more
protocol + method map pairs. It will extend the polymorphism of the
protocol's methods to call the supplied methods when an AType is
provided as the first argument. 

Method maps are maps of the keyword-ized method names to ordinary
fns. This facilitates easy reuse of existing fns and fn maps, for
code reuse/mixins without derivation or composition. You can extend
an interface to a protocol. This is primarily to facilitate interop
with the host (e.g. Java) but opens the door to incidental multiple
inheritance of implementation since a class can inherit from more
than one interface, both of which extend the protocol. It is TBD how
to specify which impl to use. You can extend a protocol on nil.

If you are supplying the definitions explicitly (i.e. not reusing
exsting functions or mixin maps), you may find it more convenient to
use the extend-type or extend-protocol macros.

Note that multiple independent extend clauses can exist for the same
type, not all protocols need be defined in a single extend call.

See also:
extends?, satisfies?, extenders
sourceraw docstring

extend-protocolmacro

(extend-protocol p
  &
    specs)

Useful when you want to provide several implementations of the same protocol all at once. Takes a single protocol and the implementation of that protocol for one or more types. Expands into calls to extend-type:

(extend-protocol Protocol AType (foo [x] ...) (bar [x y] ...) BType (foo [x] ...) (bar [x y] ...) AClass (foo [x] ...) (bar [x y] ...) nil (foo [x] ...) (bar [x y] ...))

expands into:

(do (clojure.core/extend-type AType Protocol (foo [x] ...) (bar [x y] ...)) (clojure.core/extend-type BType Protocol (foo [x] ...) (bar [x y] ...)) (clojure.core/extend-type AClass Protocol (foo [x] ...) (bar [x y] ...)) (clojure.core/extend-type nil Protocol (foo [x] ...) (bar [x y] ...)))

Useful when you want to provide several implementations of the same
protocol all at once. Takes a single protocol and the implementation
of that protocol for one or more types. Expands into calls to
extend-type:

(extend-protocol Protocol
  AType
    (foo [x] ...)
    (bar [x y] ...)
  BType
    (foo [x] ...)
    (bar [x y] ...)
  AClass
    (foo [x] ...)
    (bar [x y] ...)
  nil
    (foo [x] ...)
    (bar [x y] ...))

expands into:

(do
 (clojure.core/extend-type AType Protocol 
   (foo [x] ...) 
   (bar [x y] ...))
 (clojure.core/extend-type BType Protocol 
   (foo [x] ...) 
   (bar [x y] ...))
 (clojure.core/extend-type AClass Protocol 
   (foo [x] ...) 
   (bar [x y] ...))
 (clojure.core/extend-type nil Protocol 
   (foo [x] ...) 
   (bar [x y] ...)))
sourceraw docstring

extend-typemacro

(extend-type t
  &
    specs)

A macro that expands into an extend call. Useful when you are supplying the definitions explicitly inline, extend-type automatically creates the maps required by extend. Propagates the class as a type hint on the first argument of all fns.

(extend-type MyType Countable (cnt [c] ...) Foo (bar [x y] ...) (baz ([x] ...) ([x y & zs] ...)))

expands into:

(extend MyType Countable {:cnt (fn [c] ...)} Foo {:baz (fn ([x] ...) ([x y & zs] ...)) :bar (fn [x y] ...)})

A macro that expands into an extend call. Useful when you are
supplying the definitions explicitly inline, extend-type
automatically creates the maps required by extend.  Propagates the
class as a type hint on the first argument of all fns.

(extend-type MyType 
  Countable
    (cnt [c] ...)
  Foo
    (bar [x y] ...)
    (baz ([x] ...) ([x y & zs] ...)))

expands into:

(extend MyType
 Countable
   {:cnt (fn [c] ...)}
 Foo
   {:baz (fn ([x] ...) ([x y & zs] ...))
    :bar (fn [x y] ...)})
sourceraw docstring

extenders

(extenders protocol)

Returns a collection of the types explicitly extending protocol

Returns a collection of the types explicitly extending protocol
sourceraw docstring

extends?

(extends? protocol atype)

Returns true if atype extends protocol

Returns true if atype extends protocol
sourceraw docstring

false?

(false? x)

Returns true if x is the value false, false otherwise.

Returns true if x is the value false, false otherwise.
sourceraw docstring

ffirst

(ffirst x)

Same as (first (first x))

Same as (first (first x))
sourceraw docstring

file-seq

(file-seq dir)

A tree seq on java.io.Files

A tree seq on java.io.Files
sourceraw docstring

filter

(filter pred)
(filter pred coll)

Returns a lazy sequence of the items in coll for which (pred item) returns logical true. pred must be free of side-effects. Returns a transducer when no collection is provided.

Returns a lazy sequence of the items in coll for which
(pred item) returns logical true. pred must be free of side-effects.
Returns a transducer when no collection is provided.
sourceraw docstring

filterv

(filterv pred coll)

Returns a vector of the items in coll for which (pred item) returns logical true. pred must be free of side-effects.

Returns a vector of the items in coll for which
(pred item) returns logical true. pred must be free of side-effects.
sourceraw docstring

find

(find map key)

Returns the map entry for key, or nil if key not present.

Returns the map entry for key, or nil if key not present.
sourceraw docstring

find-keyword

(find-keyword name)
(find-keyword ns name)

Returns a Keyword with the given namespace and name if one already exists. This function will not intern a new keyword. If the keyword has not already been interned, it will return nil. Do not use : in the keyword strings, it will be added automatically.

Returns a Keyword with the given namespace and name if one already
exists.  This function will not intern a new keyword. If the keyword
has not already been interned, it will return nil.  Do not use :
in the keyword strings, it will be added automatically.
sourceraw docstring

find-ns

(find-ns sym)

Returns the namespace named by the symbol or nil if it doesn't exist.

Returns the namespace named by the symbol or nil if it doesn't exist.
sourceraw docstring

find-protocol-impl

(find-protocol-impl protocol x)
source

find-protocol-method

(find-protocol-method protocol methodk x)
source

find-var

(find-var sym)

Returns the global var named by the namespace-qualified symbol, or nil if no var with that name.

Returns the global var named by the namespace-qualified symbol, or
nil if no var with that name.
sourceraw docstring

first

(first coll)

Returns the first item in the collection. Calls seq on its argument. If coll is nil, returns nil.

Returns the first item in the collection. Calls seq on its
argument. If coll is nil, returns nil.
sourceraw docstring

flatten

(flatten x)

Takes any nested combination of sequential things (lists, vectors, etc.) and returns their contents as a single, flat lazy sequence. (flatten nil) returns an empty sequence.

Takes any nested combination of sequential things (lists, vectors,
etc.) and returns their contents as a single, flat lazy sequence.
(flatten nil) returns an empty sequence.
sourceraw docstring

float

(float x)

Coerce to float

Coerce to float
sourceraw docstring

float-array

(float-array size-or-seq)
(float-array size init-val-or-seq)

Creates an array of floats

Creates an array of floats
sourceraw docstring

float?

(float? n)

Returns true if n is a floating point number

Returns true if n is a floating point number
sourceraw docstring

floats

(floats xs)

Casts to float[]

Casts to float[]
sourceraw docstring

flush

(flush)

Flushes the output stream that is the current value of out

Flushes the output stream that is the current value of
*out*
sourceraw docstring

fnmacro

(fn & sigs)

params => positional-params* , or positional-params* & next-param positional-param => binding-form next-param => binding-form name => symbol

Defines a function

params => positional-params* , or positional-params* & next-param
positional-param => binding-form
next-param => binding-form
name => symbol

Defines a function
sourceraw docstring

fn?

(fn? x)

Returns true if x implements Fn, i.e. is an object created via fn.

Returns true if x implements Fn, i.e. is an object created via fn.
sourceraw docstring

fnext

(fnext x)

Same as (first (next x))

Same as (first (next x))
sourceraw docstring

fnil

(fnil f x)
(fnil f x y)
(fnil f x y z)

Takes a function f, and returns a function that calls f, replacing a nil first argument to f with the supplied value x. Higher arity versions can replace arguments in the second and third positions (y, z). Note that the function f can take any number of arguments, not just the one(s) being nil-patched.

Takes a function f, and returns a function that calls f, replacing
a nil first argument to f with the supplied value x. Higher arity
versions can replace arguments in the second and third
positions (y, z). Note that the function f can take any number of
arguments, not just the one(s) being nil-patched.
sourceraw docstring

formacro

(for seq-exprs body-expr)

List comprehension. Takes a vector of one or more binding-form/collection-expr pairs, each followed by zero or more modifiers, and yields a lazy sequence of evaluations of expr. Collections are iterated in a nested fashion, rightmost fastest, and nested coll-exprs can refer to bindings created in prior binding-forms. Supported modifiers are: :let [binding-form expr ...], :while test, :when test.

(take 100 (for [x (range 100000000) y (range 1000000) :while (< y x)] [x y]))

List comprehension. Takes a vector of one or more
 binding-form/collection-expr pairs, each followed by zero or more
 modifiers, and yields a lazy sequence of evaluations of expr.
 Collections are iterated in a nested fashion, rightmost fastest,
 and nested coll-exprs can refer to bindings created in prior
 binding-forms.  Supported modifiers are: :let [binding-form expr ...],
 :while test, :when test.

(take 100 (for [x (range 100000000) y (range 1000000) :while (< y x)] [x y]))
sourceraw docstring

force

(force x)

If x is a Delay, returns the (possibly cached) value of its expression, else returns x

If x is a Delay, returns the (possibly cached) value of its expression, else returns x
sourceraw docstring

format

(format fmt & args)

Formats a string using java.lang.String.format, see java.util.Formatter for format string syntax

Formats a string using java.lang.String.format, see java.util.Formatter for format
string syntax
sourceraw docstring

frequencies

(frequencies coll)

Returns a map from distinct items in coll to the number of times they appear.

Returns a map from distinct items in coll to the number of times
they appear.
sourceraw docstring

futuremacro

(future & body)

Takes a body of expressions and yields a future object that will invoke the body in another thread, and will cache the result and return it on all subsequent calls to deref/@. If the computation has not yet finished, calls to deref/@ will block, unless the variant of deref with timeout is used. See also - realized?.

Takes a body of expressions and yields a future object that will
invoke the body in another thread, and will cache the result and
return it on all subsequent calls to deref/@. If the computation has
not yet finished, calls to deref/@ will block, unless the variant of
deref with timeout is used. See also - realized?.
sourceraw docstring

future-call

(future-call f)

Takes a function of no args and yields a future object that will invoke the function in another thread, and will cache the result and return it on all subsequent calls to deref/@. If the computation has not yet finished, calls to deref/@ will block, unless the variant of deref with timeout is used. See also - realized?.

Takes a function of no args and yields a future object that will
invoke the function in another thread, and will cache the result and
return it on all subsequent calls to deref/@. If the computation has
not yet finished, calls to deref/@ will block, unless the variant
of deref with timeout is used. See also - realized?.
sourceraw docstring

future-cancel

(future-cancel f)

Cancels the future, if possible.

Cancels the future, if possible.
sourceraw docstring

future-cancelled?

(future-cancelled? f)

Returns true if future f is cancelled

Returns true if future f is cancelled
sourceraw docstring

future-done?

(future-done? f)

Returns true if future f is done

Returns true if future f is done
sourceraw docstring

future?

(future? x)

Returns true if x is a future

Returns true if x is a future
sourceraw docstring

gen-classmacro

(gen-class & options)

When compiling, generates compiled bytecode for a class with the given package-qualified :name (which, as all names in these parameters, can be a string or symbol), and writes the .class file to the compile-path directory. When not compiling, does nothing. The gen-class construct contains no implementation, as the implementation will be dynamically sought by the generated class in functions in an implementing Clojure namespace. Given a generated class org.mydomain.MyClass with a method named mymethod, gen-class will generate an implementation that looks for a function named by (str prefix mymethod) (default prefix: "-") in a Clojure namespace specified by :impl-ns (defaults to the current namespace). All inherited methods, generated methods, and init and main functions (see :methods, :init, and :main below) will be found similarly prefixed. By default, the static initializer for the generated class will attempt to load the Clojure support code for the class as a resource from the classpath, e.g. in the example case, org/mydomain/MyClass__init.class. This behavior can be controlled by :load-impl-ns

Note that methods with a maximum of 18 parameters are supported.

In all subsequent sections taking types, the primitive types can be referred to by their Java names (int, float etc), and classes in the java.lang package can be used without a package qualifier. All other classes must be fully qualified.

Options should be a set of key/value pairs, all except for :name are optional:

:name aname

The package-qualified name of the class to be generated

:extends aclass

Specifies the superclass, the non-private methods of which will be overridden by the class. If not provided, defaults to Object.

:implements [interface ...]

One or more interfaces, the methods of which will be implemented by the class.

:init name

If supplied, names a function that will be called with the arguments to the constructor. Must return [ [superclass-constructor-args] state] If not supplied, the constructor args are passed directly to the superclass constructor and the state will be nil

:constructors {[param-types] [super-param-types], ...}

By default, constructors are created for the generated class which match the signature(s) of the constructors for the superclass. This parameter may be used to explicitly specify constructors, each entry providing a mapping from a constructor signature to a superclass constructor signature. When you supply this, you must supply an :init specifier.

:post-init name

If supplied, names a function that will be called with the object as the first argument, followed by the arguments to the constructor. It will be called every time an object of this class is created, immediately after all the inherited constructors have completed. Its return value is ignored.

:methods [ [name [param-types] return-type], ...]

The generated class automatically defines all of the non-private methods of its superclasses/interfaces. This parameter can be used to specify the signatures of additional methods of the generated class. Static methods can be specified with ^{:static true} in the signature's metadata. Do not repeat superclass/interface signatures here.

:main boolean

If supplied and true, a static public main function will be generated. It will pass each string of the String[] argument as a separate argument to a function called (str prefix main).

:factory name

If supplied, a (set of) public static factory function(s) will be created with the given name, and the same signature(s) as the constructor(s).

:state name

If supplied, a public final instance field with the given name will be created. You must supply an :init function in order to provide a value for the state. Note that, though final, the state can be a ref or agent, supporting the creation of Java objects with transactional or asynchronous mutation semantics.

:exposes {protected-field-name {:get name :set name}, ...}

Since the implementations of the methods of the generated class occur in Clojure functions, they have no access to the inherited protected fields of the superclass. This parameter can be used to generate public getter/setter methods exposing the protected field(s) for use in the implementation.

:exposes-methods {super-method-name exposed-name, ...}

It is sometimes necessary to call the superclass' implementation of an overridden method. Those methods may be exposed and referred in the new method implementation by a local name.

:prefix string

Default: "-" Methods called e.g. Foo will be looked up in vars called prefixFoo in the implementing ns.

:impl-ns name

Default: the name of the current ns. Implementations of methods will be looked up in this namespace.

:load-impl-ns boolean

Default: true. Causes the static initializer for the generated class to reference the load code for the implementing namespace. Should be true when implementing-ns is the default, false if you intend to load the code via some other method.

When compiling, generates compiled bytecode for a class with the
given package-qualified :name (which, as all names in these
parameters, can be a string or symbol), and writes the .class file
to the *compile-path* directory.  When not compiling, does
nothing. The gen-class construct contains no implementation, as the
implementation will be dynamically sought by the generated class in
functions in an implementing Clojure namespace. Given a generated
class org.mydomain.MyClass with a method named mymethod, gen-class
will generate an implementation that looks for a function named by 
(str prefix mymethod) (default prefix: "-") in a
Clojure namespace specified by :impl-ns
(defaults to the current namespace). All inherited methods,
generated methods, and init and main functions (see :methods, :init,
and :main below) will be found similarly prefixed. By default, the
static initializer for the generated class will attempt to load the
Clojure support code for the class as a resource from the classpath,
e.g. in the example case, ``org/mydomain/MyClass__init.class``. This
behavior can be controlled by :load-impl-ns

Note that methods with a maximum of 18 parameters are supported.

In all subsequent sections taking types, the primitive types can be
referred to by their Java names (int, float etc), and classes in the
java.lang package can be used without a package qualifier. All other
classes must be fully qualified.

Options should be a set of key/value pairs, all except for :name are optional:

:name aname

The package-qualified name of the class to be generated

:extends aclass

Specifies the superclass, the non-private methods of which will be
overridden by the class. If not provided, defaults to Object.

:implements [interface ...]

One or more interfaces, the methods of which will be implemented by the class.

:init name

If supplied, names a function that will be called with the arguments
to the constructor. Must return [ [superclass-constructor-args] state] 
If not supplied, the constructor args are passed directly to
the superclass constructor and the state will be nil

:constructors {[param-types] [super-param-types], ...}

By default, constructors are created for the generated class which
match the signature(s) of the constructors for the superclass. This
parameter may be used to explicitly specify constructors, each entry
providing a mapping from a constructor signature to a superclass
constructor signature. When you supply this, you must supply an :init
specifier. 

:post-init name

If supplied, names a function that will be called with the object as
the first argument, followed by the arguments to the constructor.
It will be called every time an object of this class is created,
immediately after all the inherited constructors have completed.
Its return value is ignored.

:methods [ [name [param-types] return-type], ...]

The generated class automatically defines all of the non-private
methods of its superclasses/interfaces. This parameter can be used
to specify the signatures of additional methods of the generated
class. Static methods can be specified with ^{:static true} in the
signature's metadata. Do not repeat superclass/interface signatures
here.

:main boolean

If supplied and true, a static public main function will be generated. It will
pass each string of the String[] argument as a separate argument to
a function called (str prefix main).

:factory name

If supplied, a (set of) public static factory function(s) will be
created with the given name, and the same signature(s) as the
constructor(s).

:state name

If supplied, a public final instance field with the given name will be
created. You must supply an :init function in order to provide a
value for the state. Note that, though final, the state can be a ref
or agent, supporting the creation of Java objects with transactional
or asynchronous mutation semantics.

:exposes {protected-field-name {:get name :set name}, ...}

Since the implementations of the methods of the generated class
occur in Clojure functions, they have no access to the inherited
protected fields of the superclass. This parameter can be used to
generate public getter/setter methods exposing the protected field(s)
for use in the implementation.

:exposes-methods {super-method-name exposed-name, ...}

It is sometimes necessary to call the superclass' implementation of an
overridden method.  Those methods may be exposed and referred in 
the new method implementation by a local name.

:prefix string

Default: "-" Methods called e.g. Foo will be looked up in vars called
prefixFoo in the implementing ns.

:impl-ns name

Default: the name of the current ns. Implementations of methods will be 
looked up in this namespace.

:load-impl-ns boolean

Default: true. Causes the static initializer for the generated class
to reference the load code for the implementing namespace. Should be
true when implementing-ns is the default, false if you intend to
load the code via some other method.
sourceraw docstring

gen-interfacemacro

(gen-interface & options)

When compiling, generates compiled bytecode for an interface with the given package-qualified :name (which, as all names in these parameters, can be a string or symbol), and writes the .class file to the compile-path directory. When not compiling, does nothing.

In all subsequent sections taking types, the primitive types can be referred to by their Java names (int, float etc), and classes in the java.lang package can be used without a package qualifier. All other classes must be fully qualified.

Options should be a set of key/value pairs, all except for :name are optional:

:name aname

The package-qualified name of the class to be generated

:extends [interface ...]

One or more interfaces, which will be extended by this interface.

:methods [ [name [param-types] return-type], ...]

This parameter is used to specify the signatures of the methods of the generated interface. Do not repeat superinterface signatures here.

When compiling, generates compiled bytecode for an interface with
the given package-qualified :name (which, as all names in these
parameters, can be a string or symbol), and writes the .class file
to the *compile-path* directory.  When not compiling, does nothing.

In all subsequent sections taking types, the primitive types can be
referred to by their Java names (int, float etc), and classes in the
java.lang package can be used without a package qualifier. All other
classes must be fully qualified.

Options should be a set of key/value pairs, all except for :name are
optional:

:name aname

The package-qualified name of the class to be generated

:extends [interface ...]

One or more interfaces, which will be extended by this interface.

:methods [ [name [param-types] return-type], ...]

This parameter is used to specify the signatures of the methods of
the generated interface.  Do not repeat superinterface signatures
here.
sourceraw docstring

gensym

(gensym)
(gensym prefix-string)

Returns a new symbol with a unique name. If a prefix string is supplied, the name is prefix# where # is some unique number. If prefix is not supplied, the prefix is 'G__'.

Returns a new symbol with a unique name. If a prefix string is
supplied, the name is prefix# where # is some unique number. If
prefix is not supplied, the prefix is 'G__'.
sourceraw docstring

get

(get map key)
(get map key not-found)

Returns the value mapped to key, not-found or nil if key not present.

Returns the value mapped to key, not-found or nil if key not present.
sourceraw docstring

get-in

(get-in m ks)
(get-in m ks not-found)

Returns the value in a nested associative structure, where ks is a sequence of keys. Returns nil if the key is not present, or the not-found value if supplied.

Returns the value in a nested associative structure,
where ks is a sequence of keys. Returns nil if the key
is not present, or the not-found value if supplied.
sourceraw docstring

get-method

(get-method multifn dispatch-val)

Given a multimethod and a dispatch value, returns the dispatch fn that would apply to that value, or nil if none apply and no default

Given a multimethod and a dispatch value, returns the dispatch fn
that would apply to that value, or nil if none apply and no default
sourceraw docstring

get-proxy-class

(get-proxy-class & bases)

Takes an optional single class followed by zero or more interfaces. If not supplied class defaults to Object. Creates an returns an instance of a proxy class derived from the supplied classes. The resulting value is cached and used for any subsequent requests for the same class set. Returns a Class object.

Takes an optional single class followed by zero or more
interfaces. If not supplied class defaults to Object.  Creates an
returns an instance of a proxy class derived from the supplied
classes. The resulting value is cached and used for any subsequent
requests for the same class set. Returns a Class object.
sourceraw docstring

get-thread-bindings

(get-thread-bindings)

Get a map with the Var/value pairs which is currently in effect for the current thread.

Get a map with the Var/value pairs which is currently in effect for the
current thread.
sourceraw docstring

get-validator

(get-validator iref)

Gets the validator-fn for a var/ref/agent/atom.

Gets the validator-fn for a var/ref/agent/atom.
sourceraw docstring

group-by

(group-by f coll)

Returns a 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.

Returns a 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.
sourceraw docstring

halt-when

(halt-when pred)
(halt-when pred retf)

Returns a transducer that ends transduction when pred returns true for an input. When retf is supplied it must be a fn of 2 arguments - it will be passed the (completed) result so far and the input that triggered the predicate, and its return value (if it does not throw an exception) will be the return value of the transducer. If retf is not supplied, the input that triggered the predicate will be returned. If the predicate never returns true the transduction is unaffected.

Returns a transducer that ends transduction when pred returns true
for an input. When retf is supplied it must be a fn of 2 arguments -
it will be passed the (completed) result so far and the input that
triggered the predicate, and its return value (if it does not throw
an exception) will be the return value of the transducer. If retf
is not supplied, the input that triggered the predicate will be
returned. If the predicate never returns true the transduction is
unaffected.
sourceraw docstring

hash

(hash x)

Returns the hash code of its argument. Note this is the hash code consistent with =, and thus is different than .hashCode for Integer, Short, Byte and Clojure collections.

Returns the hash code of its argument. Note this is the hash code
consistent with =, and thus is different than .hashCode for Integer,
Short, Byte and Clojure collections.
sourceraw docstring

hash-combine

(hash-combine x y)
source

hash-map

(hash-map)
(hash-map & keyvals)

keyval => key val Returns a new hash map with supplied mappings. If any keys are equal, they are handled as if by repeated uses of assoc.

keyval => key val
Returns a new hash map with supplied mappings.  If any keys are
equal, they are handled as if by repeated uses of assoc.
sourceraw docstring

hash-ordered-coll

(hash-ordered-coll coll)

Returns the hash code, consistent with =, for an external ordered collection implementing Iterable. See http://clojure.org/data_structures#hash for full algorithms.

Returns the hash code, consistent with =, for an external ordered
collection implementing Iterable.
See http://clojure.org/data_structures#hash for full algorithms.
sourceraw docstring

hash-set

(hash-set)
(hash-set & keys)

Returns a new hash set with supplied keys. Any equal keys are handled as if by repeated uses of conj.

Returns a new hash set with supplied keys.  Any equal keys are
handled as if by repeated uses of conj.
sourceraw docstring

hash-unordered-coll

(hash-unordered-coll coll)

Returns the hash code, consistent with =, for an external unordered collection implementing Iterable. For maps, the iterator should return map entries whose hash is computed as (hash-ordered-coll [k v]). See http://clojure.org/data_structures#hash for full algorithms.

Returns the hash code, consistent with =, for an external unordered
collection implementing Iterable. For maps, the iterator should
return map entries whose hash is computed as
  (hash-ordered-coll [k v]).
See http://clojure.org/data_structures#hash for full algorithms.
sourceraw docstring

ident?

(ident? x)

Return true if x is a symbol or keyword

Return true if x is a symbol or keyword
sourceraw docstring

identical?

(identical? x y)

Tests if 2 arguments are the same object

Tests if 2 arguments are the same object
sourceraw docstring

identity

(identity x)

Returns its argument.

Returns its argument.
sourceraw docstring

if-letmacro

(if-let bindings then)
(if-let bindings
        then
        else
        &
        oldform)

bindings => binding-form test

If test is true, evaluates then with binding-form bound to the value of test, if not, yields else

bindings => binding-form test

If test is true, evaluates then with binding-form bound to the value of 
test, if not, yields else
sourceraw docstring

if-notmacro

(if-not test then)
(if-not test then else)

Evaluates test. If logical false, evaluates and returns then expr, otherwise else expr, if supplied, else nil.

Evaluates test. If logical false, evaluates and returns then expr, 
otherwise else expr, if supplied, else nil.
sourceraw docstring

if-somemacro

(if-some bindings then)
(if-some bindings
         then
         else
         &
         oldform)

bindings => binding-form test

If test is not nil, evaluates then with binding-form bound to the value of test, if not, yields else

bindings => binding-form test

If test is not nil, evaluates then with binding-form bound to the
value of test, if not, yields else
sourceraw docstring

ifn?

(ifn? x)

Returns true if x implements IFn. Note that many data structures (e.g. sets and maps) implement IFn

Returns true if x implements IFn. Note that many data structures
(e.g. sets and maps) implement IFn
sourceraw docstring

importmacro

(import & import-symbols-or-lists)

import-list => (package-symbol class-name-symbols*)

For each name in class-name-symbols, adds a mapping from name to the class named by package.name to the current namespace. Use :import in the ns macro in preference to calling this directly.

import-list => (package-symbol class-name-symbols*)

For each name in class-name-symbols, adds a mapping from name to the
class named by package.name to the current namespace. Use :import in the ns
macro in preference to calling this directly.
sourceraw docstring

in-ns

(in-ns name)

Sets ns to the namespace named by the symbol, creating it if needed.

Sets *ns* to the namespace named by the symbol, creating it if needed.
sourceraw docstring

inc

(inc x)

Returns a number one greater than num. Does not auto-promote longs, will throw on overflow. See also: inc'

Returns a number one greater than num. Does not auto-promote
longs, will throw on overflow. See also: inc'
sourceraw docstring

inc'

(inc' x)

Returns a number one greater than num. Supports arbitrary precision. See also: inc

Returns a number one greater than num. Supports arbitrary precision.
See also: inc
sourceraw docstring

indexed?

(indexed? coll)

Return true if coll implements Indexed, indicating efficient lookup by index

Return true if coll implements Indexed, indicating efficient lookup by index
sourceraw docstring

init-proxy

(init-proxy proxy mappings)

Takes a proxy instance and a map of strings (which must correspond to methods of the proxy superclass/superinterfaces) to fns (which must take arguments matching the corresponding method, plus an additional (explicit) first arg corresponding to this, and sets the proxy's fn map. Returns the proxy.

Takes a proxy instance and a map of strings (which must
correspond to methods of the proxy superclass/superinterfaces) to
fns (which must take arguments matching the corresponding method,
plus an additional (explicit) first arg corresponding to this, and
sets the proxy's fn map.  Returns the proxy.
sourceraw docstring

Instprotocol

inst-ms*
(inst-ms* inst)
source

inst-ms

(inst-ms inst)

Return the number of milliseconds since January 1, 1970, 00:00:00 GMT

Return the number of milliseconds since January 1, 1970, 00:00:00 GMT
sourceraw docstring

inst?

(inst? x)

Return true if x satisfies Inst

Return true if x satisfies Inst
sourceraw docstring

instance?

(instance? c x)

Evaluates x and tests if it is an instance of the class c. Returns true or false

Evaluates x and tests if it is an instance of the class
c. Returns true or false
sourceraw docstring

int

(int x)

Coerce to int

Coerce to int
sourceraw docstring

int-array

(int-array size-or-seq)
(int-array size init-val-or-seq)

Creates an array of ints

Creates an array of ints
sourceraw docstring

int?

(int? x)

Return true if x is a fixed precision integer

Return true if x is a fixed precision integer
sourceraw docstring

integer?

(integer? n)

Returns true if n is an integer

Returns true if n is an integer
sourceraw docstring

interleave

(interleave)
(interleave c1)
(interleave c1 c2)
(interleave c1 c2 & colls)

Returns a lazy seq of the first item in each coll, then the second etc.

Returns a lazy seq of the first item in each coll, then the second etc.
sourceraw docstring

intern

(intern ns name)
(intern ns name val)

Finds or creates a var named by the symbol name in the namespace ns (which can be a symbol or a namespace), setting its root binding to val if supplied. The namespace must exist. The var will adopt any metadata from the name symbol. Returns the var.

Finds or creates a var named by the symbol name in the namespace
ns (which can be a symbol or a namespace), setting its root binding
to val if supplied. The namespace must exist. The var will adopt any
metadata from the name symbol.  Returns the var.
sourceraw docstring

interpose

(interpose sep)
(interpose sep coll)

Returns a lazy seq of the elements of coll separated by sep. Returns a stateful transducer when no collection is provided.

Returns a lazy seq of the elements of coll separated by sep.
Returns a stateful transducer when no collection is provided.
sourceraw docstring

into

(into)
(into to)
(into to from)
(into to xform from)

Returns a new coll consisting of to-coll with all of the items of from-coll conjoined. A transducer may be supplied.

Returns a new coll consisting of to-coll with all of the items of
from-coll conjoined. A transducer may be supplied.
sourceraw docstring

into-array

(into-array aseq)
(into-array type aseq)

Returns an array with components set to the values in aseq. The array's component type is type if provided, or the type of the first value in aseq if present, or Object. All values in aseq must be compatible with the component type. Class objects for the primitive types can be obtained using, e.g., Integer/TYPE.

Returns an array with components set to the values in aseq. The array's
component type is type if provided, or the type of the first value in
aseq if present, or Object. All values in aseq must be compatible with
the component type. Class objects for the primitive types can be obtained
using, e.g., Integer/TYPE.
sourceraw docstring

ints

(ints xs)

Casts to int[]

Casts to int[]
sourceraw docstring

io!macro

(io! & body)

If an io! block occurs in a transaction, throws an IllegalStateException, else runs body in an implicit do. If the first expression in body is a literal string, will use that as the exception message.

If an io! block occurs in a transaction, throws an
IllegalStateException, else runs body in an implicit do. If the
first expression in body is a literal string, will use that as the
exception message.
sourceraw docstring

isa?

(isa? child parent)
(isa? h child parent)

Returns true if (= child parent), or child is directly or indirectly derived from parent, either via a Java type inheritance relationship or a relationship established via derive. h must be a hierarchy obtained from make-hierarchy, if not supplied defaults to the global hierarchy

Returns true if (= child parent), or child is directly or indirectly derived from
parent, either via a Java type inheritance relationship or a
relationship established via derive. h must be a hierarchy obtained
from make-hierarchy, if not supplied defaults to the global
hierarchy
sourceraw docstring

iterate

(iterate f x)

Returns a lazy sequence of x, (f x), (f (f x)) etc. f must be free of side-effects

Returns a lazy sequence of x, (f x), (f (f x)) etc. f must be free of side-effects
sourceraw docstring

iterator-seq

(iterator-seq iter)

Returns a seq on a java.util.Iterator. Note that most collections providing iterators implement Iterable and thus support seq directly. Seqs cache values, thus iterator-seq should not be used on any iterator that repeatedly returns the same mutable object.

Returns a seq on a java.util.Iterator. Note that most collections
providing iterators implement Iterable and thus support seq directly.
Seqs cache values, thus iterator-seq should not be used on any
iterator that repeatedly returns the same mutable object.
sourceraw docstring

juxt

(juxt f)
(juxt f g)
(juxt f g h)
(juxt f g h & fs)

Takes a set of functions and returns a fn that is the juxtaposition of those fns. The returned fn takes a variable number of args, and returns a vector containing the result of applying each fn to the args (left-to-right). ((juxt a b c) x) => [(a x) (b x) (c x)]

Takes a set of functions and returns a fn that is the juxtaposition
of those fns.  The returned fn takes a variable number of args, and
returns a vector containing the result of applying each fn to the
args (left-to-right).
((juxt a b c) x) => [(a x) (b x) (c x)]
sourceraw docstring

keep

(keep f)
(keep f coll)

Returns a lazy sequence of the non-nil results of (f item). Note, this means false return values will be included. f must be free of side-effects. Returns a transducer when no collection is provided.

Returns a lazy sequence of the non-nil results of (f item). Note,
this means false return values will be included.  f must be free of
side-effects.  Returns a transducer when no collection is provided.
sourceraw docstring

keep-indexed

(keep-indexed f)
(keep-indexed f coll)

Returns a lazy sequence of the non-nil results of (f index item). Note, this means false return values will be included. f must be free of side-effects. Returns a stateful transducer when no collection is provided.

Returns a lazy sequence of the non-nil results of (f index item). Note,
this means false return values will be included.  f must be free of
side-effects.  Returns a stateful transducer when no collection is
provided.
sourceraw docstring

key

(key e)

Returns the key of the map entry.

Returns the key of the map entry.
sourceraw docstring

keys

(keys map)

Returns a sequence of the map's keys, in the same order as (seq map).

Returns a sequence of the map's keys, in the same order as (seq map).
sourceraw docstring

keyword

(keyword name)
(keyword ns name)

Returns a Keyword with the given namespace and name. Do not use : in the keyword strings, it will be added automatically.

Returns a Keyword with the given namespace and name.  Do not use :
in the keyword strings, it will be added automatically.
sourceraw docstring

keyword?

(keyword? x)

Return true if x is a Keyword

Return true if x is a Keyword
sourceraw docstring

last

(last coll)

Return the last item in coll, in linear time

Return the last item in coll, in linear time
sourceraw docstring

lazy-catmacro

(lazy-cat & colls)

Expands to code which yields a lazy sequence of the concatenation of the supplied colls. Each coll expr is not evaluated until it is needed.

(lazy-cat xs ys zs) === (concat (lazy-seq xs) (lazy-seq ys) (lazy-seq zs))

Expands to code which yields a lazy sequence of the concatenation
of the supplied colls.  Each coll expr is not evaluated until it is
needed. 

(lazy-cat xs ys zs) === (concat (lazy-seq xs) (lazy-seq ys) (lazy-seq zs))
sourceraw docstring

lazy-seqmacro

(lazy-seq & body)

Takes a body of expressions that returns an ISeq or nil, and yields a Seqable object that will invoke the body only the first time seq is called, and will cache the result and return it on all subsequent seq calls. See also - realized?

Takes a body of expressions that returns an ISeq or nil, and yields
a Seqable object that will invoke the body only the first time seq
is called, and will cache the result and return it on all subsequent
seq calls. See also - realized?
sourceraw docstring

letmacro

(let bindings
     &
     body)

binding => binding-form init-expr

Evaluates the exprs in a lexical context in which the symbols in the binding-forms are bound to their respective init-exprs or parts therein.

binding => binding-form init-expr

Evaluates the exprs in a lexical context in which the symbols in
the binding-forms are bound to their respective init-exprs or parts
therein.
sourceraw docstring

letfnmacro

(letfn fnspecs
       &
       body)

fnspec ==> (fname [params*] exprs) or (fname ([params*] exprs)+)

Takes a vector of function specs and a body, and generates a set of bindings of functions to their names. All of the names are available in all of the definitions of the functions, as well as the body.

fnspec ==> (fname [params*] exprs) or (fname ([params*] exprs)+)

Takes a vector of function specs and a body, and generates a set of
bindings of functions to their names. All of the names are available
in all of the definitions of the functions, as well as the body.
sourceraw docstring

line-seq

(line-seq rdr)

Returns the lines of text from rdr as a lazy sequence of strings. rdr must implement java.io.BufferedReader.

Returns the lines of text from rdr as a lazy sequence of strings.
rdr must implement java.io.BufferedReader.
sourceraw docstring

list

(list & items)

Creates a new list containing the items.

Creates a new list containing the items.
sourceraw docstring

list*

(list* args)
(list* a args)
(list* a b args)
(list* a b c args)
(list* a b c d & more)

Creates a new seq containing the items prepended to the rest, the last of which will be treated as a sequence.

Creates a new seq containing the items prepended to the rest, the
last of which will be treated as a sequence.
sourceraw docstring

list?

(list? x)

Returns true if x implements IPersistentList

Returns true if x implements IPersistentList
sourceraw docstring

load

(load & paths)

Loads Clojure code from resources in classpath. A path is interpreted as classpath-relative if it begins with a slash or relative to the root directory for the current namespace otherwise.

Loads Clojure code from resources in classpath. A path is interpreted as
classpath-relative if it begins with a slash or relative to the root
directory for the current namespace otherwise.
sourceraw docstring

load-file

(load-file name)

Sequentially read and evaluate the set of forms contained in the file.

Sequentially read and evaluate the set of forms contained in the file.
sourceraw docstring

load-reader

(load-reader rdr)

Sequentially read and evaluate the set of forms contained in the stream/file

Sequentially read and evaluate the set of forms contained in the
stream/file
sourceraw docstring

load-string

(load-string s)

Sequentially read and evaluate the set of forms contained in the string

Sequentially read and evaluate the set of forms contained in the
string
sourceraw docstring

loaded-libs

(loaded-libs)

Returns a sorted set of symbols naming the currently loaded libs

Returns a sorted set of symbols naming the currently loaded libs
sourceraw docstring

lockingmacro

(locking x & body)

Executes exprs in an implicit do, while holding the monitor of x. Will release the monitor of x in all circumstances.

Executes exprs in an implicit do, while holding the monitor of x.
Will release the monitor of x in all circumstances.
sourceraw docstring

long

(long x)

Coerce to long

Coerce to long
sourceraw docstring

long-array

(long-array size-or-seq)
(long-array size init-val-or-seq)

Creates an array of longs

Creates an array of longs
sourceraw docstring

longs

(longs xs)

Casts to long[]

Casts to long[]
sourceraw docstring

loopmacro

(loop bindings
      &
      body)

Evaluates the exprs in a lexical context in which the symbols in the binding-forms are bound to their respective init-exprs or parts therein. Acts as a recur target.

Evaluates the exprs in a lexical context in which the symbols in
the binding-forms are bound to their respective init-exprs or parts
therein. Acts as a recur target.
sourceraw docstring

macroexpand

(macroexpand form)

Repeatedly calls macroexpand-1 on form until it no longer represents a macro form, then returns it. Note neither macroexpand-1 nor macroexpand expand macros in subforms.

Repeatedly calls macroexpand-1 on form until it no longer
represents a macro form, then returns it.  Note neither
macroexpand-1 nor macroexpand expand macros in subforms.
sourceraw docstring

macroexpand-1

(macroexpand-1 form)

If form represents a macro form, returns its expansion, else returns form.

If form represents a macro form, returns its expansion,
else returns form.
sourceraw docstring

make-array

(make-array type len)
(make-array type dim & more-dims)

Creates and returns an array of instances of the specified class of the specified dimension(s). Note that a class object is required. Class objects can be obtained by using their imported or fully-qualified name. Class objects for the primitive types can be obtained using, e.g., Integer/TYPE.

Creates and returns an array of instances of the specified class of
the specified dimension(s).  Note that a class object is required.
Class objects can be obtained by using their imported or
fully-qualified name.  Class objects for the primitive types can be
obtained using, e.g., Integer/TYPE.
sourceraw docstring

make-hierarchy

(make-hierarchy)

Creates a hierarchy object for use with derive, isa? etc.

Creates a hierarchy object for use with derive, isa? etc.
sourceraw docstring

map

(map f)
(map f coll)
(map f c1 c2)
(map f c1 c2 c3)
(map f c1 c2 c3 & colls)

Returns a lazy sequence consisting of the result of applying f to the set of first items of each coll, followed by applying f to the set of second items in each coll, until any one of the colls is exhausted. Any remaining items in other colls are ignored. Function f should accept number-of-colls arguments. Returns a transducer when no collection is provided.

Returns a lazy sequence consisting of the result of applying f to
the set of first items of each coll, followed by applying f to the
set of second items in each coll, until any one of the colls is
exhausted.  Any remaining items in other colls are ignored. Function
f should accept number-of-colls arguments. Returns a transducer when
no collection is provided.
sourceraw docstring

map-entry?

(map-entry? x)

Return true if x is a map entry

Return true if x is a map entry
sourceraw docstring

map-indexed

(map-indexed f)
(map-indexed f coll)

Returns a lazy sequence consisting of the result of applying f to 0 and the first item of coll, followed by applying f to 1 and the second item in coll, etc, until coll is exhausted. Thus function f should accept 2 arguments, index and item. Returns a stateful transducer when no collection is provided.

Returns a lazy sequence consisting of the result of applying f to 0
and the first item of coll, followed by applying f to 1 and the second
item in coll, etc, until coll is exhausted. Thus function f should
accept 2 arguments, index and item. Returns a stateful transducer when
no collection is provided.
sourceraw docstring

map?

(map? x)

Return true if x implements IPersistentMap

Return true if x implements IPersistentMap
sourceraw docstring

mapcat

(mapcat f)
(mapcat f & colls)

Returns the result of applying concat to the result of applying map to f and colls. Thus function f should return a collection. Returns a transducer when no collections are provided

Returns the result of applying concat to the result of applying map
to f and colls.  Thus function f should return a collection. Returns
a transducer when no collections are provided
sourceraw docstring

mapv

(mapv f coll)
(mapv f c1 c2)
(mapv f c1 c2 c3)
(mapv f c1 c2 c3 & colls)

Returns a vector consisting of the result of applying f to the set of first items of each coll, followed by applying f to the set of second items in each coll, until any one of the colls is exhausted. Any remaining items in other colls are ignored. Function f should accept number-of-colls arguments.

Returns a vector consisting of the result of applying f to the
set of first items of each coll, followed by applying f to the set
of second items in each coll, until any one of the colls is
exhausted.  Any remaining items in other colls are ignored. Function
f should accept number-of-colls arguments.
sourceraw docstring

max

(max x)
(max x y)
(max x y & more)

Returns the greatest of the nums.

Returns the greatest of the nums.
sourceraw docstring

max-key

(max-key k x)
(max-key k x y)
(max-key k x y & more)

Returns the x for which (k x), a number, is greatest.

If there are multiple such xs, the last one is returned.

Returns the x for which (k x), a number, is greatest.

If there are multiple such xs, the last one is returned.
sourceraw docstring

memfnmacro

(memfn name & args)

Expands into code that creates a fn that expects to be passed an object and any args and calls the named instance method on the object passing the args. Use when you want to treat a Java method as a first-class fn. name may be type-hinted with the method receiver's type in order to avoid reflective calls.

Expands into code that creates a fn that expects to be passed an
object and any args and calls the named instance method on the
object passing the args. Use when you want to treat a Java method as
a first-class fn. name may be type-hinted with the method receiver's
type in order to avoid reflective calls.
sourceraw docstring

memoize

(memoize f)

Returns a memoized version of a referentially transparent function. The memoized version of the function keeps a cache of the mapping from arguments to results and, when calls with the same arguments are repeated often, has higher performance at the expense of higher memory use.

Returns a memoized version of a referentially transparent function. The
memoized version of the function keeps a cache of the mapping from arguments
to results and, when calls with the same arguments are repeated often, has
higher performance at the expense of higher memory use.
sourceraw docstring

merge

(merge & maps)

Returns a map that consists of the rest of the maps conj-ed onto the first. If a key occurs in more than one map, the mapping from the latter (left-to-right) will be the mapping in the result.

Returns a map that consists of the rest of the maps conj-ed onto
the first.  If a key occurs in more than one map, the mapping from
the latter (left-to-right) will be the mapping in the result.
sourceraw docstring

merge-with

(merge-with f & maps)

Returns a map that consists of the rest of the maps conj-ed onto the first. If a key occurs in more than one map, the mapping(s) from the latter (left-to-right) will be combined with the mapping in the result by calling (f val-in-result val-in-latter).

Returns a map that consists of the rest of the maps conj-ed onto
the first.  If a key occurs in more than one map, the mapping(s)
from the latter (left-to-right) will be combined with the mapping in
the result by calling (f val-in-result val-in-latter).
sourceraw docstring

meta

(meta obj)

Returns the metadata of obj, returns nil if there is no metadata.

Returns the metadata of obj, returns nil if there is no metadata.
sourceraw docstring

method-sig

(method-sig meth)
source

methods

(methods multifn)

Given a multimethod, returns a map of dispatch values -> dispatch fns

Given a multimethod, returns a map of dispatch values -> dispatch fns
sourceraw docstring

min

(min x)
(min x y)
(min x y & more)

Returns the least of the nums.

Returns the least of the nums.
sourceraw docstring

min-key

(min-key k x)
(min-key k x y)
(min-key k x y & more)

Returns the x for which (k x), a number, is least.

If there are multiple such xs, the last one is returned.

Returns the x for which (k x), a number, is least.

If there are multiple such xs, the last one is returned.
sourceraw docstring

mix-collection-hash

(mix-collection-hash hash-basis count)

Mix final collection hash for ordered or unordered collections. hash-basis is the combined collection hash, count is the number of elements included in the basis. Note this is the hash code consistent with =, different from .hashCode. See http://clojure.org/data_structures#hash for full algorithms.

Mix final collection hash for ordered or unordered collections.
hash-basis is the combined collection hash, count is the number
of elements included in the basis. Note this is the hash code
consistent with =, different from .hashCode.
See http://clojure.org/data_structures#hash for full algorithms.
sourceraw docstring

mod

(mod num div)

Modulus of num and div. Truncates toward negative infinity.

Modulus of num and div. Truncates toward negative infinity.
sourceraw docstring

munge

(munge s)
source

name

(name x)

Returns the name String of a string, symbol or keyword.

Returns the name String of a string, symbol or keyword.
sourceraw docstring

namespace

(namespace x)

Returns the namespace String of a symbol or keyword, or nil if not present.

Returns the namespace String of a symbol or keyword, or nil if not present.
sourceraw docstring

namespace-munge

(namespace-munge ns)

Convert a Clojure namespace name to a legal Java package name.

Convert a Clojure namespace name to a legal Java package name.
sourceraw docstring

nat-int?

(nat-int? x)

Return true if x is a non-negative fixed precision integer

Return true if x is a non-negative fixed precision integer
sourceraw docstring

neg-int?

(neg-int? x)

Return true if x is a negative fixed precision integer

Return true if x is a negative fixed precision integer
sourceraw docstring

neg?

(neg? num)

Returns true if num is less than zero, else false

Returns true if num is less than zero, else false
sourceraw docstring

newline

(newline)

Writes a platform-specific newline to out

Writes a platform-specific newline to *out*
sourceraw docstring

next

(next coll)

Returns a seq of the items after the first. Calls seq on its argument. If there are no more items, returns nil.

Returns a seq of the items after the first. Calls seq on its
argument.  If there are no more items, returns nil.
sourceraw docstring

nfirst

(nfirst x)

Same as (next (first x))

Same as (next (first x))
sourceraw docstring

nil?

(nil? x)

Returns true if x is nil, false otherwise.

Returns true if x is nil, false otherwise.
sourceraw docstring

nnext

(nnext x)

Same as (next (next x))

Same as (next (next x))
sourceraw docstring

not

(not x)

Returns true if x is logical false, false otherwise.

Returns true if x is logical false, false otherwise.
sourceraw docstring

not-any?

(not-any? pred coll)

Returns false if (pred x) is logical true for any x in coll, else true.

Returns false if (pred x) is logical true for any x in coll,
else true.
sourceraw docstring

not-empty

(not-empty coll)

If coll is empty, returns nil, else coll

If coll is empty, returns nil, else coll
sourceraw docstring

not-every?

(not-every? pred coll)

Returns false if (pred x) is logical true for every x in coll, else true.

Returns false if (pred x) is logical true for every x in
coll, else true.
sourceraw docstring

not=

(not= x)
(not= x y)
(not= x y & more)

Same as (not (= obj1 obj2))

Same as (not (= obj1 obj2))
sourceraw docstring

nsmacro

(ns name docstring? attr-map? references*)

Sets ns to the namespace named by name (unevaluated), creating it if needed. references can be zero or more of: (:refer-clojure ...) (:require ...) (:use ...) (:import ...) (:load ...) (:gen-class) with the syntax of refer-clojure/require/use/import/load/gen-class respectively, except the arguments are unevaluated and need not be quoted. (:gen-class ...), when supplied, defaults to :name corresponding to the ns name, :main true, :impl-ns same as ns, and :init-impl-ns true. All options of gen-class are supported. The :gen-class directive is ignored when not compiling. If :gen-class is not supplied, when compiled only an nsname__init.class will be generated. If :refer-clojure is not used, a default (refer 'clojure.core) is used. Use of ns is preferred to individual calls to in-ns/require/use/import:

(ns foo.bar (:refer-clojure :exclude [ancestors printf]) (:require (clojure.contrib sql combinatorics)) (:use (my.lib this that)) (:import (java.util Date Timer Random) (java.sql Connection Statement)))

Sets *ns* to the namespace named by name (unevaluated), creating it
if needed.  references can be zero or more of: (:refer-clojure ...)
(:require ...) (:use ...) (:import ...) (:load ...) (:gen-class)
with the syntax of refer-clojure/require/use/import/load/gen-class
respectively, except the arguments are unevaluated and need not be
quoted. (:gen-class ...), when supplied, defaults to :name
corresponding to the ns name, :main true, :impl-ns same as ns, and
:init-impl-ns true. All options of gen-class are
supported. The :gen-class directive is ignored when not
compiling. If :gen-class is not supplied, when compiled only an
nsname__init.class will be generated. If :refer-clojure is not used, a
default (refer 'clojure.core) is used.  Use of ns is preferred to
individual calls to in-ns/require/use/import:

(ns foo.bar
  (:refer-clojure :exclude [ancestors printf])
  (:require (clojure.contrib sql combinatorics))
  (:use (my.lib this that))
  (:import (java.util Date Timer Random)
           (java.sql Connection Statement)))
sourceraw docstring

ns-aliases

(ns-aliases ns)

Returns a map of the aliases for the namespace.

Returns a map of the aliases for the namespace.
sourceraw docstring

ns-imports

(ns-imports ns)

Returns a map of the import mappings for the namespace.

Returns a map of the import mappings for the namespace.
sourceraw docstring

ns-interns

(ns-interns ns)

Returns a map of the intern mappings for the namespace.

Returns a map of the intern mappings for the namespace.
sourceraw docstring

ns-map

(ns-map ns)

Returns a map of all the mappings for the namespace.

Returns a map of all the mappings for the namespace.
sourceraw docstring

ns-name

(ns-name ns)

Returns the name of the namespace, a symbol.

Returns the name of the namespace, a symbol.
sourceraw docstring

ns-publics

(ns-publics ns)

Returns a map of the public intern mappings for the namespace.

Returns a map of the public intern mappings for the namespace.
sourceraw docstring

ns-refers

(ns-refers ns)

Returns a map of the refer mappings for the namespace.

Returns a map of the refer mappings for the namespace.
sourceraw docstring

ns-resolve

(ns-resolve ns sym)
(ns-resolve ns env sym)

Returns the var or Class to which a symbol will be resolved in the namespace (unless found in the environment), else nil. Note that if the symbol is fully qualified, the var/Class to which it resolves need not be present in the namespace.

Returns the var or Class to which a symbol will be resolved in the
namespace (unless found in the environment), else nil.  Note that
if the symbol is fully qualified, the var/Class to which it resolves
need not be present in the namespace.
sourceraw docstring

ns-unalias

(ns-unalias ns sym)

Removes the alias for the symbol from the namespace.

Removes the alias for the symbol from the namespace.
sourceraw docstring

ns-unmap

(ns-unmap ns sym)

Removes the mappings for the symbol from the namespace.

Removes the mappings for the symbol from the namespace.
sourceraw docstring

nth

(nth coll index)
(nth coll index not-found)

Returns the value at the index. get returns nil if index out of bounds, nth throws an exception unless not-found is supplied. nth also works for strings, Java arrays, regex Matchers and Lists, and, in O(n) time, for sequences.

Returns the value at the index. get returns nil if index out of
bounds, nth throws an exception unless not-found is supplied.  nth
also works for strings, Java arrays, regex Matchers and Lists, and,
in O(n) time, for sequences.
sourceraw docstring

nthnext

(nthnext coll n)

Returns the nth next of coll, (seq coll) when n is 0.

Returns the nth next of coll, (seq coll) when n is 0.
sourceraw docstring

nthrest

(nthrest coll n)

Returns the nth rest of coll, coll when n is 0.

Returns the nth rest of coll, coll when n is 0.
sourceraw docstring

num

(num x)

Coerce to Number

Coerce to Number
sourceraw docstring

number?

(number? x)

Returns true if x is a Number

Returns true if x is a Number
sourceraw docstring

numerator

(numerator r)

Returns the numerator part of a Ratio.

Returns the numerator part of a Ratio.
sourceraw docstring

object-array

(object-array size-or-seq)

Creates an array of objects

Creates an array of objects
sourceraw docstring

odd?

(odd? n)

Returns true if n is odd, throws an exception if n is not an integer

Returns true if n is odd, throws an exception if n is not an integer
sourceraw docstring

ormacro

(or)
(or x)
(or x & next)

Evaluates exprs one at a time, from left to right. If a form returns a logical true value, or returns that value and doesn't evaluate any of the other expressions, otherwise it returns the value of the last expression. (or) returns nil.

Evaluates exprs one at a time, from left to right. If a form
returns a logical true value, or returns that value and doesn't
evaluate any of the other expressions, otherwise it returns the
value of the last expression. (or) returns nil.
sourceraw docstring

parents

(parents tag)
(parents h tag)

Returns the immediate parents of tag, either via a Java type inheritance relationship or a relationship established via derive. h must be a hierarchy obtained from make-hierarchy, if not supplied defaults to the global hierarchy

Returns the immediate parents of tag, either via a Java type
inheritance relationship or a relationship established via derive. h
must be a hierarchy obtained from make-hierarchy, if not supplied
defaults to the global hierarchy
sourceraw docstring

partial

(partial f)
(partial f arg1)
(partial f arg1 arg2)
(partial f arg1 arg2 arg3)
(partial f arg1 arg2 arg3 & more)

Takes a function f and fewer than the normal arguments to f, and returns a fn that takes a variable number of additional args. When called, the returned function calls f with args + additional args.

Takes a function f and fewer than the normal arguments to f, and
returns a fn that takes a variable number of additional args. When
called, the returned function calls f with args + additional args.
sourceraw docstring

partition

(partition n coll)
(partition n step coll)
(partition n step pad coll)

Returns a lazy sequence of lists of n items each, at offsets step apart. If step is not supplied, defaults to n, i.e. the partitions do not overlap. If a pad collection is supplied, use its elements as necessary to complete last partition upto n items. In case there are not enough padding elements, return a partition with less than n items.

Returns a lazy sequence of lists of n items each, at offsets step
apart. If step is not supplied, defaults to n, i.e. the partitions
do not overlap. If a pad collection is supplied, use its elements as
necessary to complete last partition upto n items. In case there are
not enough padding elements, return a partition with less than n items.
sourceraw docstring

partition-all

(partition-all n)
(partition-all n coll)
(partition-all n step coll)

Returns a lazy sequence of lists like partition, but may include partitions with fewer than n items at the end. Returns a stateful transducer when no collection is provided.

Returns a lazy sequence of lists like partition, but may include
partitions with fewer than n items at the end.  Returns a stateful
transducer when no collection is provided.
sourceraw docstring

partition-by

(partition-by f)
(partition-by f coll)

Applies f to each value in coll, splitting it each time f returns a new value. Returns a lazy seq of partitions. Returns a stateful transducer when no collection is provided.

Applies f to each value in coll, splitting it each time f returns a
new value.  Returns a lazy seq of partitions.  Returns a stateful
transducer when no collection is provided.
sourceraw docstring

pcalls

(pcalls & fns)

Executes the no-arg fns in parallel, returning a lazy sequence of their values

Executes the no-arg fns in parallel, returning a lazy sequence of
their values
sourceraw docstring

peek

(peek coll)

For a list or queue, same as first, for a vector, same as, but much more efficient than, last. If the collection is empty, returns nil.

For a list or queue, same as first, for a vector, same as, but much
more efficient than, last. If the collection is empty, returns nil.
sourceraw docstring

persistent!

(persistent! coll)

Returns a new, persistent version of the transient collection, in constant time. The transient collection cannot be used after this call, any such use will throw an exception.

Returns a new, persistent version of the transient collection, in
constant time. The transient collection cannot be used after this
call, any such use will throw an exception.
sourceraw docstring

pmap

(pmap f coll)
(pmap f coll & colls)

Like map, except f is applied in parallel. Semi-lazy in that the parallel computation stays ahead of the consumption, but doesn't realize the entire result unless required. Only useful for computationally intensive functions where the time of f dominates the coordination overhead.

Like map, except f is applied in parallel. Semi-lazy in that the
parallel computation stays ahead of the consumption, but doesn't
realize the entire result unless required. Only useful for
computationally intensive functions where the time of f dominates
the coordination overhead.
sourceraw docstring

pop

(pop coll)

For a list or queue, returns a new list/queue without the first item, for a vector, returns a new vector without the last item. If the collection is empty, throws an exception. Note - not the same as next/butlast.

For a list or queue, returns a new list/queue without the first
item, for a vector, returns a new vector without the last item. If
the collection is empty, throws an exception.  Note - not the same
as next/butlast.
sourceraw docstring

pop!

(pop! coll)

Removes the last item from a transient vector. If the collection is empty, throws an exception. Returns coll

Removes the last item from a transient vector. If
the collection is empty, throws an exception. Returns coll
sourceraw docstring

pop-thread-bindings

(pop-thread-bindings)

Pop one set of bindings pushed with push-binding before. It is an error to pop bindings without pushing before.

Pop one set of bindings pushed with push-binding before. It is an error to
pop bindings without pushing before.
sourceraw docstring

pos-int?

(pos-int? x)

Return true if x is a positive fixed precision integer

Return true if x is a positive fixed precision integer
sourceraw docstring

pos?

(pos? num)

Returns true if num is greater than zero, else false

Returns true if num is greater than zero, else false
sourceraw docstring

pr

(pr)
(pr x)
(pr x & more)

Prints the object(s) to the output stream that is the current value of out. Prints the object(s), separated by spaces if there is more than one. By default, pr and prn print in a way that objects can be read by the reader

Prints the object(s) to the output stream that is the current value
of *out*.  Prints the object(s), separated by spaces if there is
more than one.  By default, pr and prn print in a way that objects
can be read by the reader
sourceraw docstring

pr-str

(pr-str & xs)

pr to a string, returning it

pr to a string, returning it
sourceraw docstring

prefer-method

(prefer-method multifn dispatch-val-x dispatch-val-y)

Causes the multimethod to prefer matches of dispatch-val-x over dispatch-val-y when there is a conflict

Causes the multimethod to prefer matches of dispatch-val-x over dispatch-val-y 
when there is a conflict
sourceraw docstring

prefers

(prefers multifn)

Given a multimethod, returns a map of preferred value -> set of other values

Given a multimethod, returns a map of preferred value -> set of other values
sourceraw docstring

primitives-classnames

source

print

(print & more)

Prints the object(s) to the output stream that is the current value of out. print and println produce output for human consumption.

Prints the object(s) to the output stream that is the current value
of *out*.  print and println produce output for human consumption.
sourceraw docstring

(print-ctor o print-args w)
source

source

source

(print-simple o w)
source

(print-str & xs)

print to a string, returning it

print to a string, returning it
sourceraw docstring

printf

(printf fmt & args)

Prints formatted output, as per format

Prints formatted output, as per format
sourceraw docstring

println

(println & more)

Same as print followed by (newline)

Same as print followed by (newline)
sourceraw docstring

println-str

(println-str & xs)

println to a string, returning it

println to a string, returning it
sourceraw docstring

PrintWriter-on

(PrintWriter-on flush-fn close-fn)

implements java.io.PrintWriter given flush-fn, which will be called when .flush() is called, with a string built up since the last call to .flush(). if not nil, close-fn will be called with no arguments when .close is called

implements java.io.PrintWriter given flush-fn, which will be called
when .flush() is called, with a string built up since the last call to .flush().
if not nil, close-fn will be called with no arguments when .close is called
sourceraw docstring

prn

(prn & more)

Same as pr followed by (newline). Observes flush-on-newline

Same as pr followed by (newline). Observes *flush-on-newline*
sourceraw docstring

prn-str

(prn-str & xs)

prn to a string, returning it

prn to a string, returning it
sourceraw docstring

promise

(promise)

Returns a promise object that can be read with deref/@, and set, once only, with deliver. Calls to deref/@ prior to delivery will block, unless the variant of deref with timeout is used. All subsequent derefs will return the same delivered value without blocking. See also - realized?.

Returns a promise object that can be read with deref/@, and set,
once only, with deliver. Calls to deref/@ prior to delivery will
block, unless the variant of deref with timeout is used. All
subsequent derefs will return the same delivered value without
blocking. See also - realized?.
sourceraw docstring

proxymacro

(proxy class-and-interfaces args & fs)

class-and-interfaces - a vector of class names

args - a (possibly empty) vector of arguments to the superclass constructor.

f => (name [params*] body) or (name ([params*] body) ([params+] body) ...)

Expands to code which creates a instance of a proxy class that implements the named class/interface(s) by calling the supplied fns. A single class, if provided, must be first. If not provided it defaults to Object.

The interfaces names must be valid interface types. If a method fn is not provided for a class method, the superclass method will be called. If a method fn is not provided for an interface method, an UnsupportedOperationException will be thrown should it be called. Method fns are closures and can capture the environment in which proxy is called. Each method fn takes an additional implicit first arg, which is bound to 'this. Note that while method fns can be provided to override protected methods, they have no other access to protected members, nor to super, as these capabilities cannot be proxied.

class-and-interfaces - a vector of class names

args - a (possibly empty) vector of arguments to the superclass
constructor.

f => (name [params*] body) or
(name ([params*] body) ([params+] body) ...)

Expands to code which creates a instance of a proxy class that
implements the named class/interface(s) by calling the supplied
fns. A single class, if provided, must be first. If not provided it
defaults to Object.

The interfaces names must be valid interface types. If a method fn
is not provided for a class method, the superclass method will be
called. If a method fn is not provided for an interface method, an
UnsupportedOperationException will be thrown should it be
called. Method fns are closures and can capture the environment in
which proxy is called. Each method fn takes an additional implicit
first arg, which is bound to 'this. Note that while method fns can
be provided to override protected methods, they have no other access
to protected members, nor to super, as these capabilities cannot be
proxied.
sourceraw docstring

proxy-call-with-super

(proxy-call-with-super call this meth)
source

proxy-mappings

(proxy-mappings proxy)

Takes a proxy instance and returns the proxy's fn map.

Takes a proxy instance and returns the proxy's fn map.
sourceraw docstring

proxy-name

(proxy-name super interfaces)
source

proxy-supermacro

(proxy-super meth & args)

Use to call a superclass method in the body of a proxy method. Note, expansion captures 'this

Use to call a superclass method in the body of a proxy method. 
Note, expansion captures 'this
sourceraw docstring

push-thread-bindings

(push-thread-bindings bindings)

WARNING: This is a low-level function. Prefer high-level macros like binding where ever possible.

Takes a map of Var/value pairs. Binds each Var to the associated value for the current thread. Each call MUST be accompanied by a matching call to pop-thread-bindings wrapped in a try-finally!

(push-thread-bindings bindings)
(try
  ...
  (finally
    (pop-thread-bindings)))
WARNING: This is a low-level function. Prefer high-level macros like
binding where ever possible.

Takes a map of Var/value pairs. Binds each Var to the associated value for
the current thread. Each call *MUST* be accompanied by a matching call to
pop-thread-bindings wrapped in a try-finally!

    (push-thread-bindings bindings)
    (try
      ...
      (finally
        (pop-thread-bindings)))
sourceraw docstring

pvaluesmacro

(pvalues & exprs)

Returns a lazy sequence of the values of the exprs, which are evaluated in parallel

Returns a lazy sequence of the values of the exprs, which are
evaluated in parallel
sourceraw docstring

qualified-ident?

(qualified-ident? x)

Return true if x is a symbol or keyword with a namespace

Return true if x is a symbol or keyword with a namespace
sourceraw docstring

qualified-keyword?

(qualified-keyword? x)

Return true if x is a keyword with a namespace

Return true if x is a keyword with a namespace
sourceraw docstring

qualified-symbol?

(qualified-symbol? x)

Return true if x is a symbol with a namespace

Return true if x is a symbol with a namespace
sourceraw docstring

quot

(quot num div)

quot[ient] of dividing numerator by denominator.

quot[ient] of dividing numerator by denominator.
sourceraw docstring

rand

(rand)
(rand n)

Returns a random floating point number between 0 (inclusive) and n (default 1) (exclusive).

Returns a random floating point number between 0 (inclusive) and
n (default 1) (exclusive).
sourceraw docstring

rand-int

(rand-int n)

Returns a random integer between 0 (inclusive) and n (exclusive).

Returns a random integer between 0 (inclusive) and n (exclusive).
sourceraw docstring

rand-nth

(rand-nth coll)

Return a random element of the (sequential) collection. Will have the same performance characteristics as nth for the given collection.

Return a random element of the (sequential) collection. Will have
the same performance characteristics as nth for the given
collection.
sourceraw docstring

random-sample

(random-sample prob)
(random-sample prob coll)

Returns items from coll with random probability of prob (0.0 - 1.0). Returns a transducer when no collection is provided.

Returns items from coll with random probability of prob (0.0 -
1.0).  Returns a transducer when no collection is provided.
sourceraw docstring

range

(range)
(range end)
(range start end)
(range start end step)

Returns a lazy seq of nums from start (inclusive) to end (exclusive), by step, where start defaults to 0, step to 1, and end to infinity. When step is equal to 0, returns an infinite sequence of start. When start is equal to end, returns empty list.

Returns a lazy seq of nums from start (inclusive) to end
(exclusive), by step, where start defaults to 0, step to 1, and end to
infinity. When step is equal to 0, returns an infinite sequence of
start. When start is equal to end, returns empty list.
sourceraw docstring

ratio?

(ratio? n)

Returns true if n is a Ratio

Returns true if n is a Ratio
sourceraw docstring

rational?

(rational? n)

Returns true if n is a rational number

Returns true if n is a rational number
sourceraw docstring

rationalize

(rationalize num)

returns the rational value of num

returns the rational value of num
sourceraw docstring

re-find

(re-find m)
(re-find re s)

Returns the next regex match, if any, of string to pattern, using java.util.regex.Matcher.find(). Uses re-groups to return the groups.

Returns the next regex match, if any, of string to pattern, using
java.util.regex.Matcher.find().  Uses re-groups to return the
groups.
sourceraw docstring

re-groups

(re-groups m)

Returns the groups from the most recent match/find. If there are no nested groups, returns a string of the entire match. If there are nested groups, returns a vector of the groups, the first element being the entire match.

Returns the groups from the most recent match/find. If there are no
nested groups, returns a string of the entire match. If there are
nested groups, returns a vector of the groups, the first element
being the entire match.
sourceraw docstring

re-matcher

(re-matcher re s)

Returns an instance of java.util.regex.Matcher, for use, e.g. in re-find.

Returns an instance of java.util.regex.Matcher, for use, e.g. in
re-find.
sourceraw docstring

re-matches

(re-matches re s)

Returns the match, if any, of string to pattern, using java.util.regex.Matcher.matches(). Uses re-groups to return the groups.

Returns the match, if any, of string to pattern, using
java.util.regex.Matcher.matches().  Uses re-groups to return the
groups.
sourceraw docstring

re-pattern

(re-pattern s)

Returns an instance of java.util.regex.Pattern, for use, e.g. in re-matcher.

Returns an instance of java.util.regex.Pattern, for use, e.g. in
re-matcher.
sourceraw docstring

re-seq

(re-seq re s)

Returns a lazy sequence of successive matches of pattern in string, using java.util.regex.Matcher.find(), each such match processed with re-groups.

Returns a lazy sequence of successive matches of pattern in string,
using java.util.regex.Matcher.find(), each such match processed with
re-groups.
sourceraw docstring

read

(read)
(read stream)
(read opts stream)
(read stream eof-error? eof-value)
(read stream eof-error? eof-value recursive?)

Reads the next object from stream, which must be an instance of java.io.PushbackReader or some derivee. stream defaults to the current value of in.

Opts is a persistent map with valid keys: :read-cond - :allow to process reader conditionals, or :preserve to keep all branches :features - persistent set of feature keywords for reader conditionals :eof - on eof, return value unless :eofthrow, then throw. if not specified, will throw

Note that read can execute code (controlled by read-eval), and as such should be used only with trusted sources.

For data structure interop use clojure.edn/read

Reads the next object from stream, which must be an instance of
java.io.PushbackReader or some derivee.  stream defaults to the
current value of *in*.

Opts is a persistent map with valid keys:
  :read-cond - :allow to process reader conditionals, or
               :preserve to keep all branches
  :features - persistent set of feature keywords for reader conditionals
  :eof - on eof, return value unless :eofthrow, then throw.
         if not specified, will throw

Note that read can execute code (controlled by *read-eval*),
and as such should be used only with trusted sources.

For data structure interop use clojure.edn/read
sourceraw docstring

read+string

(read+string)
(read+string stream)
(read+string opts stream)
(read+string stream eof-error? eof-value)
(read+string stream eof-error? eof-value recursive?)

Like read, and taking the same args. stream must be a LineNumberingPushbackReader. Returns a vector containing the object read and the (whitespace-trimmed) string read.

Like read, and taking the same args. stream must be a LineNumberingPushbackReader.
Returns a vector containing the object read and the (whitespace-trimmed) string read.
sourceraw docstring

read-line

(read-line)

Reads the next line from stream that is the current value of in .

Reads the next line from stream that is the current value of *in* .
sourceraw docstring

read-string

(read-string s)
(read-string opts s)

Reads one object from the string s. Optionally include reader options, as specified in read.

Note that read-string can execute code (controlled by read-eval), and as such should be used only with trusted sources.

For data structure interop use clojure.edn/read-string

Reads one object from the string s. Optionally include reader
options, as specified in read.

Note that read-string can execute code (controlled by *read-eval*),
and as such should be used only with trusted sources.

For data structure interop use clojure.edn/read-string
sourceraw docstring

reader-conditional

(reader-conditional form splicing?)

Construct a data representation of a reader conditional. If true, splicing? indicates read-cond-splicing.

Construct a data representation of a reader conditional.
If true, splicing? indicates read-cond-splicing.
sourceraw docstring

reader-conditional?

(reader-conditional? value)

Return true if the value is the data representation of a reader conditional

Return true if the value is the data representation of a reader conditional
sourceraw docstring

realized?

(realized? x)

Returns true if a value has been produced for a promise, delay, future or lazy sequence.

Returns true if a value has been produced for a promise, delay, future or lazy sequence.
sourceraw docstring

record?

(record? x)

Returns true if x is a record

Returns true if x is a record
sourceraw docstring

reduce

(reduce f coll)
(reduce f val coll)

f should be a function of 2 arguments. If val is not supplied, returns the result of applying f to the first 2 items in coll, then applying f to that result and the 3rd item, etc. If coll contains no items, f must accept no arguments as well, and reduce returns the result of calling f with no arguments. If coll has only 1 item, it is returned and f is not called. If val is supplied, returns the result of applying f to val and the first item in coll, then applying f to that result and the 2nd item, etc. If coll contains no items, returns val and f is not called.

f should be a function of 2 arguments. If val is not supplied,
returns the result of applying f to the first 2 items in coll, then
applying f to that result and the 3rd item, etc. If coll contains no
items, f must accept no arguments as well, and reduce returns the
result of calling f with no arguments.  If coll has only 1 item, it
is returned and f is not called.  If val is supplied, returns the
result of applying f to val and the first item in coll, then
applying f to that result and the 2nd item, etc. If coll contains no
items, returns val and f is not called.
sourceraw docstring

reduce-kv

(reduce-kv f init coll)

Reduces an associative collection. f should be a function of 3 arguments. Returns the result of applying f to init, the first key and the first value in coll, then applying f to that result and the 2nd key and value, etc. If coll contains no entries, returns init and f is not called. Note that reduce-kv is supported on vectors, where the keys will be the ordinals.

Reduces an associative collection. f should be a function of 3
arguments. Returns the result of applying f to init, the first key
and the first value in coll, then applying f to that result and the
2nd key and value, etc. If coll contains no entries, returns init
and f is not called. Note that reduce-kv is supported on vectors,
where the keys will be the ordinals.
sourceraw docstring

reduced

(reduced x)

Wraps x in a way such that a reduce will terminate with the value x

Wraps x in a way such that a reduce will terminate with the value x
sourceraw docstring

reduced?

(reduced? x)

Returns true if x is the result of a call to reduced

Returns true if x is the result of a call to reduced
sourceraw docstring

reductions

(reductions f coll)
(reductions f init coll)

Returns a lazy seq of the intermediate values of the reduction (as per reduce) of coll by f, starting with init.

Returns a lazy seq of the intermediate values of the reduction (as
per reduce) of coll by f, starting with init.
sourceraw docstring

ref

(ref x)
(ref x & options)

Creates and returns a Ref with an initial value of x and zero or more options (in any order):

:meta metadata-map

:validator validate-fn

:min-history (default 0) :max-history (default 10)

If metadata-map is supplied, it will become the metadata on the ref. validate-fn must be nil or a side-effect-free fn of one argument, which will be passed the intended new state on any state change. If the new state is unacceptable, the validate-fn should return false or throw an exception. validate-fn will be called on transaction commit, when all refs have their final values.

Normally refs accumulate history dynamically as needed to deal with read demands. If you know in advance you will need history you can set :min-history to ensure it will be available when first needed (instead of after a read fault). History is limited, and the limit can be set with :max-history.

Creates and returns a Ref with an initial value of x and zero or
more options (in any order):

:meta metadata-map

:validator validate-fn

:min-history (default 0)
:max-history (default 10)

If metadata-map is supplied, it will become the metadata on the
ref. validate-fn must be nil or a side-effect-free fn of one
argument, which will be passed the intended new state on any state
change. If the new state is unacceptable, the validate-fn should
return false or throw an exception. validate-fn will be called on
transaction commit, when all refs have their final values.

Normally refs accumulate history dynamically as needed to deal with
read demands. If you know in advance you will need history you can
set :min-history to ensure it will be available when first needed (instead
of after a read fault). History is limited, and the limit can be set
with :max-history.
sourceraw docstring

ref-history-count

(ref-history-count ref)

Returns the history count of a ref

Returns the history count of a ref
sourceraw docstring

ref-max-history

(ref-max-history ref)
(ref-max-history ref n)

Gets the max-history of a ref, or sets it and returns the ref

Gets the max-history of a ref, or sets it and returns the ref
sourceraw docstring

ref-min-history

(ref-min-history ref)
(ref-min-history ref n)

Gets the min-history of a ref, or sets it and returns the ref

Gets the min-history of a ref, or sets it and returns the ref
sourceraw docstring

ref-set

(ref-set ref val)

Must be called in a transaction. Sets the value of ref. Returns val.

Must be called in a transaction. Sets the value of ref.
Returns val.
sourceraw docstring

refer

(refer ns-sym & filters)

refers to all public vars of ns, subject to filters. filters can include at most one each of:

:exclude list-of-symbols :only list-of-symbols :rename map-of-fromsymbol-tosymbol

For each public interned var in the namespace named by the symbol, adds a mapping from the name of the var to the var to the current namespace. Throws an exception if name is already mapped to something else in the current namespace. Filters can be used to select a subset, via inclusion or exclusion, or to provide a mapping to a symbol different from the var's name, in order to prevent clashes. Use :use in the ns macro in preference to calling this directly.

refers to all public vars of ns, subject to filters.
filters can include at most one each of:

:exclude list-of-symbols
:only list-of-symbols
:rename map-of-fromsymbol-tosymbol

For each public interned var in the namespace named by the symbol,
adds a mapping from the name of the var to the var to the current
namespace.  Throws an exception if name is already mapped to
something else in the current namespace. Filters can be used to
select a subset, via inclusion or exclusion, or to provide a mapping
to a symbol different from the var's name, in order to prevent
clashes. Use :use in the ns macro in preference to calling this directly.
sourceraw docstring

refer-clojuremacro

(refer-clojure & filters)

Same as (refer 'clojure.core <filters>)

Same as (refer 'clojure.core <filters>)
sourceraw docstring

reifymacro

(reify
  &
    opts+specs)

reify is a macro with the following structure:

(reify options* specs*)

Currently there are no options.

Each spec consists of the protocol or interface name followed by zero or more method bodies:

protocol-or-interface-or-Object (methodName [args+] body)*

Methods should be supplied for all methods of the desired protocol(s) and interface(s). You can also define overrides for methods of Object. Note that the first parameter must be supplied to correspond to the target object ('this' in Java parlance). Thus methods for interfaces will take one more argument than do the interface declarations. Note also that recur calls to the method head should not pass the target object, it will be supplied automatically and can not be substituted.

The return type can be indicated by a type hint on the method name, and arg types can be indicated by a type hint on arg names. If you leave out all hints, reify will try to match on same name/arity method in the protocol(s)/interface(s) - this is preferred. If you supply any hints at all, no inference is done, so all hints (or default of Object) must be correct, for both arguments and return type. If a method is overloaded in a protocol/interface, multiple independent method definitions must be supplied. If overloaded with same arity in an interface you must specify complete hints to disambiguate - a missing hint implies Object.

recur works to method heads The method bodies of reify are lexical closures, and can refer to the surrounding local scope:

(str (let [f "foo"] (reify Object (toString [this] f)))) == "foo"

(seq (let [f "foo"] (reify clojure.lang.Seqable (seq [this] (seq f))))) == (\f \o \o))

reify always implements clojure.lang.IObj and transfers meta data of the form to the created object.

(meta ^{:k :v} (reify Object (toString [this] "foo"))) == {:k :v}

reify is a macro with the following structure:

(reify options* specs*)
 
 Currently there are no options.

 Each spec consists of the protocol or interface name followed by zero
 or more method bodies:

 protocol-or-interface-or-Object
 (methodName [args+] body)*

 Methods should be supplied for all methods of the desired
 protocol(s) and interface(s). You can also define overrides for
 methods of Object. Note that the first parameter must be supplied to
 correspond to the target object ('this' in Java parlance). Thus
 methods for interfaces will take one more argument than do the
 interface declarations.  Note also that recur calls to the method
 head should *not* pass the target object, it will be supplied
 automatically and can not be substituted.

 The return type can be indicated by a type hint on the method name,
 and arg types can be indicated by a type hint on arg names. If you
 leave out all hints, reify will try to match on same name/arity
 method in the protocol(s)/interface(s) - this is preferred. If you
 supply any hints at all, no inference is done, so all hints (or
 default of Object) must be correct, for both arguments and return
 type. If a method is overloaded in a protocol/interface, multiple
 independent method definitions must be supplied.  If overloaded with
 same arity in an interface you must specify complete hints to
 disambiguate - a missing hint implies Object.

 recur works to method heads The method bodies of reify are lexical
 closures, and can refer to the surrounding local scope:
 
 (str (let [f "foo"] 
      (reify Object 
        (toString [this] f))))
 == "foo"

 (seq (let [f "foo"] 
      (reify clojure.lang.Seqable 
        (seq [this] (seq f)))))
 == (\f \o \o))
 
 reify always implements clojure.lang.IObj and transfers meta
 data of the form to the created object.
 
 (meta ^{:k :v} (reify Object (toString [this] "foo")))
 == {:k :v}
sourceraw docstring

release-pending-sends

(release-pending-sends)

Normally, actions sent directly or indirectly during another action are held until the action completes (changes the agent's state). This function can be used to dispatch any pending sent actions immediately. This has no impact on actions sent during a transaction, which are still held until commit. If no action is occurring, does nothing. Returns the number of actions dispatched.

Normally, actions sent directly or indirectly during another action
are held until the action completes (changes the agent's
state). This function can be used to dispatch any pending sent
actions immediately. This has no impact on actions sent during a
transaction, which are still held until commit. If no action is
occurring, does nothing. Returns the number of actions dispatched.
sourceraw docstring

rem

(rem num div)

remainder of dividing numerator by denominator.

remainder of dividing numerator by denominator.
sourceraw docstring

remove

(remove pred)
(remove pred coll)

Returns a lazy sequence of the items in coll for which (pred item) returns logical false. pred must be free of side-effects. Returns a transducer when no collection is provided.

Returns a lazy sequence of the items in coll for which
(pred item) returns logical false. pred must be free of side-effects.
Returns a transducer when no collection is provided.
sourceraw docstring

remove-all-methods

(remove-all-methods multifn)

Removes all of the methods of multimethod.

Removes all of the methods of multimethod.
sourceraw docstring

remove-method

(remove-method multifn dispatch-val)

Removes the method of multimethod associated with dispatch-value.

Removes the method of multimethod associated with dispatch-value.
sourceraw docstring

remove-ns

(remove-ns sym)

Removes the namespace named by the symbol. Use with caution. Cannot be used to remove the clojure namespace.

Removes the namespace named by the symbol. Use with caution.
Cannot be used to remove the clojure namespace.
sourceraw docstring

remove-tap

(remove-tap f)

Remove f from the tap set.

Remove f from the tap set.
sourceraw docstring

remove-watch

(remove-watch reference key)

Removes a watch (set by add-watch) from a reference

Removes a watch (set by add-watch) from a reference
sourceraw docstring

repeat

(repeat x)
(repeat n x)

Returns a lazy (infinite!, or length n if supplied) sequence of xs.

Returns a lazy (infinite!, or length n if supplied) sequence of xs.
sourceraw docstring

repeatedly

(repeatedly f)
(repeatedly n f)

Takes a function of no args, presumably with side effects, and returns an infinite (or length n if supplied) lazy sequence of calls to it

Takes a function of no args, presumably with side effects, and
returns an infinite (or length n if supplied) lazy sequence of calls
to it
sourceraw docstring

replace

(replace smap)
(replace smap coll)

Given a map of replacement pairs and a vector/collection, returns a vector/seq with any elements = a key in smap replaced with the corresponding val in smap. Returns a transducer when no collection is provided.

Given a map of replacement pairs and a vector/collection, returns a
vector/seq with any elements = a key in smap replaced with the
corresponding val in smap.  Returns a transducer when no collection
is provided.
sourceraw docstring

replicatedeprecated

(replicate n x)

DEPRECATED: Use 'repeat' instead. Returns a lazy seq of n xs.

DEPRECATED: Use 'repeat' instead.
Returns a lazy seq of n xs.
sourceraw docstring

require

(require & args)

Loads libs, skipping any that are already loaded. Each argument is either a libspec that identifies a lib, a prefix list that identifies multiple libs whose names share a common prefix, or a flag that modifies how all the identified libs are loaded. Use :require in the ns macro in preference to calling this directly.

Libs

A 'lib' is a named set of resources in classpath whose contents define a library of Clojure code. Lib names are symbols and each lib is associated with a Clojure namespace and a Java package that share its name. A lib's name also locates its root directory within classpath using Java's package name to classpath-relative path mapping. All resources in a lib should be contained in the directory structure under its root directory. All definitions a lib makes should be in its associated namespace.

'require loads a lib by loading its root resource. The root resource path is derived from the lib name in the following manner: Consider a lib named by the symbol 'x.y.z; it has the root directory <classpath>/x/y/, and its root resource is <classpath>/x/y/z.clj, or <classpath>/x/y/z.cljc if <classpath>/x/y/z.clj does not exist. The root resource should contain code to create the lib's namespace (usually by using the ns macro) and load any additional lib resources.

Libspecs

A libspec is a lib name or a vector containing a lib name followed by options expressed as sequential keywords and arguments.

Recognized options: :as takes a symbol as its argument and makes that symbol an alias to the lib's namespace in the current namespace. :refer takes a list of symbols to refer from the namespace or the :all keyword to bring in all public vars.

Prefix Lists

It's common for Clojure code to depend on several libs whose names have the same prefix. When specifying libs, prefix lists can be used to reduce repetition. A prefix list contains the shared prefix followed by libspecs with the shared prefix removed from the lib names. After removing the prefix, the names that remain must not contain any periods.

Flags

A flag is a keyword. Recognized flags: :reload, :reload-all, :verbose :reload forces loading of all the identified libs even if they are already loaded :reload-all implies :reload and also forces loading of all libs that the identified libs directly or indirectly load via require or use :verbose triggers printing information about each load, alias, and refer

Example:

The following would load the libraries clojure.zip and clojure.set abbreviated as 's'.

(require '(clojure zip [set :as s]))

Loads libs, skipping any that are already loaded. Each argument is
either a libspec that identifies a lib, a prefix list that identifies
multiple libs whose names share a common prefix, or a flag that modifies
how all the identified libs are loaded. Use :require in the ns macro
in preference to calling this directly.

Libs

A 'lib' is a named set of resources in classpath whose contents define a
library of Clojure code. Lib names are symbols and each lib is associated
with a Clojure namespace and a Java package that share its name. A lib's
name also locates its root directory within classpath using Java's
package name to classpath-relative path mapping. All resources in a lib
should be contained in the directory structure under its root directory.
All definitions a lib makes should be in its associated namespace.

'require loads a lib by loading its root resource. The root resource path
is derived from the lib name in the following manner:
Consider a lib named by the symbol 'x.y.z; it has the root directory
<classpath>/x/y/, and its root resource is <classpath>/x/y/z.clj, or
<classpath>/x/y/z.cljc if <classpath>/x/y/z.clj does not exist. The
root resource should contain code to create the lib's
namespace (usually by using the ns macro) and load any additional
lib resources.

Libspecs

A libspec is a lib name or a vector containing a lib name followed by
options expressed as sequential keywords and arguments.

Recognized options:
:as takes a symbol as its argument and makes that symbol an alias to the
  lib's namespace in the current namespace.
:refer takes a list of symbols to refer from the namespace or the :all
  keyword to bring in all public vars.

Prefix Lists

It's common for Clojure code to depend on several libs whose names have
the same prefix. When specifying libs, prefix lists can be used to reduce
repetition. A prefix list contains the shared prefix followed by libspecs
with the shared prefix removed from the lib names. After removing the
prefix, the names that remain must not contain any periods.

Flags

A flag is a keyword.
Recognized flags: :reload, :reload-all, :verbose
:reload forces loading of all the identified libs even if they are
  already loaded
:reload-all implies :reload and also forces loading of all libs that the
  identified libs directly or indirectly load via require or use
:verbose triggers printing information about each load, alias, and refer

Example:

The following would load the libraries clojure.zip and clojure.set
abbreviated as 's'.

(require '(clojure zip [set :as s]))
sourceraw docstring

reset!

(reset! atom newval)

Sets the value of atom to newval without regard for the current value. Returns newval.

Sets the value of atom to newval without regard for the
current value. Returns newval.
sourceraw docstring

reset-meta!

(reset-meta! iref metadata-map)

Atomically resets the metadata for a namespace/var/ref/agent/atom

Atomically resets the metadata for a namespace/var/ref/agent/atom
sourceraw docstring

reset-vals!

(reset-vals! atom newval)

Sets the value of atom to newval. Returns [old new], the value of the atom before and after the reset.

Sets the value of atom to newval. Returns [old new], the value of the
atom before and after the reset.
sourceraw docstring

resolve

(resolve sym)
(resolve env sym)

same as (ns-resolve ns symbol) or (ns-resolve ns &env symbol)

same as (ns-resolve *ns* symbol) or (ns-resolve *ns* &env symbol)
sourceraw docstring

rest

(rest coll)

Returns a possibly empty seq of the items after the first. Calls seq on its argument.

Returns a possibly empty seq of the items after the first. Calls seq on its
argument.
sourceraw docstring

restart-agent

(restart-agent a new-state & options)

When an agent is failed, changes the agent state to new-state and then un-fails the agent so that sends are allowed again. If a :clear-actions true option is given, any actions queued on the agent that were being held while it was failed will be discarded, otherwise those held actions will proceed. The new-state must pass the validator if any, or restart will throw an exception and the agent will remain failed with its old state and error. Watchers, if any, will NOT be notified of the new state. Throws an exception if the agent is not failed.

When an agent is failed, changes the agent state to new-state and
then un-fails the agent so that sends are allowed again.  If
a :clear-actions true option is given, any actions queued on the
agent that were being held while it was failed will be discarded,
otherwise those held actions will proceed.  The new-state must pass
the validator if any, or restart will throw an exception and the
agent will remain failed with its old state and error.  Watchers, if
any, will NOT be notified of the new state.  Throws an exception if
the agent is not failed.
sourceraw docstring

resultset-seq

(resultset-seq rs)

Creates and returns a lazy sequence of structmaps corresponding to the rows in the java.sql.ResultSet rs

Creates and returns a lazy sequence of structmaps corresponding to
the rows in the java.sql.ResultSet rs
sourceraw docstring

reverse

(reverse coll)

Returns a seq of the items in coll in reverse order. Not lazy.

Returns a seq of the items in coll in reverse order. Not lazy.
sourceraw docstring

reversible?

(reversible? coll)

Returns true if coll implements Reversible

Returns true if coll implements Reversible
sourceraw docstring

rseq

(rseq rev)

Returns, in constant time, a seq of the items in rev (which can be a vector or sorted-map), in reverse order. If rev is empty returns nil

Returns, in constant time, a seq of the items in rev (which
can be a vector or sorted-map), in reverse order. If rev is empty returns nil
sourceraw docstring

rsubseq

(rsubseq sc test key)
(rsubseq sc start-test start-key end-test end-key)

sc must be a sorted collection, test(s) one of <, <=, > or

=. Returns a reverse seq of those entries with keys ek for which (test (.. sc comparator (compare ek key)) 0) is true

sc must be a sorted collection, test(s) one of <, <=, > or
>=. Returns a reverse seq of those entries with keys ek for
which (test (.. sc comparator (compare ek key)) 0) is true
sourceraw docstring

run!

(run! proc coll)

Runs the supplied procedure (via reduce), for purposes of side effects, on successive items in the collection. Returns nil

Runs the supplied procedure (via reduce), for purposes of side
effects, on successive items in the collection. Returns nil
sourceraw docstring

satisfies?

(satisfies? protocol x)

Returns true if x satisfies the protocol

Returns true if x satisfies the protocol
sourceraw docstring

second

(second x)

Same as (first (next x))

Same as (first (next x))
sourceraw docstring

select-keys

(select-keys map keyseq)

Returns a map containing only those entries in map whose key is in keys

Returns a map containing only those entries in map whose key is in keys
sourceraw docstring

send

(send a f & args)

Dispatch an action to an agent. Returns the agent immediately. Subsequently, in a thread from a thread pool, the state of the agent will be set to the value of:

(apply action-fn state-of-agent args)

Dispatch an action to an agent. Returns the agent immediately.
Subsequently, in a thread from a thread pool, the state of the agent
will be set to the value of:

(apply action-fn state-of-agent args)
sourceraw docstring

send-off

(send-off a f & args)

Dispatch a potentially blocking action to an agent. Returns the agent immediately. Subsequently, in a separate thread, the state of the agent will be set to the value of:

(apply action-fn state-of-agent args)

Dispatch a potentially blocking action to an agent. Returns the
agent immediately. Subsequently, in a separate thread, the state of
the agent will be set to the value of:

(apply action-fn state-of-agent args)
sourceraw docstring

send-via

(send-via executor a f & args)

Dispatch an action to an agent. Returns the agent immediately. Subsequently, in a thread supplied by executor, the state of the agent will be set to the value of:

(apply action-fn state-of-agent args)

Dispatch an action to an agent. Returns the agent immediately.
Subsequently, in a thread supplied by executor, the state of the agent
will be set to the value of:

(apply action-fn state-of-agent args)
sourceraw docstring

seq

(seq coll)

Returns a seq on the collection. If the collection is empty, returns nil. (seq nil) returns nil. seq also works on Strings, native Java arrays (of reference types) and any objects that implement Iterable. Note that seqs cache values, thus seq should not be used on any Iterable whose iterator repeatedly returns the same mutable object.

Returns a seq on the collection. If the collection is
empty, returns nil.  (seq nil) returns nil. seq also works on
Strings, native Java arrays (of reference types) and any objects
that implement Iterable. Note that seqs cache values, thus seq
should not be used on any Iterable whose iterator repeatedly
returns the same mutable object.
sourceraw docstring

seq?

(seq? x)

Return true if x implements ISeq

Return true if x implements ISeq
sourceraw docstring

seqable?

(seqable? x)

Return true if the seq function is supported for x

Return true if the seq function is supported for x
sourceraw docstring

seque

(seque s)
(seque n-or-q s)

Creates a queued seq on another (presumably lazy) seq s. The queued seq will produce a concrete seq in the background, and can get up to n items ahead of the consumer. n-or-q can be an integer n buffer size, or an instance of java.util.concurrent BlockingQueue. Note that reading from a seque can block if the reader gets ahead of the producer.

Creates a queued seq on another (presumably lazy) seq s. The queued
seq will produce a concrete seq in the background, and can get up to
n items ahead of the consumer. n-or-q can be an integer n buffer
size, or an instance of java.util.concurrent BlockingQueue. Note
that reading from a seque can block if the reader gets ahead of the
producer.
sourceraw docstring

sequence

(sequence coll)
(sequence xform coll)
(sequence xform coll & colls)

Coerces coll to a (possibly empty) sequence, if it is not already one. Will not force a lazy seq. (sequence nil) yields (), When a transducer is supplied, returns a lazy sequence of applications of the transform to the items in coll(s), i.e. to the set of first items of each coll, followed by the set of second items in each coll, until any one of the colls is exhausted. Any remaining items in other colls are ignored. The transform should accept number-of-colls arguments

Coerces coll to a (possibly empty) sequence, if it is not already
one. Will not force a lazy seq. (sequence nil) yields (), When a
transducer is supplied, returns a lazy sequence of applications of
the transform to the items in coll(s), i.e. to the set of first
items of each coll, followed by the set of second
items in each coll, until any one of the colls is exhausted.  Any
remaining items in other colls are ignored. The transform should accept
number-of-colls arguments
sourceraw docstring

sequential?

(sequential? coll)

Returns true if coll implements Sequential

Returns true if coll implements Sequential
sourceraw docstring

set

(set coll)

Returns a set of the distinct elements of coll.

Returns a set of the distinct elements of coll.
sourceraw docstring

set-agent-send-executor!

(set-agent-send-executor! executor)

Sets the ExecutorService to be used by send

Sets the ExecutorService to be used by send
sourceraw docstring

set-agent-send-off-executor!

(set-agent-send-off-executor! executor)

Sets the ExecutorService to be used by send-off

Sets the ExecutorService to be used by send-off
sourceraw docstring

set-error-handler!

(set-error-handler! a handler-fn)

Sets the error-handler of agent a to handler-fn. If an action being run by the agent throws an exception or doesn't pass the validator fn, handler-fn will be called with two arguments: the agent and the exception.

Sets the error-handler of agent a to handler-fn.  If an action
being run by the agent throws an exception or doesn't pass the
validator fn, handler-fn will be called with two arguments: the
agent and the exception.
sourceraw docstring

set-error-mode!

(set-error-mode! a mode-keyword)

Sets the error-mode of agent a to mode-keyword, which must be either :fail or :continue. If an action being run by the agent throws an exception or doesn't pass the validator fn, an error-handler may be called (see set-error-handler!), after which, if the mode is :continue, the agent will continue as if neither the action that caused the error nor the error itself ever happened.

If the mode is :fail, the agent will become failed and will stop accepting new 'send' and 'send-off' actions, and any previously queued actions will be held until a 'restart-agent'. Deref will still work, returning the state of the agent before the error.

Sets the error-mode of agent a to mode-keyword, which must be
either :fail or :continue.  If an action being run by the agent
throws an exception or doesn't pass the validator fn, an
error-handler may be called (see set-error-handler!), after which,
if the mode is :continue, the agent will continue as if neither the
action that caused the error nor the error itself ever happened.

If the mode is :fail, the agent will become failed and will stop
accepting new 'send' and 'send-off' actions, and any previously
queued actions will be held until a 'restart-agent'.  Deref will
still work, returning the state of the agent before the error.
sourceraw docstring

set-validator!

(set-validator! iref validator-fn)

Sets the validator-fn for a var/ref/agent/atom. validator-fn must be nil or a side-effect-free fn of one argument, which will be passed the intended new state on any state change. If the new state is unacceptable, the validator-fn should return false or throw an exception. If the current state (root value if var) is not acceptable to the new validator, an exception will be thrown and the validator will not be changed.

Sets the validator-fn for a var/ref/agent/atom. validator-fn must be nil or a
side-effect-free fn of one argument, which will be passed the intended
new state on any state change. If the new state is unacceptable, the
validator-fn should return false or throw an exception. If the current state (root
value if var) is not acceptable to the new validator, an exception
will be thrown and the validator will not be changed.
sourceraw docstring

set?

(set? x)

Returns true if x implements IPersistentSet

Returns true if x implements IPersistentSet
sourceraw docstring

short

(short x)

Coerce to short

Coerce to short
sourceraw docstring

short-array

(short-array size-or-seq)
(short-array size init-val-or-seq)

Creates an array of shorts

Creates an array of shorts
sourceraw docstring

shorts

(shorts xs)

Casts to shorts[]

Casts to shorts[]
sourceraw docstring

shuffle

(shuffle coll)

Return a random permutation of coll

Return a random permutation of coll
sourceraw docstring

shutdown-agents

(shutdown-agents)

Initiates a shutdown of the thread pools that back the agent system. Running actions will complete, but no new actions will be accepted

Initiates a shutdown of the thread pools that back the agent
system. Running actions will complete, but no new actions will be
accepted
sourceraw docstring

simple-ident?

(simple-ident? x)

Return true if x is a symbol or keyword without a namespace

Return true if x is a symbol or keyword without a namespace
sourceraw docstring

simple-keyword?

(simple-keyword? x)

Return true if x is a keyword without a namespace

Return true if x is a keyword without a namespace
sourceraw docstring

simple-symbol?

(simple-symbol? x)

Return true if x is a symbol without a namespace

Return true if x is a symbol without a namespace
sourceraw docstring

slurp

(slurp f & opts)

Opens a reader on f and reads all its contents, returning a string. See clojure.java.io/reader for a complete list of supported arguments.

Opens a reader on f and reads all its contents, returning a string.
See clojure.java.io/reader for a complete list of supported arguments.
sourceraw docstring

some

(some pred coll)

Returns the first logical true value of (pred x) for any x in coll, else nil. One common idiom is to use a set as pred, for example this will return :fred if :fred is in the sequence, otherwise nil: (some #{:fred} coll)

Returns the first logical true value of (pred x) for any x in coll,
else nil.  One common idiom is to use a set as pred, for example
this will return :fred if :fred is in the sequence, otherwise nil:
(some #{:fred} coll)
sourceraw docstring

some->macro

(some-> expr
        &
        forms)

When expr is not nil, threads it into the first form (via ->), and when that result is not nil, through the next etc

When expr is not nil, threads it into the first form (via ->),
and when that result is not nil, through the next etc
sourceraw docstring

some->>macro

(some->> expr
         &
         forms)

When expr is not nil, threads it into the first form (via ->>), and when that result is not nil, through the next etc

When expr is not nil, threads it into the first form (via ->>),
and when that result is not nil, through the next etc
sourceraw docstring

some-fn

(some-fn p)
(some-fn p1 p2)
(some-fn p1 p2 p3)
(some-fn p1 p2 p3 & ps)

Takes a set of predicates and returns a function f that returns the first logical true value returned by one of its composing predicates against any of its arguments, else it returns logical false. Note that f is short-circuiting in that it will stop execution on the first argument that triggers a logical true result against the original predicates.

Takes a set of predicates and returns a function f that returns the first logical true value
returned by one of its composing predicates against any of its arguments, else it returns
logical false. Note that f is short-circuiting in that it will stop execution on the first
argument that triggers a logical true result against the original predicates.
sourceraw docstring

some?

(some? x)

Returns true if x is not nil, false otherwise.

Returns true if x is not nil, false otherwise.
sourceraw docstring

sort

(sort coll)
(sort comp coll)

Returns a sorted sequence of the items in coll. If no comparator is supplied, uses compare. comparator must implement java.util.Comparator. Guaranteed to be stable: equal elements will not be reordered. If coll is a Java array, it will be modified. To avoid this, sort a copy of the array.

Returns a sorted sequence of the items in coll. If no comparator is
supplied, uses compare.  comparator must implement
java.util.Comparator.  Guaranteed to be stable: equal elements will
not be reordered.  If coll is a Java array, it will be modified.  To
avoid this, sort a copy of the array.
sourceraw docstring

sort-by

(sort-by keyfn coll)
(sort-by keyfn comp coll)

Returns a sorted sequence of the items in coll, where the sort order is determined by comparing (keyfn item). If no comparator is supplied, uses compare. comparator must implement java.util.Comparator. Guaranteed to be stable: equal elements will not be reordered. If coll is a Java array, it will be modified. To avoid this, sort a copy of the array.

Returns a sorted sequence of the items in coll, where the sort
order is determined by comparing (keyfn item).  If no comparator is
supplied, uses compare.  comparator must implement
java.util.Comparator.  Guaranteed to be stable: equal elements will
not be reordered.  If coll is a Java array, it will be modified.  To
avoid this, sort a copy of the array.
sourceraw docstring

sorted-map

(sorted-map & keyvals)

keyval => key val Returns a new sorted map with supplied mappings. If any keys are equal, they are handled as if by repeated uses of assoc.

keyval => key val
Returns a new sorted map with supplied mappings.  If any keys are
equal, they are handled as if by repeated uses of assoc.
sourceraw docstring

sorted-map-by

(sorted-map-by comparator & keyvals)

keyval => key val Returns a new sorted map with supplied mappings, using the supplied comparator. If any keys are equal, they are handled as if by repeated uses of assoc.

keyval => key val
Returns a new sorted map with supplied mappings, using the supplied
comparator.  If any keys are equal, they are handled as if by
repeated uses of assoc.
sourceraw docstring

sorted-set

(sorted-set & keys)

Returns a new sorted set with supplied keys. Any equal keys are handled as if by repeated uses of conj.

Returns a new sorted set with supplied keys.  Any equal keys are
handled as if by repeated uses of conj.
sourceraw docstring

sorted-set-by

(sorted-set-by comparator & keys)

Returns a new sorted set with supplied keys, using the supplied comparator. Any equal keys are handled as if by repeated uses of conj.

Returns a new sorted set with supplied keys, using the supplied
comparator.  Any equal keys are handled as if by repeated uses of
conj.
sourceraw docstring

sorted?

(sorted? coll)

Returns true if coll implements Sorted

Returns true if coll implements Sorted
sourceraw docstring

special-symbol?

(special-symbol? s)

Returns true if s names a special form

Returns true if s names a special form
sourceraw docstring

spit

(spit f content & options)

Opposite of slurp. Opens f with writer, writes content, then closes f. Options passed to clojure.java.io/writer.

Opposite of slurp.  Opens f with writer, writes content, then
closes f. Options passed to clojure.java.io/writer.
sourceraw docstring

split-at

(split-at n coll)

Returns a vector of [(take n coll) (drop n coll)]

Returns a vector of [(take n coll) (drop n coll)]
sourceraw docstring

split-with

(split-with pred coll)

Returns a vector of [(take-while pred coll) (drop-while pred coll)]

Returns a vector of [(take-while pred coll) (drop-while pred coll)]
sourceraw docstring

StackTraceElement->vec

(StackTraceElement->vec o)

Constructs a data representation for a StackTraceElement

Constructs a data representation for a StackTraceElement
sourceraw docstring

str

(str)
(str x)
(str x & ys)

With no args, returns the empty string. With one arg x, returns x.toString(). (str nil) returns the empty string. With more than one arg, returns the concatenation of the str values of the args.

With no args, returns the empty string. With one arg x, returns
x.toString().  (str nil) returns the empty string. With more than
one arg, returns the concatenation of the str values of the args.
sourceraw docstring

string?

(string? x)

Return true if x is a String

Return true if x is a String
sourceraw docstring

struct

(struct s & vals)

Returns a new structmap instance with the keys of the structure-basis. vals must be supplied for basis keys in order - where values are not supplied they will default to nil.

Returns a new structmap instance with the keys of the
structure-basis. vals must be supplied for basis keys in order -
where values are not supplied they will default to nil.
sourceraw docstring

struct-map

(struct-map s & inits)

Returns a new structmap instance with the keys of the structure-basis. keyvals may contain all, some or none of the basis keys - where values are not supplied they will default to nil. keyvals can also contain keys not in the basis.

Returns a new structmap instance with the keys of the
structure-basis. keyvals may contain all, some or none of the basis
keys - where values are not supplied they will default to nil.
keyvals can also contain keys not in the basis.
sourceraw docstring

subs

(subs s start)
(subs s start end)

Returns the substring of s beginning at start inclusive, and ending at end (defaults to length of string), exclusive.

Returns the substring of s beginning at start inclusive, and ending
at end (defaults to length of string), exclusive.
sourceraw docstring

subseq

(subseq sc test key)
(subseq sc start-test start-key end-test end-key)

sc must be a sorted collection, test(s) one of <, <=, > or

=. Returns a seq of those entries with keys ek for which (test (.. sc comparator (compare ek key)) 0) is true

sc must be a sorted collection, test(s) one of <, <=, > or
>=. Returns a seq of those entries with keys ek for
which (test (.. sc comparator (compare ek key)) 0) is true
sourceraw docstring

subvec

(subvec v start)
(subvec v start end)

Returns a persistent vector of the items in vector from start (inclusive) to end (exclusive). If end is not supplied, defaults to (count vector). This operation is O(1) and very fast, as the resulting vector shares structure with the original and no trimming is done.

Returns a persistent vector of the items in vector from
start (inclusive) to end (exclusive).  If end is not supplied,
defaults to (count vector). This operation is O(1) and very fast, as
the resulting vector shares structure with the original and no
trimming is done.
sourceraw docstring

supers

(supers class)

Returns the immediate and indirect superclasses and interfaces of c, if any

Returns the immediate and indirect superclasses and interfaces of c, if any
sourceraw docstring

swap!

(swap! atom f)
(swap! atom f x)
(swap! atom f x y)
(swap! atom f x y & args)

Atomically swaps the value of atom to be: (apply f current-value-of-atom args). Note that f may be called multiple times, and thus should be free of side effects. Returns the value that was swapped in.

Atomically swaps the value of atom to be:
(apply f current-value-of-atom args). Note that f may be called
multiple times, and thus should be free of side effects.  Returns
the value that was swapped in.
sourceraw docstring

swap-vals!

(swap-vals! atom f)
(swap-vals! atom f x)
(swap-vals! atom f x y)
(swap-vals! atom f x y & args)

Atomically swaps the value of atom to be: (apply f current-value-of-atom args). Note that f may be called multiple times, and thus should be free of side effects. Returns [old new], the value of the atom before and after the swap.

Atomically swaps the value of atom to be:
(apply f current-value-of-atom args). Note that f may be called
multiple times, and thus should be free of side effects.
Returns [old new], the value of the atom before and after the swap.
sourceraw docstring

symbol

(symbol name)
(symbol ns name)

Returns a Symbol with the given namespace and name.

Returns a Symbol with the given namespace and name.
sourceraw docstring

symbol?

(symbol? x)

Return true if x is a Symbol

Return true if x is a Symbol
sourceraw docstring

syncmacro

(sync flags-ignored-for-now & body)

transaction-flags => TBD, pass nil for now

Runs the exprs (in an implicit do) in a transaction that encompasses exprs and any nested calls. Starts a transaction if none is already running on this thread. Any uncaught exception will abort the transaction and flow out of sync. The exprs may be run more than once, but any effects on Refs will be atomic.

transaction-flags => TBD, pass nil for now

Runs the exprs (in an implicit do) in a transaction that encompasses
exprs and any nested calls.  Starts a transaction if none is already
running on this thread. Any uncaught exception will abort the
transaction and flow out of sync. The exprs may be run more than
once, but any effects on Refs will be atomic.
sourceraw docstring

tagged-literal

(tagged-literal tag form)

Construct a data representation of a tagged literal from a tag symbol and a form.

Construct a data representation of a tagged literal from a
tag symbol and a form.
sourceraw docstring

tagged-literal?

(tagged-literal? value)

Return true if the value is the data representation of a tagged literal

Return true if the value is the data representation of a tagged literal
sourceraw docstring

take

(take n)
(take n coll)

Returns a lazy sequence of the first n items in coll, or all items if there are fewer than n. Returns a stateful transducer when no collection is provided.

Returns a lazy sequence of the first n items in coll, or all items if
there are fewer than n.  Returns a stateful transducer when
no collection is provided.
sourceraw docstring

take-last

(take-last n coll)

Returns a seq of the last n items in coll. Depending on the type of coll may be no better than linear time. For vectors, see also subvec.

Returns a seq of the last n items in coll.  Depending on the type
of coll may be no better than linear time.  For vectors, see also subvec.
sourceraw docstring

take-nth

(take-nth n)
(take-nth n coll)

Returns a lazy seq of every nth item in coll. Returns a stateful transducer when no collection is provided.

Returns a lazy seq of every nth item in coll.  Returns a stateful
transducer when no collection is provided.
sourceraw docstring

take-while

(take-while pred)
(take-while pred coll)

Returns a lazy sequence of successive items from coll while (pred item) returns logical true. pred must be free of side-effects. Returns a transducer when no collection is provided.

Returns a lazy sequence of successive items from coll while
(pred item) returns logical true. pred must be free of side-effects.
Returns a transducer when no collection is provided.
sourceraw docstring

tap>

(tap> x)

sends x to any taps. Will not block. Returns true if there was room in the queue, false if not (dropped).

sends x to any taps. Will not block. Returns true if there was room in the queue,
false if not (dropped).
sourceraw docstring

test

(test v)

test [v] finds fn at key :test in var metadata and calls it, presuming failure will throw exception

test [v] finds fn at key :test in var metadata and calls it,
presuming failure will throw exception
sourceraw docstring

the-ns

(the-ns x)

If passed a namespace, returns it. Else, when passed a symbol, returns the namespace named by it, throwing an exception if not found.

If passed a namespace, returns it. Else, when passed a symbol,
returns the namespace named by it, throwing an exception if not
found.
sourceraw docstring

thread-bound?

(thread-bound? & vars)

Returns true if all of the vars provided as arguments have thread-local bindings. Implies that set!'ing the provided vars will succeed. Returns true if no vars are provided.

Returns true if all of the vars provided as arguments have thread-local bindings.
Implies that set!'ing the provided vars will succeed.  Returns true if no vars are provided.
sourceraw docstring

Throwable->map

(Throwable->map o)

Constructs a data representation for a Throwable.

Constructs a data representation for a Throwable.
sourceraw docstring

timemacro

(time expr)

Evaluates expr and prints the time it took. Returns the value of expr.

Evaluates expr and prints the time it took.  Returns the value of
expr.
sourceraw docstring

to-array

(to-array coll)

Returns an array of Objects containing the contents of coll, which can be any Collection. Maps to java.util.Collection.toArray().

Returns an array of Objects containing the contents of coll, which
can be any Collection.  Maps to java.util.Collection.toArray().
sourceraw docstring

to-array-2d

(to-array-2d coll)

Returns a (potentially-ragged) 2-dimensional array of Objects containing the contents of coll, which can be any Collection of any Collection.

Returns a (potentially-ragged) 2-dimensional array of Objects
containing the contents of coll, which can be any Collection of any
Collection.
sourceraw docstring

trampoline

(trampoline f)
(trampoline f & args)

trampoline can be used to convert algorithms requiring mutual recursion without stack consumption. Calls f with supplied args, if any. If f returns a fn, calls that fn with no arguments, and continues to repeat, until the return value is not a fn, then returns that non-fn value. Note that if you want to return a fn as a final value, you must wrap it in some data structure and unpack it after trampoline returns.

trampoline can be used to convert algorithms requiring mutual
recursion without stack consumption. Calls f with supplied args, if
any. If f returns a fn, calls that fn with no arguments, and
continues to repeat, until the return value is not a fn, then
returns that non-fn value. Note that if you want to return a fn as a
final value, you must wrap it in some data structure and unpack it
after trampoline returns.
sourceraw docstring

transduce

(transduce xform f coll)
(transduce xform f init coll)

reduce with a transformation of f (xf). If init is not supplied, (f) will be called to produce it. f should be a reducing step function that accepts both 1 and 2 arguments, if it accepts only 2 you can add the arity-1 with 'completing'. Returns the result of applying (the transformed) xf to init and the first item in coll, then applying xf to that result and the 2nd item, etc. If coll contains no items, returns init and f is not called. Note that certain transforms may inject or skip items.

reduce with a transformation of f (xf). If init is not
supplied, (f) will be called to produce it. f should be a reducing
step function that accepts both 1 and 2 arguments, if it accepts
only 2 you can add the arity-1 with 'completing'. Returns the result
of applying (the transformed) xf to init and the first item in coll,
then applying xf to that result and the 2nd item, etc. If coll
contains no items, returns init and f is not called. Note that
certain transforms may inject or skip items.
sourceraw docstring

transient

(transient coll)

Returns a new, transient version of the collection, in constant time.

Returns a new, transient version of the collection, in constant time.
sourceraw docstring

tree-seq

(tree-seq branch? children root)

Returns a lazy sequence of the nodes in a tree, via a depth-first walk. branch? must be a fn of one arg that returns true if passed a node that can have children (but may not). children must be a fn of one arg that returns a sequence of the children. Will only be called on nodes for which branch? returns true. Root is the root node of the tree.

Returns a lazy sequence of the nodes in a tree, via a depth-first walk.
 branch? must be a fn of one arg that returns true if passed a node
 that can have children (but may not).  children must be a fn of one
 arg that returns a sequence of the children. Will only be called on
 nodes for which branch? returns true. Root is the root node of the
tree.
sourceraw docstring

true?

(true? x)

Returns true if x is the value true, false otherwise.

Returns true if x is the value true, false otherwise.
sourceraw docstring

type

(type x)

Returns the :type metadata of x, or its Class if none

Returns the :type metadata of x, or its Class if none
sourceraw docstring

unchecked-add

(unchecked-add x y)

Returns the sum of x and y, both long. Note - uses a primitive operator subject to overflow.

Returns the sum of x and y, both long.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-add-int

(unchecked-add-int x y)

Returns the sum of x and y, both int. Note - uses a primitive operator subject to overflow.

Returns the sum of x and y, both int.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-byte

(unchecked-byte x)

Coerce to byte. Subject to rounding or truncation.

Coerce to byte. Subject to rounding or truncation.
sourceraw docstring

unchecked-char

(unchecked-char x)

Coerce to char. Subject to rounding or truncation.

Coerce to char. Subject to rounding or truncation.
sourceraw docstring

unchecked-dec

(unchecked-dec x)

Returns a number one less than x, a long. Note - uses a primitive operator subject to overflow.

Returns a number one less than x, a long.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-dec-int

(unchecked-dec-int x)

Returns a number one less than x, an int. Note - uses a primitive operator subject to overflow.

Returns a number one less than x, an int.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-divide-int

(unchecked-divide-int x y)

Returns the division of x by y, both int. Note - uses a primitive operator subject to truncation.

Returns the division of x by y, both int.
Note - uses a primitive operator subject to truncation.
sourceraw docstring

unchecked-double

(unchecked-double x)

Coerce to double. Subject to rounding.

Coerce to double. Subject to rounding.
sourceraw docstring

unchecked-float

(unchecked-float x)

Coerce to float. Subject to rounding.

Coerce to float. Subject to rounding.
sourceraw docstring

unchecked-inc

(unchecked-inc x)

Returns a number one greater than x, a long. Note - uses a primitive operator subject to overflow.

Returns a number one greater than x, a long.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-inc-int

(unchecked-inc-int x)

Returns a number one greater than x, an int. Note - uses a primitive operator subject to overflow.

Returns a number one greater than x, an int.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-int

(unchecked-int x)

Coerce to int. Subject to rounding or truncation.

Coerce to int. Subject to rounding or truncation.
sourceraw docstring

unchecked-long

(unchecked-long x)

Coerce to long. Subject to rounding or truncation.

Coerce to long. Subject to rounding or truncation.
sourceraw docstring

unchecked-multiply

(unchecked-multiply x y)

Returns the product of x and y, both long. Note - uses a primitive operator subject to overflow.

Returns the product of x and y, both long.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-multiply-int

(unchecked-multiply-int x y)

Returns the product of x and y, both int. Note - uses a primitive operator subject to overflow.

Returns the product of x and y, both int.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-negate

(unchecked-negate x)

Returns the negation of x, a long. Note - uses a primitive operator subject to overflow.

Returns the negation of x, a long.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-negate-int

(unchecked-negate-int x)

Returns the negation of x, an int. Note - uses a primitive operator subject to overflow.

Returns the negation of x, an int.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-remainder-int

(unchecked-remainder-int x y)

Returns the remainder of division of x by y, both int. Note - uses a primitive operator subject to truncation.

Returns the remainder of division of x by y, both int.
Note - uses a primitive operator subject to truncation.
sourceraw docstring

unchecked-short

(unchecked-short x)

Coerce to short. Subject to rounding or truncation.

Coerce to short. Subject to rounding or truncation.
sourceraw docstring

unchecked-subtract

(unchecked-subtract x y)

Returns the difference of x and y, both long. Note - uses a primitive operator subject to overflow.

Returns the difference of x and y, both long.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

unchecked-subtract-int

(unchecked-subtract-int x y)

Returns the difference of x and y, both int. Note - uses a primitive operator subject to overflow.

Returns the difference of x and y, both int.
Note - uses a primitive operator subject to overflow.
sourceraw docstring

underive

(underive tag parent)
(underive h tag parent)

Removes a parent/child relationship between parent and tag. h must be a hierarchy obtained from make-hierarchy, if not supplied defaults to, and modifies, the global hierarchy.

Removes a parent/child relationship between parent and
tag. h must be a hierarchy obtained from make-hierarchy, if not
supplied defaults to, and modifies, the global hierarchy.
sourceraw docstring

unquote

source

unquote-splicing

source

unreduced

(unreduced x)

If x is reduced?, returns (deref x), else returns x

If x is reduced?, returns (deref x), else returns x
sourceraw docstring

unsigned-bit-shift-right

(unsigned-bit-shift-right x n)

Bitwise shift right, without sign-extension.

Bitwise shift right, without sign-extension.
sourceraw docstring

update

(update m k f)
(update m k f x)
(update m k f x y)
(update m k f x y z)
(update m k f x y z & more)

'Updates' a value in an associative structure, where k is a key and f is a function that will take the old value and any supplied args and return the new value, and returns a new structure. If the key does not exist, nil is passed as the old value.

'Updates' a value in an associative structure, where k is a
key and f is a function that will take the old value
and any supplied args and return the new value, and returns a new
structure.  If the key does not exist, nil is passed as the old value.
sourceraw docstring

update-in

(update-in m ks f & args)

'Updates' a value in a nested associative structure, where ks is a sequence of keys and f is a function that will take the old value and any supplied args and return the new value, and returns a new nested structure. If any levels do not exist, hash-maps will be created.

'Updates' a value in a nested associative structure, where ks is a
sequence of keys and f is a function that will take the old value
and any supplied args and return the new value, and returns a new
nested structure.  If any levels do not exist, hash-maps will be
created.
sourceraw docstring

update-proxy

(update-proxy proxy mappings)

Takes a proxy instance and a map of strings (which must correspond to methods of the proxy superclass/superinterfaces) to fns (which must take arguments matching the corresponding method, plus an additional (explicit) first arg corresponding to this, and updates (via assoc) the proxy's fn map. nil can be passed instead of a fn, in which case the corresponding method will revert to the default behavior. Note that this function can be used to update the behavior of an existing instance without changing its identity. Returns the proxy.

Takes a proxy instance and a map of strings (which must
correspond to methods of the proxy superclass/superinterfaces) to
fns (which must take arguments matching the corresponding method,
plus an additional (explicit) first arg corresponding to this, and
updates (via assoc) the proxy's fn map. nil can be passed instead of
a fn, in which case the corresponding method will revert to the
default behavior. Note that this function can be used to update the
behavior of an existing instance without changing its identity.
Returns the proxy.
sourceraw docstring

uri?

(uri? x)

Return true if x is a java.net.URI

Return true if x is a java.net.URI
sourceraw docstring

use

(use & args)

Like 'require, but also refers to each lib's namespace using clojure.core/refer. Use :use in the ns macro in preference to calling this directly.

'use accepts additional options in libspecs: :exclude, :only, :rename. The arguments and semantics for :exclude, :only, and :rename are the same as those documented for clojure.core/refer.

Like 'require, but also refers to each lib's namespace using
clojure.core/refer. Use :use in the ns macro in preference to calling
this directly.

'use accepts additional options in libspecs: :exclude, :only, :rename.
The arguments and semantics for :exclude, :only, and :rename are the same
as those documented for clojure.core/refer.
sourceraw docstring

uuid?

(uuid? x)

Return true if x is a java.util.UUID

Return true if x is a java.util.UUID
sourceraw docstring

val

(val e)

Returns the value in the map entry.

Returns the value in the map entry.
sourceraw docstring

vals

(vals map)

Returns a sequence of the map's values, in the same order as (seq map).

Returns a sequence of the map's values, in the same order as (seq map).
sourceraw docstring

var-get

(var-get x)

Gets the value in the var object

Gets the value in the var object
sourceraw docstring

var-set

(var-set x val)

Sets the value in the var object to val. The var must be thread-locally bound.

Sets the value in the var object to val. The var must be
thread-locally bound.
sourceraw docstring

var?

(var? v)

Returns true if v is of type clojure.lang.Var

Returns true if v is of type clojure.lang.Var
sourceraw docstring

vary-meta

(vary-meta obj f & args)

Returns an object of the same type and value as obj, with (apply f (meta obj) args) as its metadata.

Returns an object of the same type and value as obj, with
(apply f (meta obj) args) as its metadata.
sourceraw docstring

vec

(vec coll)

Creates a new vector containing the contents of coll. Java arrays will be aliased and should not be modified.

Creates a new vector containing the contents of coll. Java arrays
will be aliased and should not be modified.
sourceraw docstring

vector

(vector)
(vector a)
(vector a b)
(vector a b c)
(vector a b c d)
(vector a b c d e)
(vector a b c d e f)
(vector a b c d e f & args)

Creates a new vector containing the args.

Creates a new vector containing the args.
sourceraw docstring

vector-of

(vector-of t)
(vector-of t & elements)

Creates a new vector of a single primitive type t, where t is one of :int :long :float :double :byte :short :char or :boolean. The resulting vector complies with the interface of vectors in general, but stores the values unboxed internally.

Optionally takes one or more elements to populate the vector.

Creates a new vector of a single primitive type t, where t is one
of :int :long :float :double :byte :short :char or :boolean. The
resulting vector complies with the interface of vectors in general,
but stores the values unboxed internally.

Optionally takes one or more elements to populate the vector.
sourceraw docstring

vector?

(vector? x)

Return true if x implements IPersistentVector

Return true if x implements IPersistentVector
sourceraw docstring

volatile!

(volatile! val)

Creates and returns a Volatile with an initial value of val.

Creates and returns a Volatile with an initial value of val.
sourceraw docstring

volatile?

(volatile? x)

Returns true if x is a volatile.

Returns true if x is a volatile.
sourceraw docstring

vreset!

(vreset! vol newval)

Sets the value of volatile to newval without regard for the current value. Returns newval.

Sets the value of volatile to newval without regard for the
current value. Returns newval.
sourceraw docstring

vswap!macro

(vswap! vol f & args)

Non-atomically swaps the value of the volatile as if: (apply f current-value-of-vol args). Returns the value that was swapped in.

Non-atomically swaps the value of the volatile as if:
(apply f current-value-of-vol args). Returns the value that
was swapped in.
sourceraw docstring

whenmacro

(when test & body)

Evaluates test. If logical true, evaluates body in an implicit do.

Evaluates test. If logical true, evaluates body in an implicit do.
sourceraw docstring

when-firstmacro

(when-first bindings
            &
            body)

bindings => x xs

Roughly the same as (when (seq xs) (let [x (first xs)] body)) but xs is evaluated only once

bindings => x xs

Roughly the same as (when (seq xs) (let [x (first xs)] body)) but xs is evaluated only once
sourceraw docstring

when-letmacro

(when-let bindings
          &
          body)

bindings => binding-form test

When test is true, evaluates body with binding-form bound to the value of test

bindings => binding-form test

When test is true, evaluates body with binding-form bound to the value of test
sourceraw docstring

when-notmacro

(when-not test & body)

Evaluates test. If logical false, evaluates body in an implicit do.

Evaluates test. If logical false, evaluates body in an implicit do.
sourceraw docstring

when-somemacro

(when-some bindings
           &
           body)

bindings => binding-form test

When test is not nil, evaluates body with binding-form bound to the value of test

bindings => binding-form test

When test is not nil, evaluates body with binding-form bound to the
value of test
sourceraw docstring

whilemacro

(while test & body)

Repeatedly executes body while test expression is true. Presumes some side-effect will cause test to become false/nil. Returns nil

Repeatedly executes body while test expression is true. Presumes
some side-effect will cause test to become false/nil. Returns nil
sourceraw docstring

with-bindingsmacro

(with-bindings binding-map & body)

Takes a map of Var/value pairs. Installs for the given Vars the associated values as thread-local bindings. Then executes body. Pops the installed bindings after body was evaluated. Returns the value of body.

Takes a map of Var/value pairs. Installs for the given Vars the associated
values as thread-local bindings. Then executes body. Pops the installed
bindings after body was evaluated. Returns the value of body.
sourceraw docstring

with-bindings*

(with-bindings* binding-map f & args)

Takes a map of Var/value pairs. Installs for the given Vars the associated values as thread-local bindings. Then calls f with the supplied arguments. Pops the installed bindings after f returned. Returns whatever f returns.

Takes a map of Var/value pairs. Installs for the given Vars the associated
values as thread-local bindings. Then calls f with the supplied arguments.
Pops the installed bindings after f returned. Returns whatever f returns.
sourceraw docstring

with-in-strmacro

(with-in-str s & body)

Evaluates body in a context in which in is bound to a fresh StringReader initialized with the string s.

Evaluates body in a context in which *in* is bound to a fresh
StringReader initialized with the string s.
sourceraw docstring

with-loading-contextmacro

(with-loading-context & body)
source

with-local-varsmacro

(with-local-vars name-vals-vec
                 &
                 body)

varbinding=> symbol init-expr

Executes the exprs in a context in which the symbols are bound to vars with per-thread bindings to the init-exprs. The symbols refer to the var objects themselves, and must be accessed with var-get and var-set

varbinding=> symbol init-expr

Executes the exprs in a context in which the symbols are bound to
vars with per-thread bindings to the init-exprs.  The symbols refer
to the var objects themselves, and must be accessed with var-get and
var-set
sourceraw docstring

with-meta

(with-meta obj m)

Returns an object of the same type and value as obj, with map m as its metadata.

Returns an object of the same type and value as obj, with
map m as its metadata.
sourceraw docstring

with-openmacro

(with-open bindings
           &
           body)

bindings => [name init ...]

Evaluates body in a try expression with names bound to the values of the inits, and a finally clause that calls (.close name) on each name in reverse order.

bindings => [name init ...]

Evaluates body in a try expression with names bound to the values
of the inits, and a finally clause that calls (.close name) on each
name in reverse order.
sourceraw docstring

with-out-strmacro

(with-out-str & body)

Evaluates exprs in a context in which out is bound to a fresh StringWriter. Returns the string created by any nested printing calls.

Evaluates exprs in a context in which *out* is bound to a fresh
StringWriter.  Returns the string created by any nested printing
calls.
sourceraw docstring

with-precisionmacro

(with-precision precision & exprs)

Sets the precision and rounding mode to be used for BigDecimal operations.

Usage: (with-precision 10 (/ 1M 3)) or: (with-precision 10 :rounding HALF_DOWN (/ 1M 3))

The rounding mode is one of CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN, UP, DOWN and UNNECESSARY; it defaults to HALF_UP.

Sets the precision and rounding mode to be used for BigDecimal operations.

Usage: (with-precision 10 (/ 1M 3))
or:    (with-precision 10 :rounding HALF_DOWN (/ 1M 3))

The rounding mode is one of CEILING, FLOOR, HALF_UP, HALF_DOWN,
HALF_EVEN, UP, DOWN and UNNECESSARY; it defaults to HALF_UP.
sourceraw docstring

with-redefsmacro

(with-redefs bindings
             &
             body)

binding => var-symbol temp-value-expr

Temporarily redefines Vars while executing the body. The temp-value-exprs will be evaluated and each resulting value will replace in parallel the root value of its Var. After the body is executed, the root values of all the Vars will be set back to their old values. These temporary changes will be visible in all threads. Useful for mocking out functions during testing.

binding => var-symbol temp-value-expr

Temporarily redefines Vars while executing the body.  The
temp-value-exprs will be evaluated and each resulting value will
replace in parallel the root value of its Var.  After the body is
executed, the root values of all the Vars will be set back to their
old values.  These temporary changes will be visible in all threads.
Useful for mocking out functions during testing.
sourceraw docstring

with-redefs-fn

(with-redefs-fn binding-map func)

Temporarily redefines Vars during a call to func. Each val of binding-map will replace the root value of its key which must be a Var. After func is called with no args, the root values of all the Vars will be set back to their old values. These temporary changes will be visible in all threads. Useful for mocking out functions during testing.

Temporarily redefines Vars during a call to func.  Each val of
binding-map will replace the root value of its key which must be
a Var.  After func is called with no args, the root values of all
the Vars will be set back to their old values.  These temporary
changes will be visible in all threads.  Useful for mocking out
functions during testing.
sourceraw docstring

xml-seq

(xml-seq root)

A tree seq on the xml elements as per xml/parse

A tree seq on the xml elements as per xml/parse
sourceraw docstring

zero?

(zero? num)

Returns true if num is zero, else false

Returns true if num is zero, else false
sourceraw docstring

zipmap

(zipmap keys vals)

Returns a map with the keys mapped to the corresponding vals.

Returns a map with the keys mapped to the corresponding vals.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close