fastmath.vector — generateme/fastmath 1.4.0-SNAPSHOT

Mathematical vector operations.

Types

• Fixed size (custom types):
  • Number - 1d vector
  • Vec2 - 2d vector, creator vec2
  • Vec3 - 3d vector, creator vec3
  • Vec4 - 4d vector, creator vec4
  • ArrayVec - fixed size double array wrapper, n-dimensional, creator array-vec
• Fixed size
  • doubles - double array itself
• Variable size:
  • Clojure's IPersistentVector, creator []
  • Clojure's ISeq

VectorProto defines most of the functions.

Vectors implements also:

• Sequable
• Sequencial
• IFn
• Counted
• Reversible
• Indexed
• ILookup
• equals and toString from Object
• IPersistentVector
• Associative
• clojure.core.matrix.protocols

That means that vectors can be destructured, treated as sequence or called as a function. See vec2 for examples.

acos clj

(acos vector)

Apply acos to vector elements.

acosh clj

(acosh vector)

Apply acosh to vector elements.

acot clj

(acot vector)

Apply acot to vector elements.

acoth clj

(acoth vector)

Apply acoth to vector elements.

acsc clj

(acsc vector)

Apply acsc to vector elements.

aligned? clj

(aligned? v1 v2)

Are vectors aligned (have the same direction)?

angle-between clj

(angle-between v1 v2)

Angle between two vectors

See also relative-angle-between.

applyf clj deprecated

Same as [[fmap]]. Deprecated.

array->vec2 clj

(array->vec2 a)

Doubles array to Vec2

array->vec3 clj

(array->vec3 a)

Doubles array to Vec3

array->vec4 clj

(array->vec4 a)

Doubles array to Vec4

array-vec clj

(array-vec xs)

Make ArrayVec type based on provided sequence xs.

asec clj

(asec vector)

Apply asec to vector elements.

asech clj

(asech vector)

Apply asech to vector elements.

asin clj

(asin vector)

Apply asin to vector elements.

asinh clj

(asinh vector)

Apply asinh to vector elements.

atan clj

(atan vector)

Apply atan to vector elements.

atanh clj

(atanh vector)

Apply atanh to vector elements.

average-vectors clj

(average-vectors vs)

(average-vectors init vs)

Average / centroid of vectors. Input: initial vector (optional), list of vectors

cbrt clj

(cbrt vector)

Apply cbrt to vector elements.

ceil clj

(ceil vector)

Apply ceil to vector elements.

clamp clj

(clamp v)

(clamp v mn mx)

Clamp elements.

cos clj

(cos vector)

Apply cos to vector elements.

cosh clj

(cosh vector)

Apply cosh to vector elements.

cot clj

(cot vector)

Apply cot to vector elements.

coth clj

(coth vector)

Apply coth to vector elements.

csc clj

(csc vector)

Apply csc to vector elements.

csch clj

(csch vector)

Apply csch to vector elements.

degrees clj

(degrees vector)

Apply degrees to vector elements.

dist clj

(dist v1 v2)

Euclidean distance between vectors

dist-abs clj

(dist-abs v1 v2)

Manhattan distance between vectors

dist-canberra clj

(dist-canberra v1 v2)

Canberra distance

dist-cheb clj

(dist-cheb v1 v2)

Chebyshev distance between 2d vectors

dist-cos clj

(dist-cos v1 v2)

Cosine distance

dist-discrete clj

(dist-discrete v1 v2)

Discrete distance between 2d vectors

dist-emd clj

(dist-emd v1 v2)

Earth Mover's Distance

dist-sq clj

(dist-sq v1 v2)

Squared Euclidean distance between vectors

distances clj

div clj

(div v1)

(div v1 v)

Vector division or reciprocal.

ediv clj

(ediv v1 v2)

Element-wise division of two vectors.

exp clj

(exp vector)

Apply exp to vector elements.

expm1 clj

(expm1 vector)

Apply expm1 to vector elements.

faceforward clj

(faceforward n v)

Flip normal n to match the same direction as v.

floor clj

(floor vector)

Apply floor to vector elements.

frac clj

(frac vector)

Apply frac to vector elements.

generate-vec2 clj

(generate-vec2 f)

(generate-vec2 f1 f2)

Generate Vec2 with fn(s)

generate-vec3 clj

(generate-vec3 f)

(generate-vec3 f1 f2 f3)

Generate Vec3 with fn(s)

generate-vec4 clj

(generate-vec4 f)

(generate-vec4 f1 f2 f3 f4)

Generate Vec4 with fn(s)

limit clj

(limit v len)

Limit length of the vector by given value

ln clj

(ln vector)

Apply ln to vector elements.

log clj

(log vector)

Apply log to vector elements.

log10 clj

(log10 vector)

Apply log10 to vector elements.

log1p clj

(log1p vector)

Apply log1p to vector elements.

log2 clj

(log2 vector)

Apply log2 to vector elements.

make-vector clj

(make-vector dims)

(make-vector dims xs)

Returns fixed size vector for given number of dimensions.

Proper type is used.

nonzero-count clj

(nonzero-count v)

Count non zero velues in vector

normalize clj

(normalize v)

Normalize vector (set length = 1.0)

radians clj

(radians vector)

Apply radians to vector elements.

relative-angle-between clj

(relative-angle-between v1 v2)

Angle between two vectors relative to each other.

See also angle-between.

rint clj

(rint vector)

Apply rint to vector elements.

round clj

(round vector)

Apply round to vector elements.

safe-sqrt clj

(safe-sqrt vector)

Apply safe-sqrt to vector elements.

sec clj

(sec vector)

Apply sec to vector elements.

sech clj

(sech vector)

Apply sech to vector elements.

set-mag clj

(set-mag v len)

Set length of the vector

sfrac clj

(sfrac vector)

Apply sfrac to vector elements.

sgn clj

(sgn vector)

Apply sgn to vector elements.

sigmoid clj

(sigmoid vector)

Apply sigmoid to vector elements.

signum clj

(signum vector)

Apply signum to vector elements.

sin clj

(sin vector)

Apply sin to vector elements.

sinc clj

(sinc vector)

Apply sinc to vector elements.

sinh clj

(sinh vector)

Apply sinh to vector elements.

sq clj

(sq vector)

Apply sq to vector elements.

sqrt clj

(sqrt vector)

Apply sqrt to vector elements.

tan clj

(tan vector)

Apply tan to vector elements.

tanh clj

(tanh vector)

Apply tanh to vector elements.

TOLERANCE clj

Tolerance used in [[is-near-zero?]]. Values less than this value are treated as zero.

trunc clj

(trunc vector)

Apply trunc to vector elements.

vec2 clj

(vec2)

(vec2 x y)

Make 2d vector.

vec3 clj

(vec3)

(vec3 v z)

(vec3 x y z)

Make Vec2 vector

vec4 clj

(vec4)

(vec4 v w)

(vec4 v z w)

(vec4 x y z w)

Make Vec4 vector

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 vector almost zero? (all absolute values of elements are less than TOLERANCE)

heading clj

(heading v1)

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

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), 2d 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)

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.

interpolate clj

(interpolate v1 v2 t)

(interpolate v1 v2 t f)

Interpolate vectors, optionally set interpolation fn

perpendicular clj

(perpendicular v1)

(perpendicular v1 v2)

Perpendicular vector (only 2d).

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)

(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

zero-count clj

(zero-count v)

Count zeros in vector