core.matrix.protocols — mikera/matrix-api 0.0.4

PAssignment clj protocol

Protocol for assigning values to mutable matrices.

assign! clj

(assign! m source)

Sets all the values in a matrix from a matrix source

assign-array! clj

(assign-array! m arr)

Sets all the values in a matrix from a Java array, in row-major order

PCoercion clj protocol

Protocol to coerce a parameter to a format usable by a specific implementation. It is up to the implementation to determine what parameter types they support. If the implementation is unable to perform coercion, it may return nil.

coerce-param clj

(coerce-param m param)

Attempts to coerce param into a matrix format supported by the implementation of matrix m. May return nil if unable to do so, in which case a default implementation can be used.

PConversion clj protocol

Protocol to allow conversion to Clojure-friendly vector format. Optional for implementers.

convert-to-nested-vectors clj

(convert-to-nested-vectors m)

PDimensionInfo clj protocol

Protocol to return standard dimension information about a matrix. dimensionality and dimension-count are mandatory for implementations

dimension-count clj

(dimension-count m dimension-number)

Returns the size of a specific dimension

dimensionality clj

(dimensionality m)

Returns the number of dimensions of a matrix

get-shape clj

(get-shape m)

Returns the shape of the matrix, as an array or sequence of dimension sizes

is-scalar? clj

(is-scalar? m)

Tests whether an object is a scalar value

is-vector? clj

(is-vector? m)

Tests whether an object is a vector (1D matrix)

PFunctionalOperations clj protocol

Protocol to allow functional-style operations on matrix elements.

element-map clj

(element-map m f)

(element-map m f a)

(element-map m f a more)

element-map! clj

(element-map! m f)

(element-map! m f a)

(element-map! m f a more)

element-reduce clj

(element-reduce m f)

(element-reduce m f init)

element-seq clj

(element-seq m)

PImplementation clj protocol

Protocol for general implementation functionality

construct-matrix clj

(construct-matrix m data)

Returns a new matrix containing the given data. Data should be in the form of either nested sequences or a valid existing matrix

implementation-key clj

(implementation-key m)

Returns a keyword representing this implementation. Each implementation should have one unique key.

new-matrix clj

(new-matrix m rows columns)

Returns a new matrix (regular 2D matrix) with the given number of rows and columns.

new-matrix-nd clj

(new-matrix-nd m shape)

Returns a new general matrix of the given shape. Shape must be a sequence of dimension sizes.

new-vector clj

(new-vector m length)

Returns a new vector (1D column matrix) of the given length.

supports-dimensionality? clj

(supports-dimensionality? m dimensions)

Returns true if the implementation supports matrices with the given number of dimensions.

PIndexedAccess clj protocol

Protocol for indexed read access to matrices and vectors.

get-1d clj

(get-1d m row)

get-2d clj

(get-2d m row column)

get-nd clj

(get-nd m indexes)

PIndexedSetting clj protocol

Protocol for indexed setter access to matrices and vectors. Must be supported for any mutable matrix type.

is-mutable? clj

(is-mutable? m)

set-1d clj

(set-1d m row v)

set-2d clj

(set-2d m row column v)

set-nd clj

(set-nd m indexes v)

PMathsFunctions clj protocol

Protocol to support mathematic functions applied element-wise to a matrix

sqrt! clj

(sqrt! m)

to-radians clj

(to-radians m)

asin! clj

(asin! m)

cos! clj

(cos! m)

ceil! clj

(ceil! m)

log clj

(log m)

acos clj

(acos m)

to-degrees clj

(to-degrees m)

floor clj

(floor m)

tanh clj

(tanh m)

atan! clj

(atan! m)

to-radians! clj

(to-radians! m)

ceil clj

(ceil m)

abs! clj

(abs! m)

log! clj

(log! m)

atan clj

(atan m)

cosh! clj

(cosh! m)

sin! clj

(sin! m)

cos clj

(cos m)

log10 clj

(log10 m)

tan clj

(tan m)

cbrt clj

(cbrt m)

tan! clj

(tan! m)

exp! clj

(exp! m)

sqrt clj

(sqrt m)

to-degrees! clj

(to-degrees! m)

cbrt! clj

(cbrt! m)

exp clj

(exp m)

cosh clj

(cosh m)

round! clj

(round! m)

asin clj

(asin m)

signum! clj

(signum! m)

round clj

(round m)

acos! clj

(acos! m)

sinh! clj

(sinh! m)

tanh! clj

(tanh! m)

abs clj

(abs m)

sinh clj

(sinh m)

floor! clj

(floor! m)

sin clj

(sin m)

signum clj

(signum m)

log10! clj

(log10! m)

PMatrixAdd clj protocol

Protocol to support matrix addition on an arbitrary matrices of same size

matrix-add clj

(matrix-add m a)

matrix-sub clj

(matrix-sub m a)

PMatrixEquality clj protocol

Protocol for matrix equality operations

matrix-equals clj

(matrix-equals a b)

PMatrixMultiply clj protocol

Protocol to support matrix multiplication on an arbitrary matrix, vector or scalar

element-multiply clj

(element-multiply m a)

matrix-multiply clj

(matrix-multiply m a)

PMatrixOps clj protocol

Protocol to support common matrix operations

determinant clj

(determinant m)

inverse clj

(inverse m)

negate clj

(negate m)

trace clj

(trace m)

transpose clj

(transpose m)

PMatrixScaling clj protocol

Protocol to support matrix scaling by scalar values

pre-scale clj

(pre-scale m a)

scale clj

(scale m a)

PMatrixSlices clj protocol

Protocol to support getting slices of a matrix

get-column clj

(get-column m i)

get-major-slice clj

(get-major-slice m i)

get-row clj

(get-row m i)

get-slice clj

(get-slice m dimension i)

PVectorOps clj protocol

Protocol to support common vector operations.

length clj

(length a)

length-squared clj

(length-squared a)

normalise clj

(normalise a)

vector-dot clj

(vector-dot a b)

PVectorTransform clj protocol

Protocol to support transformation of a vector to another vector. Is equivalent to matrix multiplication when 2D matrices are used as transformations. But other transformations are possible, e.g. affine transformations.

vector-transform clj

(vector-transform m v)

Transforms a vector

vector-transform! clj

(vector-transform! m v)

Transforms a vector in place - mutates the vector argument