core.matrix — mikera/matrix-api 0.0.4

*matrix-implementation* clj

abs clj

(abs m)

abs! clj

(abs! m)

acos clj

(acos m)

acos! clj

(acos! m)

add clj

(add a)

(add a b)

(add a b & more)

Performs matrix addition on two matrices of same size

asin clj

(asin m)

asin! clj

(asin! m)

assign! clj

(assign! m a)

Assigns a value to a matrix. Returns the mutated matrix

atan clj

(atan m)

atan! clj

(atan! m)

cbrt clj

(cbrt m)

cbrt! clj

(cbrt! m)

ceil clj

(ceil m)

ceil! clj

(ceil! m)

clone clj

(clone m)

Constructs a clone of the matrix, using the same implementation. This function is intended to allow safe defensive copying of matrices / vectors.

Guarantees that:

1. Mutating the returned matrix will not modify any other matrix (defensive copy)
2. The return matrix will be mutable, if the implementation supports mutable matrices.

A matrix implementation which only provides immutable matrices may safely return the same matrix.

coerce clj

(coerce m a)

Coerces a parameter to a format usable by a specific matrix implementation

column-count clj

(column-count m)

Returns the number of columns in a matrix (must be 2D or more)

column-matrix? clj

(column-matrix? m)

Returns true if a matrix is a column-matrix (i.e. has exactly one column)

cos clj

(cos m)

cos! clj

(cos! m)

cosh clj

(cosh m)

cosh! clj

(cosh! m)

current-implementation clj

(current-implementation)

Gets the currently active matrix implementation

det clj

(det a)

Calculates the determinant of a matrix

dimension-count clj

(dimension-count m dim)

Returns the size of the specified dimension in a matrix.

dimensionality clj

(dimensionality m)

Returns the dimensionality (number of array dimensions) of a matrix / array

dot clj

(dot a b)

Computes the dot product of two vectors

emap clj

(emap f m)

(emap f m a)

(emap f m a & more)

Element-wise map over all elements of one or more matrices. Returns a new matrix of the same type.

emap! clj

(emap! f m)

(emap! f m a)

(emap! f m a & more)

Element-wise map over all elements of one or more matrices. Performs in-place modification of the first matrix argument.

emul clj

(emul a)

(emul a b)

(emul a b & more)

Performs element-wise matrix multiplication. Matrices must be same size.

equals clj

(equals a b)

Returns true if two matrices are numerically equal.

ereduce clj

(ereduce f m)

(ereduce f init m)

Element-wise reduce on all elements of a matrix.

eseq clj

(eseq m)

Returns all elements of a matrix as a sequence in row-major order

exp clj

(exp m)

exp! clj

(exp! m)

floor clj

(floor m)

floor! clj

(floor! m)

get-column clj

(get-column m y)

Gets a column of a 2D matrix

get-row clj

(get-row m x)

Gets a row of a 2D matrix

length clj

(length m)

Calculates the length (magnitude) of a vector

length-squared clj

(length-squared m)

Calculates the squared length (squared magnitude) of a vector

log clj

(log m)

log! clj

(log! m)

log10 clj

(log10 m)

log10! clj

(log10! m)

matrix clj

(matrix data)

(matrix implementation data)

Constructs a matrix from the given data.

The data may be in one of the following forms:

• Nested sequences, e.g. Clojure vectors
• A valid existing matrix

If implementation is not specified, uses the current matrix library as specified in matrix-implementation

matrix-1d? clj

(matrix-1d? m)

Returns true if parameter is a 1 dimensional matrix (equivalent to a column vector)

matrix-2d? clj

(matrix-2d? m)

Returns true if parameter is a regular matrix (2 dimensional matrix)

matrix? clj

(matrix? m)

Returns true if parameter is a valid matrix (any dimensionality)

mget clj

(mget m)

(mget m x)

(mget m x y)

(mget m x y & more)

