mikera.vectorz.core — io.github.tonsky/vectorz-clj 0.48.1

Clojure API for directly accessing Vectorz vector functions.

In most cases these are relatively lightweight wrappers over equivalent functions in Vectorz, but specialised with type hints for handling Vectorz vectors for performance purposes.

These are generally equivalent to similar functions in clojure.core.matrix API. If performance is less of a concern, consider using the clojure.core.matrix API directly, which offer more functionality and work with a much broader range of array shapes and argument types.

* clj

(* a)

(* a b)

(* a b & vs)

Multiply one or more vectors, element-wise

+ clj

(+ a)

(+ a b)

(+ a b & vs)

Add one or more vectors, returning a new vector as the result

- clj

(- a)

(- a b)

(- a b & vs)

Substract one or more vectors

abs clj

(abs a)

Computes the absolute value of a vector and returns it

abs! clj

(abs! a)

Computes the absolute value of a vector in place and returns it

add clj

(add dest source)

Add a vector to another

add! clj

(add! dest source)

Add a vector to another (in-place)

add-multiple clj

(add-multiple dest source factor)

Add a vector to another

add-multiple! clj

(add-multiple! dest source factor)

Add a vector to another (in-place)

add-weighted clj

(add-weighted dest source weight)

Create a weighted average of a vector with another. Numerical weight specifies the proportion of the second vector to use

add-weighted! clj

(add-weighted! dest source weight)

Create a weighted average of a vector with another in place. Numerical weight specifies the proportion of the second vector to use

angle clj

(angle a b)

Return the angle between two vectors

approx= clj

(approx= a b)

(approx= a b epsilon)

Returns a boolean indicating whether the two vectors are approximately equal, +/- an optional tolerance

assign! clj

(assign! a new-value)

Fills a vector in place with the value of another vector

clone clj

(clone v)

Creates a (mutable) clone of a vectorz array. May not be exactly the same class as the original array.

create-length clj

(create-length len)

Creates a vector of a specified length. Will use optimised primitive vectors for small lengths

cross-product! clj

(cross-product! a b)

Calculates the cross product of a 3D vector in place

distance clj

(distance a b)

Return the euclidean distance between two vectors

distance-squared clj

(distance-squared a b)

Return the squared euclidean distance between two vectors

div clj

(div dest source)

Divide a vector by another vector or scalar

div! clj

(div! dest source)

Divide a vector by another vector or scalar (in-place)

divide clj

(divide a)

(divide a b)

(divide a b & vs)

Divide one or more vectors, element-wise

dot clj

(dot a b)

Compute the dot product of two vectors

ecount clj

(ecount v)

Returns the number of elements in a vectorz array

empty clj

(empty len)

Creates an empty vector of a specified length. Will use optimised primitive vectors for small lengths

fill clj

(fill a value)

Fills a vector with a specific numerical value

fill! clj

(fill! a value)

Fills a vector in place with a specific numerical value

get clj

(get v index)

DEPRECATED: use mget instead for consistency with core.matrix

Returns the component of a vector at a specific index position

interpolate clj

(interpolate a b position)

join clj

(join a b)

Joins two vectors together. The returned vector is a new reference vector that refers to the originals.

magnitude clj

(magnitude a)

Return the magnitude of a vector (geometric length)

magnitude-squared clj

(magnitude-squared a)

Return the squared magnitude of a vector. Slightly more efficient than getting the magnitude directly.

mget clj

(mget v)

(mget v i)

(mget v i j)

Returns the component of a vector at a specific index position

mset! clj

(mset! v value)

(mset! v i value)

(mset! v i j value)

Sets the component of a vector at position i (mutates in place)

mul clj

(mul dest source)

Multiply a vector with another vector or scalar

mul! clj

(mul! dest source)

Multiply a vector with another vector or scalar (in-place)

negate clj

(negate a)

Negates a vector and returns it

negate! clj

(negate! a)

Negates a vector in place and returns it

normalise clj

(normalise a)

Normalises a vector to unit length and returns it

normalise! clj

(normalise! a)

Normalises a vector in place to unit length and returns it

normalise-get-magnitude! clj

(normalise-get-magnitude! a)

Normalises a vector in place to unit length and returns its magnitude

normalised? clj

(normalised? v)

Returns true if a vector is normalised (has unit length)

of clj

(of & xs)

Creates a vector from its numerical components

PVectorisable clj protocol

to-vector clj

(to-vector a)

scale clj

(scale a factor)

Scales a vector by a scalar numerical factor

scale! clj

(scale! a factor)

Scales a vector in place by a scalar numerical factor

scale-add clj

(scale-add a factor b)

Scales a vector by a scalar numerical factor and adds a second vector

scale-add! clj

(scale-add! a factor b)

Scales a fector in place by a scalar numerical factor and adds a second vector

set clj

(set v index value)

DEPRECATED: use mset! instead for consistency with core.matrix

Sets the component of a vector at position i (mutates in place)

sub clj

(sub dest source)

Subtract a vector from another

sub! clj

(sub! dest source)

Subtract a vector from another (in-place)

subvec clj

(subvec v start end)

Returns a subvector of a vector. The subvector is a reference (i.e can be sed to modify the original vector)

to-array clj

(to-array a)

Converts a vector to a double array

to-list clj

(to-list a)

Converts a vector to a list of doubles

vec clj

(vec coll)

Creates a vector from a collection, a sequence or anything else that implements the PVectorisable protocol

vec1 clj

(vec1)

(vec1 coll)

Creates a Vector1 instance

vec2 clj

(vec2)

(vec2 coll)

(vec2 x y)

Creates a Vector2 instance

vec3 clj

(vec3)

(vec3 coll)

(vec3 x y z)

Creates a Vector3 instance

vec4 clj

(vec4)

(vec4 coll)

(vec4 x y z t)

Creates a Vector4 instance

vec? clj

(vec? v)

Returns true if v is a vectorz vector (i.e. an instance of mikera.vectorz.AVector or a 1-dimensional INDArray)

vector clj

(vector & xs)

Creates a vector from zero or more numerical components.

vectorz? clj

(vectorz? a)

Returns true if v is a vectorz array class (i.e. any instance of mikera.arrayz.INDArray)