tupelo.core — tupelo 0.9.111

Tupelo - Making Clojure even sweeter

*lazy-gen-buffer-size* clj

Default output buffer size for lazy-gen.

*spy-enabled* clj/s

*spy-enabled-map* clj/s

->sorted-map clj/s

(->sorted-map map-in)

Inputs: [map-in :- tsk/Map] Returns: tsk/Map

Coerces a map into a sorted-map

->vector clj/s≠

clj

(->vector & args)

cljs

(->vector & rest25584)

Inputs: [& args :- [s/Any]] Returns: [s/Any]

Wraps all args in a vector, as with clojure.core/vector. Will (recursively) recognize any embedded calls to (unwrap <vec-or-list>) and insert their elements as with the unquote-spicing operator (~@). Examples:

(->vector 1 2 3 4 5 6 7 8 9)              =>  [1 2 3 4 5 6 7 8 9]
(->vector 1 2 3 (unwrap [4 5 6]) 7 8 9)   =>  [1 2 3 4 5 6 7 8 9] 

all-rel= clj/s

(all-rel= x-vals y-vals & opts)

Applies

append clj/s≠

clj

(append listy & elems)

cljs

(append G__25508 & rest25509)

Inputs: [listy :- tsk/List & elems :- [s/Any]] Returns: tsk/List

Given a sequential object (vector or list), add one or more elements to the end.

chan->lazy-seq clj

(chan->lazy-seq chan)

Accepts a core.async channel and returns the contents as a lazy list.

char->int clj/s

(char->int arg)

Inputs: [arg :- s/Any] Returns: s/Int

Convert a char to an unicode int

char->sym clj/s

(char->sym ch)

chars-thru clj/s

(chars-thru start-char stop-char)

Given two characters (or numerical equivalents), returns a seq of characters (inclusive) from the first to the second. Characters must be in ascending order.

check-spy-enabled clj/s≠ macro

clj

(check-spy-enabled tag & forms)

cljs

(check-spy-enabled &form &env tag & forms)

clip-str clj/s

(clip-str nchars & args)

Converts all args to single string and clips any characters beyond nchars.

cljs-env? clj/s

(cljs-env? env)

Take the &env from a macro, and tell whether we are expanding into cljs.

cond-it-> clj/s≠ macro

clj

(cond-it-> & forms)

cljs

(cond-it-> &form &env & forms)

A threading macro like as-> that always uses the symbol 'it' as the placeholder for the next threaded value:

(let [params {:a 1 :b 1 :c nil :d nil}] (cond-it-> params (:a it) (update it :b inc) (= (:b it) 2) (assoc it :c "here") (:c it) (assoc it :d "again")))

;=> {:a 1, :b 2, :c "here", :d "again"}

cond-it-impl clj/s

(cond-it-impl expr & forms)

contains-elem? clj/s

(contains-elem? coll elem)

Inputs: [coll :- s/Any elem :- s/Any] Returns: s/Bool

For any collection coll & element tgt, returns true if coll contains at least one instance of tgt; otherwise returns false. Note that, for maps, each element is a vector (i.e MapEntry) of the form [key value].

contains-key? clj/s≠

(contains-key? map-or-set elem)

clj

