fastmath.protocols — generateme/fastmath 3.0.0-alpha2

Set of protocols for fastmath.

Includes:

• random generator protocol
• distribution protocols
• vector protocol

DistributionIdProto clj protocol

Get name and parameter names from distribution

distribution-id clj

(distribution-id d)

Distribution id as keyword

distribution-parameters clj

(distribution-parameters d)

List of distribution parameter names

distribution? clj

(distribution? d)

Returns true if the object is distribution

DistributionProto clj protocol

Get information from distributions.

lpdf clj

(lpdf d v)

Log density

icdf clj

(icdf d p)

Inverse cumulative probability

cdf clj

(cdf d v)

(cdf d v1 v2)

Cumulative probability.

pdf clj

(pdf d v)

Density

probability clj

(probability d v)

Probability (PMF)

continuous? clj

(continuous? d)

Does distribution support continuous range?

source-object clj

(source-object d)

Returns Java object from backend library

dimensions clj

(dimensions d)

Returns dimensions

sample clj

(sample d)

Returns random sample.

GridProto clj protocol

Common grid conversion functions.

cell->anchor clj

(cell->anchor g cell)

(cell->anchor g q r)

Converts cell coordinates to anchor coordinates.

cell->mid clj

(cell->mid g cell)

(cell->mid g q r)

Converts cell coordinates to cell midpoint

coords->cell clj

(coords->cell g coords)

(coords->cell g x y)

Converts 2d space coordinates to cell coordinates.

coords->mid clj

(coords->mid g coords)

(coords->mid g x y)

Converts 2d space into cell midpoint.

corners clj

(corners g coords)

(corners g coords scale)

(corners g x y scale)

Returns list of cell vertices for given 2d space coordinates.

grid-type clj

(grid-type g)

Returns type of the cell.

MultivariateDistributionProto clj protocol

Get information from distributions.

covariance clj

(covariance d)

Variance

means clj

(means d)

Mean

PredictProto clj protocol

Prediction API

predict clj

(predict obj xs)

(predict obj xs info?)

Predict value from the model

RNGProto clj protocol

Defines set of random functions for different RNGs or distributions returning primitive values.

brandom clj

(brandom rng)

(brandom rng p)

Boolean random.

Returns true or false with equal probability. You can set p probability for true

grandom clj

(grandom rng)

(grandom rng std)

(grandom rng mean std)

Random double from gaussian distribution.

As default returns random double from N(0,1). When std is passed, N(0,std) is used. When mean is passed, distribution is set to N(mean, std).

->seq clj

(->seq rng)

(->seq rng n)

Returns lazy sequence of random samples (can be limited to optional n values).

lrandom clj

(lrandom rng)

(lrandom rng mx)

(lrandom rng mn mx)

Random long.

As default returns random long from full long range. When mx is passed, range is set to [0, mx). When mn is passed, range is set to [mn, mx).

frandom clj

(frandom rng)

(frandom rng mx)

(frandom rng mn mx)

Random float.

As default returns random float from [0,1) range. When mx is passed, range is set to [0, mx). When mn is passed, range is set to [mn, mx).

set-seed clj

(set-seed rng v)

Sets seed. Returns new rng object

irandom clj

(irandom rng)

(irandom rng mx)

(irandom rng mn mx)

Random integer.

As default returns random integer from full integer range. When mx is passed, range is set to [0, mx). When mn is passed, range is set to [mn, mx).

set-seed! clj

(set-seed! rng v)

Sets seed. Returns rng

drandom clj

(drandom rng)

(drandom rng mx)

(drandom rng mn mx)

Random double.

As default returns random double from [0,1) range. When mx is passed, range is set to [0, mx). When mn is passed, range is set to [mn, mx).

TransformProto clj protocol

Transformer functions.

forward-1d clj

(forward-1d t xs)

Forward transform of sequence or array.

forward-2d clj

(forward-2d t xss)

Forward transform of sequence of sequences.

reverse-1d clj

(reverse-1d t xs)

Reverse transform of sequence or array.

reverse-2d clj

(reverse-2d t xss)

Reverse transform of sequence of sequences.

UnivariateDistributionProto clj protocol

lower-bound clj

(lower-bound d)

Lower value

mean clj

(mean d)

Mean

upper-bound clj

(upper-bound d)

Higher value

variance clj

(variance d)

Variance

VectorProto clj protocol

Vector operations

to-vec clj

(to-vec v)

Convert to Clojure primitive vector Vec.

dot clj

(dot v1 v2)

Dot product of two vectors.

permute clj

(permute v idxs)

Permute vector elements with given indices.

add clj

(add v1)

(add v1 v2)

Sum of two vectors.

approx clj

(approx v)

(approx v d)

Round to 2 (or d) decimal places

cross clj

(cross v1 v2)

Cross product

reciprocal clj

(reciprocal v)

Reciprocal of elements.

sum clj

(sum v1)

Sum of elements

emn clj

(emn v1 v2)

Element-wise min from two vectors.

is-near-zero? clj

(is-near-zero? v1)

(is-near-zero? v1 tol)

Is vector almost zero? (all absolute values of elements are less than tol tolerance or 1.0e-6)

heading clj

(heading v1)

Angle between vector and unit vector [1,0,...]

shift clj

(shift v1 v)

Add v value to every vector element.

axis-rotate clj

(axis-rotate v1 angle axis)

(axis-rotate v1 angle axis pivot)

Rotate around axis, 3d only

magsq clj

(magsq v1)

Length of the vector squared.

to-polar clj

(to-polar v1)

To polar coordinates (2d, 3d only), first element is length, the rest angle.

transform clj

(transform v1 o vx vy)

(transform v1 o vx vy vz)

Transform vector; map point to coordinate system defined by origin, vx and vy (as bases), d and 3d only.

mag clj

(mag v1)

length of the vector.

from-polar clj

(from-polar v1)

From polar coordinates (2d, 3d only)

sub clj

(sub v1)

(sub v1 v2)

Subtraction of two vectors.

mindim clj

(mindim v)

Index of minimum value.

is-zero? clj

(is-zero? v1)

Is vector zero?

econstrain clj

(econstrain v val1 val2)

Element-wise constrain

base-from clj

(base-from v)

List of perpendicular vectors (basis)

prod clj

(prod v1)

Product of elements

emult clj

(emult v1 v2)

Element-wise vector multiplication (Hadamard product).

maxdim clj

(maxdim v)

Index of maximum value.

emx clj

(emx v1 v2)

Element-wise max from two vectors.

to-acm-vec clj

(to-acm-vec v)

Convert to Apache Commons Math ArrayRealVector

interpolate clj

(interpolate v1 v2 t f)

Interpolate vectors, optionally set interpolation fn

perpendicular clj

(perpendicular v1)

(perpendicular v1 v2)

Perpendicular vector (only 2d).

size clj

(size v)

Length of the vector

as-vec clj

(as-vec v)

(as-vec v xs)

Create vector from sequence as given type.

mn clj

(mn v1)

Minimum value of vector elements

abs clj

(abs v1)

Absolute value of vector elements

einterpolate clj

(einterpolate v1 v2 v f)

Interpolate vectors element-wise, optionally set interpolation fn

mx clj

(mx v1)

Maximum value of vector elements

fmap clj

(fmap v f)

Apply function to all vector values (like map but returns the same type).

mult clj

(mult v1 v)

Multiply vector by number v.

rotate clj

(rotate v1 angle)

(rotate v1 anglex angley anglez)

Rotate vector

to-double-array clj

(to-double-array v)

Convert o double array