mikera.vectorz.matrix — net.mikera/vectorz-clj 0.48.0

Clojure API for directly accessing Vectorz matrix functions.

In most cases these are relatively lightweight wrappers over equivalent functions in Vectorz, but specialised with type hints for handling Vectorz matrices 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

(* m a)

Applies a matrix to a vector or matrix, returning a new vector or matrix. If applied to a vector, the vector is transformed. If applied to a matrix, the two matrices are composed

affine-transform? clj

(affine-transform? m)

Returns true if m is a transform (i.e. an instance of mikera.transformz.AAffineTransform)

as-vector clj

(as-vector m)

Returns a vector view over all elements of a matrix (in row major order)

clone clj

(clone v)

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

compose clj

(compose a b)

Composes a transform with another transform

compose! clj

(compose! a b)

Composes a transform with another transform (in-place). Second transform should be square.

constant-transform clj

(constant-transform v & {:keys [input-dimensions]})

Converts a vector to a constant transform

determinant clj

(determinant m)

Gets the determinant of a (square) matrix

diagonal-matrix clj

(diagonal-matrix diagonal-values)

Creates a diagonal matrix, using the sequence of diagonal values provided

fully-mutable? clj

(fully-mutable? m)

Returns true if the matrix is fully mutable

get clj

(get m row column)

Returns the component of a matrix at a specific (row,column) position

get-column clj

(get-column m row)

Gets a column of the matrix as a vector

get-row clj

(get-row m row)

Gets a row of the matrix as a vector

identity-matrix clj

(identity-matrix dimensions)

Returns an immutable identity matrix for the given number of dimensions.

identity? clj

(identity? m)

Returns true if the matrix is an identity matrix

input-dimensions clj

(input-dimensions m)

Gets the number of input dimensions (columns) of a matrix or other transform

inverse clj

(inverse m)

Gets the inverse of a square matrix as a new matrix.

matrix clj

(matrix rows)

Creates a new, mutable matrix using the specified data, which should be a sequence of row vectors

matrix? clj

(matrix? m)

Returns true if m is a Vectorz matrix (i.e. an instance of mikera.matrixx.AMatrix)

new-matrix clj

(new-matrix row-count column-count)

Creates a new, mutable, zero-filled matrix with the given number of rows and columns

output-dimensions clj

(output-dimensions m)

Gets the number of output dimensions (rows) of a matrix or other transform

scalar-matrix clj

(scalar-matrix dimensions factor)

Creates a diagonal scalar matrix (multiplies all components by same factor)

scale clj

(scale m factor)

Scales a matrix by a scalar factor

scale-matrix clj

(scale-matrix scale-factors)

(scale-matrix dimensions factor)

Creates a diagonal scaling matrix

set clj

(set m row column value)

Sets the component of a matrix at a (row,column) position (mutates in place)

square? clj

(square? m)

Returns true if the matrix is a square matrix

to-transform clj

(to-transform a)

Coerces a matrix or transform to an ATransform instance

transform clj

(transform m a)

Applies a matrix transform to a vector, returning a new vector

transform! clj

(transform! m a)

Applies a matrix transform to a vector, modifying the vector in place

transform-normal clj

(transform-normal m src dest)

Applies a an affine transform to a normal vector, storing the result in dest

transform? clj

(transform? m)

Returns true if m is a transform (i.e. an instance of mikera.transformz.ATransform)

transpose clj

(transpose m)

Gets the transpose of a matrix as a transposed reference to the original matrix

transpose! clj

(transpose! m)

Transposes a matrix in place, if possible

x-axis-rotation-matrix clj

(x-axis-rotation-matrix angle)

Creates a rotation matrix with the given number of radians around the x axis

y-axis-rotation-matrix clj

(y-axis-rotation-matrix angle)

Creates a rotation matrix with the given number of radians around the y axis

z-axis-rotation-matrix clj

(z-axis-rotation-matrix angle)

Creates a rotation matrix with the given number of radians around the z axis

zero? clj

(zero? m)

Returns true if the matrix is a zero-filled matrix (i.e. maps every vector to zero)