Gets a scalar value from a matrix at a specified position. Supports any number of matrix dimensions.

mset! clj

(mset! m v)

(mset! m x v)

(mset! m x y v)

(mset! m x y z & more)

Sets a scalar value in a matrix at a specified position. Supports any number of matrix dimensions. Will throw an error if the matrix is not mutable.

mul clj

(mul a)

(mul a b)

(mul a b & more)

Performs matrix multiplication with matrices, vectors or scalars

mutable? clj

(mutable? m)

Returns true if the matrix is mutable, i.e. supports setting of values

new-matrix clj

(new-matrix rows columns)

(new-matrix dim-1 dim-2 & more-dim)

Constructs a new zero-filled matrix with the given dimensions

new-vector clj

(new-vector length)

(new-vector length implementation)

Constructs a new zero-filled vector with the given length

normalise clj

(normalise m)

Normalises a matrix (scales to unit length)

round clj

(round m)

round! clj

(round! m)

row-count clj

(row-count m)

Returns the number of rows in a matrix (must be 1D or more)

row-matrix? clj

(row-matrix? m)

Returns true if a matrix is a row-matrix (i.e. has exactly one row)

scalar? clj

(scalar? m)

Returns true if the parameter is a scalar (zero dimensionality, acceptable as matrix value).

scale clj

(scale m factor)

Scales a matrix by a scalar factor

set-current-implementation clj

(set-current-implementation m)

Sets the currently active matrix implementation

shape clj

(shape m)

Returns the shape of a matrix, i.e. the dimension sizes for all dimensions.

Result may be a sequence or Java array, to allow implemenations flexibility to return their own internal representation of matrix shape.

You are guaranteed however that you can call seq on this to get a sequence of dimension sizes.

signum clj

(signum m)

signum! clj

(signum! m)

sin clj

(sin m)

sin! clj

(sin! m)

sinh clj

(sinh m)

sinh! clj

(sinh! m)

slice clj

(slice m dimension index)

Gets a view of a slice of a matrix along a specific dimension. The returned matrix will have one less dimension. Slicing a 1D vector will return a scalar.

Slicing on the first dimension (dimension 0) is likely to perform better for many matrix implementations.

slices clj

(slices m)

(slices m dimension)

Gets a lazy sequence of slices of a matrix. If dimension is supplied, slices along a given dimension, otherwise slices along the first dimension.

sqrt clj

(sqrt m)

sqrt! clj

(sqrt! m)

square? clj

(square? m)

Returns true if matrix is square (2D with same number of rows and columns)

sub clj

(sub a)

(sub a b)

(sub a b & more)

Performs matrix subtraction on two matrices of same size

sub-matrix clj

(sub-matrix m index-ranges)

Gets a view of a submatrix, for a set of index-ranges. Index ranges should be [start, length] pairs. Index ranges can be nil (gets the whole range)

sub-vector clj

(sub-vector m start length)

Gets a view of part of a vector. The view maintains a reference to the original, so can be used to modify the original vector if it is mutable.

supports-dimensionality? clj

(supports-dimensionality? m dimension-count)

Returns true if the implementation for a given matrix supports a specific dimensionality, i.e. can create an manipulate matrices with the given number of dimensions

tan clj

(tan m)

tan! clj

(tan! m)

tanh clj

(tanh m)

tanh! clj

(tanh! m)

to-degrees clj

(to-degrees m)

to-degrees! clj

(to-degrees! m)

to-nested-vectors clj

(to-nested-vectors m)

Converts a matrix to nested vectors

to-radians clj

(to-radians m)

to-radians! clj

(to-radians! m)

trace clj

(trace a)

Calculates the trace of a matrix (sum of elements on main diagonal)

transform clj

(transform m v)

Transforms a given vector, returning a new vector

transform! clj

(transform! m v)

Transforms a given vector in place

vec? clj

(vec? m)

Returns true if the parameter is a vector