Inputs: [map-or-set :- (s/pred (fn* [p1__14457#] (or (map? p1__14457#) (set? p1__14457#)))) elem :- s/Any] Returns: s/Bool

For any map or set, returns true if elem is a map key or set element, respectively

cljs

Inputs: [map-or-set :- (s/pred (fn* [p1__25287#] (or (map? p1__25287#) (set? p1__25287#)))) elem :- s/Any] Returns: s/Bool

For any map or set, returns true if elem is a map key or set element, respectively

contains-val? clj/s

(contains-val? map elem)

Inputs: [map :- tsk/Map elem :- s/Any] Returns: s/Bool

For any map, returns true if elem is present in the map for at least one key.

destruct clj/s≠ macro

clj

(destruct bindings & forms)

cljs

(destruct &form &env bindings & forms)

Natural destructuring: (let [data {:a 1 :b {:c 3 :d 4}}] ... (destruct [data {:a ? :b {:c ?}}] ... then can use local values a=1, c=3. With vector data: (let [data [1 2 3 4 5]] ... (destruct [data [a b c]] ... then can use local values a=1 b=2 c=3. Can use (restruct), (restruct data), or (restruct-all) to re-structure & return original data shape using current values.

dissoc-in clj/s

(dissoc-in the-map keys-vec)

Inputs: [the-map :- tsk/KeyMap keys-vec :- [s/Keyword]] Returns: s/Any

A sane version of dissoc-in that will not delete intermediate keys. When invoked as (dissoc-in the-map [:k1 :k2 :k3... :kZ]), acts like (clojure.core/update-in the-map [:k1 :k2 :k3...] dissoc :kZ). That is, only the map entry containing the last key :kZ is removed, and all map entries higher than kZ in the hierarchy are unaffected.

drop-at clj/s

(drop-at coll index)

Inputs: [coll :- tsk/List index :- s/Int] Returns: tsk/List

Removes an element from a collection at the specified index.

drop-if clj/s

(drop-if pred coll)

Returns a vector of items in coll for which (pred item) is false (alias for clojure.core/remove)

edn->json clj/s≠

(edn->json arg)

clj

Inputs: [arg] Returns: s/Str

Shortcut to cheshire.core/generate-string

cljs

Inputs: [arg] Returns: s/Str

Convert from edn -> json

ex-msg clj/s

(ex-msg exception)

Returns the message from an exception => (.getMessage exception)

ex-stacktrace clj/s

(ex-stacktrace exception)

Returns the stacktrace from an exception

falsey? clj/s

(falsey? arg)

Returns true if arg is logical false (either nil or false); otherwise returns false. Equivalent to (not (truthy? arg)).

fetch clj/s

(fetch the-map the-key)

Inputs: [the-map :- tsk/Map the-key :- s/Any] Returns: s/Any

A fail-fast version of keyword/map lookup. When invoked as (fetch the-map :the-key), returns the value associated with :the-key as for (clojure.core/get the-map :the-key). Throws an Exception if :the-key is not present in the-map.

fetch-in clj/s

(fetch-in the-map keys-vec)

Inputs: [the-map :- tsk/Map keys-vec :- tsk/Vec] Returns: s/Any

A fail-fast version of clojure.core/get-in. When invoked as (fetch-in the-map keys-vec), returns the value associated with keys-vec as for (clojure.core/get-in the-map keys-vec). Throws an Exception if the path keys-vec is not present in the-map.

fibo-nth clj/s

(fibo-nth N)

Returns the N'th Fibonacci number (zero-based). Note that N=91 corresponds to approx 2^62

fibo-thru clj/s

(fibo-thru limit)

Returns a vector of Fibonacci numbers up to limit (inclusive). Note that a 2^62 corresponds to 91'st Fibonacci number.

fibonacci-seq clj/s

(fibonacci-seq)

A lazy seq of Fibonacci numbers (memoized).

forv clj/s≠ macro

clj

(forv & forms)

cljs

(forv &form &env & forms)

Like clojure.core/for but returns results in a vector. Not lazy.

get-in-strict clj/s

(get-in-strict data path)

glue clj/s

(glue & colls)

Glues together like collections:

(glue [1 2] [3 4] [5 6]) -> [1 2 3 4 5 6] (glue {:a 1} {:b 2} {:c 3}) -> {:a 1 :c 3 :b 2} (glue #{1 2} #{3 4} #{6 5}) -> #{1 2 6 5 3 4} (glue "I" " like " \a " nap!" ) -> "I like a nap!"

If you want to convert to a sorted set or map, just put an empty one first:

(glue (sorted-map) {:a 1} {:b 2} {:c 3}) -> {:a 1 :b 2 :c 3} (glue (sorted-set) #{1 2} #{3 4} #{6 5}) -> #{1 2 3 4 5 6}

If there are duplicate keys when using glue for maps or sets, then "the last one wins":

(glue {:band :VanHalen :singer :Dave} {:singer :Sammy})

glue-rows clj/s

(glue-rows coll-2d)

Convert a vector of vectors (2-dimensional) into a single vector (1-dimensional). Equivalent to (apply glue ...)

grab clj/s

(grab the-key the-map)

Inputs: [the-key :- s/Any the-map :- tsk/Map] Returns: s/Any

A fail-fast version of keyword/map lookup. When invoked as (grab :the-key the-map), returns the value associated with :the-key as for (clojure.core/get the-map :the-key). Throws an Exception if :the-key is not present in the-map.

has-length? clj/s

(has-length? coll n)

Returns true if the collection has the indicated length. Does not hang for infinite sequences.

has-none? clj/s

(has-none? pred coll)

Inputs: [pred :- s/Any coll :- [s/Any]] Returns: s/Bool

For any predicate pred & collection coll, returns false if (pred x) is logical true for at least one x in coll; otherwise returns true. Equivalent to clojure.core/not-any?, but inverse of has-some?.

has-some? clj/s

(has-some? pred coll)

Inputs: [pred :- s/Any coll :- [s/Any]] Returns: s/Bool

For any predicate pred & collection coll, returns true if (pred x) is logical true for at least one x in coll; otherwise returns false. Like clojure.core/some, but returns only true or false.

idx clj/s

(idx coll index-val)

Inputs: [coll :- tsk/List index-val :- s/Int]

Indexes into a vector, allowing negative index values

if-cljs clj/s macro

(if-cljs then else)

Return then if we are generating cljs code and else for Clojure code. https://groups.google.com/d/msg/clojurescript/iBY5HaQda4A/w1lAQi9_AwsJ

if-java-1-7-plus clj/s macro

(if-java-1-7-plus if-form else-form)

If JVM is Java 1.7 or higher, evaluates if-form into code. Otherwise, evaluates else-form.

if-java-1-8-plus clj/s macro

(if-java-1-8-plus if-form else-form)

If JVM is Java 1.8 or higher, evaluates if-form into code. Otherwise, evaluates else-form.

increasing-or-equal? clj/s

(increasing-or-equal? a b)

Inputs: [a :- tsk/List b :- tsk/List] Returns: s/Bool

Returns true iff the vectors are in (strictly) lexicographically increasing-or-equal order [1 2] [1] -> false [1 2] [1 1] -> false [1 2] [1 2] -> true [1 2] [1 2 nil] -> true [1 2] [1 2 3] -> true [1 2] [1 3] -> true [1 2] [2 1] -> true [1 2] [2] -> true

increasing? clj/s

(increasing? a b)

Inputs: [a :- tsk/List b :- tsk/List] Returns: s/Bool

Returns true iff the vectors are in (strictly) lexicographically increasing order [1 2] [1] -> false [1 2] [1 1] -> false [1 2] [1 2] -> false [1 2] [1 2 nil] -> true [1 2] [1 2 3] -> true [1 2] [1 3] -> true [1 2] [2 1] -> true [1 2] [2] -> true

indent-lines-with clj/s

(indent-lines-with indent-str txt)

Inputs: [indent-str :- s/Str txt :- s/Str] Returns: s/Str

Splits out each line of txt using clojure.string/split-lines, then indents each line by prepending it with the supplied string. Joins lines together into a single string result, with each line terminated by a single ewline.

index-using clj/s

(index-using pred coll)

Finds the first index N where (< N (count coll)) such that (pred (drop N coll)) is truthy. Returns nil if no match found.

indexed clj/s

(indexed & colls)

Given one or more collections, returns a sequence of indexed tuples from the collections: (indexed xs ys zs) -> [ [0 x0 y0 z0] [1 x1 y1 z1] [2 x2 y2 z2] ... ]

insert-at clj/s

(insert-at coll index elem)

Inputs: [coll :- tsk/List index :- s/Int elem :- s/Any] Returns: tsk/List

Inserts an element into a collection at the specified index.

int->char clj/s

(int->char arg)

Inputs: [arg :- s/Int] Returns: s/Any

Convert a unicode int to a char

int->kw clj/s

(int->kw arg)

is-clojure-1-7-plus? clj

(is-clojure-1-7-plus?)

is-clojure-1-8-plus? clj

(is-clojure-1-8-plus?)

is-clojure-1-9-plus? clj

(is-clojure-1-9-plus?)

is-java-1-7-plus? clj

(is-java-1-7-plus?)

is-java-1-7? clj

(is-java-1-7?)

is-java-1-8-plus? clj

(is-java-1-8-plus?)

is-java-1-8? clj

(is-java-1-8?)

is-pre-clojure-1-8? clj

(is-pre-clojure-1-8?)

is-pre-clojure-1-9? clj

(is-pre-clojure-1-9?)

it-> clj/s≠ macro

clj

(it-> expr & forms)

cljs

(it-> &form &env expr & forms)

A threading macro like as-> that always uses the symbol 'it' as the placeholder for the next threaded value: (it-> 1 (inc it) (+ it 3) (/ 10 it)) ;=> 2

java-version clj

(java-version)

Inputs: [] Returns: s/Str

java-version-matches? clj

(java-version-matches? version-str)

Inputs: [version-str :- s/Str] Returns: s/Bool

Returns true if Java version exactly matches supplied string.

java-version-min? clj

(java-version-min? version-str)

Inputs: [version-str :- s/Str] Returns: s/Bool

Returns true if Java version is at least as great as supplied string. Sort is by lexicographic (alphabetic) order.

json->edn clj/s≠

(json->edn json-str)

clj

Inputs: [json-str :- s/Str]

Shortcut to cheshire.core/parse-string

cljs

Inputs: [json-str :- s/Str]

Convert from json -> edn

keep-if clj/s

(keep-if pred coll)

Returns a vector of items in coll for which (pred item) is true (alias for clojure.core/filter)

keyvals clj/s

(keyvals m)

Inputs: [m :- tsk/Map] Returns: [s/Any]

For any map m, returns the (alternating) keys & values of m as a vector, suitable for reconstructing m via (apply hash-map (keyvals m)). (keyvals {:a 1 :b 2} => [:a 1 :b 2]

keyvals-seq clj/s≠

clj

(keyvals-seq ctx)

(keyvals-seq the-map the-keys)

cljs

(keyvals-seq G__25689)

(keyvals-seq G__25693 G__25694)

Inputs: ([ctx :- tsk/KeyMap] [the-map :- tsk/KeyMap the-keys :- [s/Any]]) Returns: [s/Any]

For any map m, returns the (alternating) keys & values of m as a vector, suitable for reconstructing m via (apply hash-map (keyvals m)). (keyvals {:a 1 :b 2} => [:a 1 :b 2]

Usage: (keyvals-seq ctx) ctx-default: {:missing-ok false} (keyvals-seq the-map the-keys)

keyvals-seq-impl clj/s

(keyvals-seq-impl ctx)

Inputs: [ctx :- tsk/KeyMap] Returns: [s/Any]

kw->int clj/s

(kw->int arg)

kw->str clj/s

(kw->str arg)

Inputs: [arg :- s/Keyword] Returns: s/Str

Converts a keyword to a string

kw->sym clj/s

(kw->sym arg)

Inputs: [arg :- s/Keyword] Returns: s/Symbol

Converts a keyword to a symbol

lazy-cons clj/s macro

(lazy-cons curr-val recursive-call-form)

The simple way to create a lazy sequence: (defn lazy-next-int [n] (t/lazy-cons n (lazy-next-int (inc n)))) (def all-ints (lazy-next-int 0))

lazy-gen clj/s macro

(lazy-gen & forms)

Creates a 'generator function' that returns a lazy seq of results via yield (a la Python).

let-some clj/s≠ macro

clj

(let-some bindings & forms)

cljs

(let-some &form &env bindings & forms)

Threads forms as with when-some, but allow more than 1 pair of binding forms.

let-spy clj/s≠ macro

clj

(let-spy & exprs)

cljs

(let-spy &form &env & exprs)

An expression (println ...) for use in threading forms (& elsewhere). Evaluates the supplied expressions, printing both the expression and its value to stdout. Returns the value of the last expression.

let-spy-pretty clj/s≠ macro

clj

(let-spy-pretty & exprs)

cljs

(let-spy-pretty &form &env & exprs)

An expression (println ...) for use in threading forms (& elsewhere). Evaluates the supplied expressions, printing both the expression and its value to stdout. Returns the value of the last expression.

lexical-compare clj/s

(lexical-compare a b)

Inputs: [a :- tsk/List b :- tsk/List] Returns: s/Int

Performs a lexical comparison of 2 sequences, sorting as follows: [1] [1 :a] [1 :b] [1 :b 3] [2] [3] [3 :y]

macro? clj

(macro? s)

Returns true if a quoted symbol resolves to a macro. Usage:

(println (macro? 'and)) ;=> true

map-keys clj/s≠

clj

(map-keys map-in tx-fn & tx-args)

cljs

(map-keys G__25737 G__25738 & rest25739)

Inputs: [map-in :- tsk/Map tx-fn :- tsk/Fn & tx-args] Returns: tsk/Map

Transforms each key in a map using the supplied tx-fn:

(t/map-keys {1 :a 2 :b 3 :c} inc) => { 2 :a 3 :b 4 :c} (t/map-keys {1 :a 2 :b 3 :c} {1 101 2 202 3 303}) => {101 :a 202 :b 303 :c}

map-let clj/s≠ macro

clj

(map-let bindings & forms)

cljs

(map-let &form &env bindings & forms)

Usage: (map-let bindings & forms)

Given bindings and forms like (map-let [x xs, y ys, ...] (+ x y)), will iterate over the collections [xs ys ...] assigning successive values of each collection to [x y ...], respectively. The local symbols [x y ...] can then be used in forms to generate the output mapping. Will throw if collections are not all of the same length. Not lazy.

map-let* clj/s≠ macro

clj

(map-let* context bindings & forms)

cljs

(map-let* &form &env context bindings & forms)

Usage: (map-let* ctx bindings & forms)

where ctx is a map with default values: {:strict true :lazy false}

map-vals clj/s≠

clj

(map-vals map-in tx-fn & tx-args)

cljs

(map-vals G__25757 G__25758 & rest25759)

Inputs: [map-in :- tsk/Map tx-fn :- tsk/Fn & tx-args] Returns: tsk/Map

Transforms each value in a map using the supplied tx-fn:

(t/map-vals {:a 1 :b 2 :c 3} inc)                  =>  {:a 2,   :b 3,   :c 4}
(t/map-vals {:a 1 :b 2 :c 3} {1 101 2 202 3 303})  =>  {:a 101, :b 202, :c 303} 

MapKeySpec clj/s

matches? clj/s macro

(matches? pattern & values)

A shortcut to clojure.core.match/match to aid in testing. Returns true if the data value matches the pattern value. Underscores serve as wildcard values. Usage:

(matches? pattern & values)

sample:

(matches? [1 _ 3] [1 2 3] ) ;=> true (matches? {:a _ :b _ :c 3} {:a 1 :b [1 2 3] :c 3} {:a 2 :b 99 :c 3} {:a 3 :b nil :c 3} ) ;=> true

Note that a wildcald can match either a primitive or a composite value.

nl clj/s

(nl)

Abbreviated name for newline

not-empty? clj/s

(not-empty? coll)

Inputs: [coll] Returns: s/Bool

For any collection coll, returns true if coll contains any items; otherwise returns false. Equivalent to (not (empty? coll)).

not-nil? clj/s

(not-nil? arg)

Inputs: [arg :- s/Any] Returns: s/Bool

Returns true if arg is not nil; false otherwise. Equivalent to (not (nil? arg)), or the poorly-named clojure.core/some?

onlies clj/s

(onlies coll)

Given an outer collection of length-1 collections, returns a sequence of the unwrapped values. (onlies [ [1] [2] [3] ]) => [1 2 3] (onlies #{ [1] [2] [3] }) => #{1 2 3}

only clj/s

(only coll)

Ensures that a sequence is of length=1, and returns the only value present. Throws an exception if the length of the sequence is not one. Note that, for a length-1 sequence S, (first S), (last S) and (only S) are equivalent.

only2 clj/s

(only2 coll)

Given a collection like [[5]], returns 5. Equivalent to (only (only coll)).

pair? clj/s

(pair? coll)

Returns true if the collection contains exactly 2 items.

partition-using clj/s

(partition-using pred values)

Inputs: [pred :- s/Any values :- tsk/List]

Partitions a collection into vector of segments based on a predicate with a collection argument. The first segment is initialized by removing the first element from values, with subsequent elements similarly transferred as long as (pred remaining-values) is falsey. When (pred remaining-values) becomes truthy, the algorithm begins building the next segment. Thus, the first partition finds the smallest N (< 0 N) such that (pred (drop N values)) is true, and constructs the segment as (take N values). If pred is never satisified, [values] is returned.

prepend clj/s≠

clj

(prepend & args)

cljs

(prepend & rest25516)

Inputs: [& args] Returns: tsk/List

Given a sequential object (vector or list), add one or more elements to the beginning

prettify clj/s

(prettify coll)

Recursively walks a data structure and returns a prettified version. Converts all lists to vectors. Converts all maps & sets to sorted collections.

pretty clj

(pretty arg)

(pretty arg writer)

Shortcut to clojure.pprint/pprint. Returns it (1st) argument.

pretty-str clj

(pretty-str arg)

Returns a string that is the result of clojure.pprint/pprint

print-versions clj/s

(print-versions)

quad? clj/s

(quad? coll)

Returns true if the collection contains exactly 4 items.

rand-elem clj/s

(rand-elem coll)

Returns a random element from a collection

range-vec clj/s

(range-vec & args)

An eager version clojure.core/range that always returns its result in a vector.

rel= clj/s

(rel= val1 val2 & {:as opts})

Returns true if 2 double-precision numbers are relatively equal, else false. Relative equality is specified as either (1) the N most significant digits are equal, or (2) the absolute difference is less than a tolerance value. Input values are coerced to double before comparison. Example:

(rel= 123450000 123456789 :digits 4 ) ; true (rel= 1 1.001 :tol 0.01) ; true

replace-at clj/s

(replace-at coll index elem)

Inputs: [coll :- tsk/List index :- s/Int elem :- s/Any] Returns: tsk/List

Replaces an element in a collection at the specified index.

restruct clj/s

(restruct & args)

within a (destruct [<data> <shape>] ...) form,(restruct)or(restruct <data>)` causes re-structuring & return of original data shape using current values.

restruct-all clj/s

(restruct-all & args)

within a `(destruct [data-1 <shape-1> data-2 <shape-2] ...) form, causes re-structuring & return of original data shapes using current values as with (vals->map data-1 data-2 ...)

seq->str clj/s

(seq->str seq-in)

Convert a seq into a string (using pr) with a space preceding each value

sequential->idx-map clj/s

(sequential->idx-map data)

Inputs: [data :- [s/Any]] Returns: #:s{Any s/Any}

set-match-ctx? clj/s

(set-match-ctx? ctx-in pattern & values)

set-match-impl clj/s

(set-match-impl ctx pattern data)

set-match? clj/s

(set-match? pattern & values)

single? clj/s

(single? coll)

Returns true if the collection contains a single item.`

some-it-> clj/s≠ macro

clj

(some-it-> expr & forms)

cljs

(some-it-> &form &env expr & forms)

Threads forms as with it->, terminates & returns nil if any expression is nil.

split-match clj/s

(split-match coll tgt)

Splits a collection src by matching with a sub-sequence tgt of length L. Finds the first index N such that (= tgt (->> coll (drop N) (take L))) is true. Returns a length-2 vector of [ (take N coll) (drop N coll) ]. If no match is found, [ coll [] ] is returned.

split-using clj/s

(split-using pred coll)

Splits a collection based on a predicate with a collection argument. Finds the first index N such that (pred (drop N coll)) is true. Returns a length-2 vector of [ (take N coll) (drop N coll) ]. If pred is never satisified, [ coll [] ] is returned.

spy clj/s

(spy value)

(spy arg1 arg2)

A form of (println ...) to ease debugging display of either intermediate values in threading forms or function return values. There are three variants. Usage:

(spy :msg <msg-string>) This variant is intended for use in either thread-first (->) or thread-last (->>) forms. The keyword :msg is used to identify the message string and works equally well for both the -> and ->> operators. Spy prints both <msg-string> and the threading value to stdout, then returns the value for further propogation in the threading form. For example, both of the following: (-> 2 (+ 3) (spy :msg "sum" ) (* 4)) (->> 2 (+ 3) (spy :msg "sum" ) (* 4)) will print 'sum => 5' to stdout.

(spy <msg-string> <value>) This variant is intended for simpler use cases such as function return values. Function return value expressions often invoke other functions and cannot be easily displayed since (println ...) swallows the return value and returns nil itself. Spy will output both <msg-string> and the value, then return the value for use by further processing. For example, the following: (println (* 2 (spy "sum" (+ 3 4)))) will print: sum => 7 14 to stdout.

(spy <value>) This variant is intended for use in very simple situations and is the same as the 2-argument arity where <msg-string> defaults to 'spy'. For example (spy (+ 2 3)) prints 'spy => 5' to stdout.

spy-pretty clj/s≠ macro

clj

(spy-pretty & exprs)

cljs

(spy-pretty &form &env & exprs)

Like spyx-pretty but without printing the original form

spyx clj/s≠ macro

clj

(spyx & exprs)

cljs

(spyx &form &env & exprs)

An expression (println ...) for use in threading forms (& elsewhere). Evaluates the supplied expressions, printing both the expression and its value to stdout. Returns the value of the last expression.

spyx-pretty clj/s≠ macro

clj

(spyx-pretty & exprs)

cljs

(spyx-pretty &form &env & exprs)

Like spyx but with pretty printing (clojure.pprint/pprint)

spyx-proc clj/s

(spyx-proc exprs)

spyxx clj/s macro

(spyxx expr)

An expression (println ...) for use in threading forms (& elsewhere). Evaluates the supplied expression, printing both the expression, its type, and its value to stdout, then returns the value.

starts-with? clj/s

(starts-with? coll tgt-in)

Inputs: [coll tgt-in] Returns: s/Bool

Returns true when the initial elements of coll match those of tgt

str->chars clj/s

(str->chars arg)

Inputs: [arg :- s/Str] Returns: [s/Any]

Converts a string to a vector of chars

str->kw clj/s

(str->kw arg)

Inputs: [arg :- s/Str] Returns: s/Keyword

Converts a string to a keyword

str->sym clj/s

(str->sym arg)

Inputs: [arg :- s/Str] Returns: s/Symbol

Converts a string to a symbol

strcat clj/s

(strcat & args)

Recursively concatenate all arguments into a single string result.

string-increasing-or-equal? clj/s

(string-increasing-or-equal? a b)

Inputs: [a :- s/Str b :- s/Str] Returns: s/Bool

Returns true if a pair of strings are in increasing lexicographic order, or equal.

string-increasing? clj/s

(string-increasing? a b)

Inputs: [a :- s/Str b :- s/Str] Returns: s/Bool

Returns true if a pair of strings are in increasing lexicographic order.

submap-by-keys clj/s≠

clj

(submap-by-keys map-arg keep-keys & opts)

cljs

(submap-by-keys G__25635 G__25636 & rest25637)

Inputs: [map-arg :- tsk/Map keep-keys :- (s/either tsk/Set tsk/List) & opts] Returns: tsk/Map

Returns a new map containing entries with the specified keys. Throws for missing keys, unless :missing-ok is specified. Usage:

(submap-by-keys {:a 1 :b 2} #{:a   }             )  =>  {:a 1}
(submap-by-keys {:a 1 :b 2} #{:a :z} :missing-ok )  =>  {:a 1}

submap-by-vals clj/s≠

clj

(submap-by-vals map-arg keep-vals & opts)

cljs

(submap-by-vals G__25655 G__25656 & rest25657)

Inputs: [map-arg :- tsk/Map keep-vals :- (s/either tsk/Set tsk/List) & opts] Returns: tsk/Map

Returns a new map containing entries with the specified vals. Throws for missing vals, unless :missing-ok is specified. Usage:

(submap-by-vals {:a 1 :b 2 :A 1} #{1  }             )  =>  {:a 1 :A 1}
(submap-by-vals {:a 1 :b 2 :A 1} #{1 9} :missing-ok )  =>  {:a 1 :A 1} 

submap? clj/s

(submap? inner-map outer-map)

Inputs: [inner-map :- #:s{Any s/Any} outer-map :- #:s{Any s/Any}] Returns: s/Bool

Returns true if the map entries (key-value pairs) of one map are a subset of the entries of another map. Similar to clojure.set/subset?

submatch? clj/s

(submatch? smaller larger)

Returns true if the first arg is (recursively) a subset/submap/subvec of the 2nd arg

swap-out! clj/s

(swap-out! tgt-atom swap-fn & args)

Just like clojure.core/swap!, but returns the old value

sym->kw clj/s

(sym->kw arg)

Inputs: [arg :- s/Symbol] Returns: s/Keyword

Converts a symbol to a keyword

sym->str clj/s

(sym->str arg)

Inputs: [arg :- s/Symbol] Returns: s/Str

Converts a symbol to a string

thru clj/s

(thru end)

(thru start end)

(thru start end step)

Returns a sequence of integers. Like clojure.core/rng, but is inclusive of the right boundary value. Not lazy.

triple? clj/s

(triple? coll)

Returns true if the collection contains exactly 3 items.

truthy? clj/s

(truthy? arg)

Returns true if arg is logical true (neither nil nor false); otherwise returns false.

try-catchall clj/s≠ macro

clj

(try-catchall & body)

cljs

(try-catchall &form &env & body)

A cross-platform variant of try-catch that catches all exceptions. Does not (yet) support finally, and does not need or want an exception class.

unlazy clj/s

(unlazy coll)

Converts a lazy collection to a concrete (eager) collection of the same type.

unnest clj/s≠

clj

(unnest & values)

cljs

(unnest & rest25590)

Inputs: [& values] Returns: [s/Any]

Given any set of arguments including vectors, maps, sets, & scalars, performs a depth-first recursive walk returning scalar args (int, string, keyword, etc) in a single 1-D vector.

unwrap clj/s

(unwrap data)

Inputs: [data :- [s/Any]] Returns: Unwrapped

Works with the ->vector function to unwrap vectors/lists to insert their elements as with the unquote-spicing operator (~@). Examples:

(->vector 1 2 3 4 5 6 7 8 9)              =>  [1 2 3 4 5 6 7 8 9]
(->vector 1 2 3 (unwrap [4 5 6]) 7 8 9)   =>  [1 2 3 4 5 6 7 8 9] 

Unwrapped cljs

val= clj/s≠

clj

(val= & vals)

cljs

(val= & rest25803)

Inputs: [& vals] Returns: s/Bool

Compares values for equality using clojure.core/=, treating records as plain map values:

(defrecord SampleRec [a b])
(assert (val= (->SampleRec 1 2) {:a 1 :b 2}))   ; fails for clojure.core/= 

validate clj/s

(validate tst-fn tst-val)

(validate tst-fn tst-val) Used to validate intermediate results. Returns tst-val if the result of (tst-fn tst-val) is truthy. Otherwise, throws ex-info with ex-data {:sample-val sample-val :tst-result tst-result}.

validate-map-keys clj/s

(validate-map-keys tst-map valid-keys)

Inputs: [tst-map :- tsk/Map valid-keys :- MapKeySpec] Returns: s/Any

validate-or-default clj/s

(validate-or-default is-valid? sample-val default-val)

Returns sample-val if (is-valid? sample-val) is truthy; else returns default-val

vals->map clj/s≠ macro

clj

(vals->map & symbols)

cljs

(vals->map &form &env & symbols)

Called with a list of symbols like (vals->map a b c) returns a map like {:a a :b b :c c}.

(let [a 1
      b 2
      c 3]
  (vals->map a b c))  ;=>  {:a 1 :b 2 :c 3} }

See with-map-vals for simple destructuring of such maps.

verify clj/s macro

(verify form)

(verify <some-expr>) Used to verify intermediate results. Returns value of <some-expr> if the result is truthy. Otherwise, throws an Exception.

when-clojure-1-8-plus clj/s macro

(when-clojure-1-8-plus & forms)

Wraps code that should only be included for Clojure 1.8 or higher. Otherwise, code is supressed.

when-clojure-1-9-plus clj/s macro

(when-clojure-1-9-plus & forms)

Wraps code that should only be included for Clojure 1.9 or higher. Otherwise, code is supressed.

when-not-clojure-1-9-plus clj/s macro

(when-not-clojure-1-9-plus & forms)

Wraps code that should only be included for Clojure versions prior to 1.9. Otherwise, code is supressed.

wild-item? clj/s

(wild-item? item)

Inputs: [item :- s/Any] Returns: s/Bool

Returns true if any element in a nested collection is the wildcard :*

wild-match-root? clj/s

(wild-match-root? ctx-in)

wild-match? clj/s multimethod

Returns true if a pattern is matched by one or more values. The special keyword :* (colon-star) in the pattern serves as a wildcard value. Note that a wildcald can match either a primitive or a composite value: Classic usage:

(wild-match? pattern & values)

examples:

(wild-match? {:a :* :b 2} {:a 1 :b 2}) ;=> true

(wild-match? [1 :* 3] [1 2 3] [1 9 3] )) ;=> true

(wild-match? {:a :* :b 2} {:a [1 2 3] :b 2}) ;=> true

wild-match? also accepts a context map; usage:

(wild-match? ctx)

example (default values shown):

(wild-match? { :submap-ok false :subset-ok false :subvec-ok false :wildcard-ok true :pattern <required param> :values [ <patttern-spec>+ ] ; vector of 1 or more required } )

wild-submatch? clj/s

(wild-submatch? pattern & values)

Simple wrapper for wild-match? where all types of sub-matching are enabled.

with-err-str clj/s≠ macro

clj

(with-err-str & body)

cljs

(with-err-str &form &env & body)

Evaluates exprs in a context in which err is bound to a fresh StringWriter. Returns the string created by any nested printing calls.

with-exception-default clj/s≠ macro

clj

(with-exception-default default-val & forms)

cljs

(with-exception-default &form &env default-val & forms)

Evaluates body & returns its result. In the event of an exception, default-val is returned instead of the exception.

with-map-vals clj/s≠ macro

clj

(with-map-vals the-map items-vec & forms)

cljs

(with-map-vals &form &env the-map items-vec & forms)

Given a map like {:a 1 :b 2 :c 3} (such as generated by (vals->map a b c)), performs safe let destructuring using grab like:

(let [some-map {:a 1 :b 2 :c 3} } ] (with-map-vals some-map [a b c] (+ a b c))) ;=> 6

with-map-vals is safe for typos since grab will throw is the requrested map key is not present. See vals->map for simple creation of labelled data maps.

with-nil-default clj/s

(with-nil-default default-val sample-val)

Returns sample-val if not nil; else returns default-val

with-spy-enabled clj/s≠ macro

clj

(with-spy-enabled tag & forms)

cljs

(with-spy-enabled &form &env tag & forms)

with-spy-indent clj/s≠ macro

clj

(with-spy-indent & forms)

cljs

(with-spy-indent &form &env & forms)

Increments indentation level of all spy, spyx, or spyxx expressions within the body.

with-system-err-str clj/s≠ macro

clj

(with-system-err-str & body)

cljs

(with-system-err-str &form &env & body)

Evaluates exprs in a context in which JVM System/err is bound to a fresh PrintStream. Returns the string created by any nested printing calls.

with-system-out-str clj/s≠ macro

clj

(with-system-out-str & body)

cljs

(with-system-out-str &form &env & body)

Evaluates exprs in a context in which JVM System/out is bound to a fresh PrintStream. Returns the string created by any nested printing calls.

xbutlast clj/s

(xbutlast coll)

Inputs: [coll :- [s/Any]] Returns: s/Any

Returns a vector of all but the last value in a list or vector. Throws if empty.

xfirst clj/s

(xfirst coll)

Returns the first value in a list or vector. Throws if empty.

xfourth clj/s

(xfourth coll)

Returns the fourth value in a list or vector. Throws if (< len 4).

xlast clj/s

(xlast coll)

Inputs: [coll :- [s/Any]] Returns: s/Any

Returns the last value in a list or vector. Throws if empty.

xrest clj/s

(xrest coll)

Returns the last value in a list or vector. Throws if empty.

xreverse clj/s

(xreverse coll)

Returns a vector containing a sequence in reversed order. Throws if nil.

xsecond clj/s

(xsecond coll)

Returns the second value in a list or vector. Throws if (< len 2).

xtake clj/s

(xtake n coll)

Returns the first n values from a collection. Returns map for map colls. Throws if empty.

xthird clj/s

(xthird coll)

Returns the third value in a list or vector. Throws if (< len 3).

xvec clj/s

(xvec coll)

Inputs: [coll :- [s/Any]] Returns: [s/Any]

Converts a collection into a vector. Throws if given nil.

yield clj/s macro

(yield value)

Within a 'generator function' created by lazy-gen, populates the result lazy seq with the supplied value (a la Python). Returns the value.

yield-all clj/s macro

(yield-all values)

Within a 'generator function' created by lazy-gen, populates the result lazy seq with each item from the supplied collection. Returns the collection.

zip clj/s

(zip & args)

Zips together vectors producing a vector of tuples (like Python zip). Not lazy. Example:

(zip [:a :b :c] [1 2 3]) -> [ [:a 1] [:b 2] [:c 3] ]

***** WARNING - will hang for infinite length inputs *****

zip* clj/s

(zip* context & colls)

Usage: (zip* context & colls) where context is a map with default values: {:strict true} Not lazy.

zip-1* clj/s

(zip-1* context & colls)

Usage: (zip* context & colls) where context is a map with default values: {:strict true} Not lazy.

zip-lazy clj/s

(zip-lazy & colls)

Usage: (zip-lazy coll1 coll2 ...) (zip-lazy xs ys zs) -> [ [x0 y0 z0] [x1 y1 z1] [x2 y2 z2] ... ]

Returns a lazy result. Will truncate to the length of the shortest collection. A convenience wrapper for (map vector coll1 coll2 ...).