emmy.value — org.mentat/emmy 0.31.0

The home of most of the protocol-based extensible generic operations offered by Emmy. The bulk of the others live in emmy.generic.

See the Generics cljdocs for a detailed discussion of how to use and extend the generic operations defined in emmy.generic and emmy.value.

= clj/s multimethod

add-object-symbols! clj/s

(add-object-symbols! o->syms)

almost-integral? clj/s

(almost-integral? x)

Returns true if x is either:

• integral?,
• a floating point number either < [[absolute-integer-tolerance]] (if near zero) or within [[relative-integer-tolerance]] of the closest integer,

false otherwise.

argument-kind clj/s

(argument-kind & args)

compare clj/s≠

(compare x y)

clj

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

cljs

Comparator. Clone of [[cljs.core/compare]] that works with the expanded Emmy numeric tower.

Returns a negative number, zero, or a positive number when x is logically 'less than', 'equal to', or 'greater than' y. Uses IComparable if available and google.array.defaultCompare for objects of the same type and special-cases nil to be less than any other object.

exact-zero? clj/s

(exact-zero? n)

Returns true if the supplied argument is an exact numerical zero, false otherwise.

integral? clj/s

(integral? x)

Returns true if x is an integral number, false otherwise.

kind-predicate clj/s

(kind-predicate x)

Returns a predicate that returns true if its argument matches the supplied kind-keyword k, false otherwise.

machine-epsilon clj/s

make-es6-callable cljs

(make-es6-callable s k)

Make s callable. This is done by re-hosting all of the object properties of s in a new native JS function which delegates to the Clojure application. The result of the application of this new function is supplied to the continuation k.

native-integral? clj/s

(native-integral? x)

Returns true if x is an integral number that Clojure's math operations work with, false otherwise.

number? clj/s

(number? x)

Returns true if x is any number type in the numeric tower:

• integral
• floating point
• complex

false otherwise.

numeric-zero? clj/s

(numeric-zero? x)

Returns true if x is both a number? and [[zero?]], false otherwise.

Numerical clj/s protocol

numerical? clj/s

(numerical? _)

object-name-map clj/s

principal-value clj/s

(principal-value cuthigh)

real? clj/s

(real? x)

Returns true if x is either an integral number or a floating point number (i.e., in the numeric tower but not complex), false otherwise.

scalar? clj/s

(scalar? x)

Returns true for anything that derives from ::scalar, i.e., any numeric type in the numeric tower that responds true to number?, plus symbolic expressions generated by emmy.abstract.number/literal-number,

false otherwise.

seqtype clj/s

set-js-meta! cljs

(set-js-meta! o m)

Mutates the native JS object o to have the given metadata. The previous metadata, if any, is discarded. o is returned.

sqrt-machine-epsilon clj/s

twopi clj/s

Value clj/s protocol

zero-like clj/s

(zero-like this)

identity? clj/s

(identity? this)

freeze clj/s

(freeze this)

Freezing an expression means removing wrappers and other metadata from subexpressions, so that the result is basically a pure S-expression with the same structure as the input. Doing this will rob an expression of useful information for further computation; so this is intended to be done just before simplification and printing, to simplify those processes.

zero? clj/s

(zero? this)

one? clj/s

(one? this)

exact? clj/s

(exact? this)

Entries that are exact are available for gcd, among other operations.

kind clj/s

(kind this)

identity-like clj/s

(identity-like this)

one-like clj/s

(one-like this)

within clj/s

(within ε)

Returns a function that tests whether two values are within ε of each other.