matrix
0.101
API
Generated with
matrix/ai.dragonfly.math.matrix/Matrix

Matrix

ai.dragonfly.math.matrix.Matrix$
See theMatrix companion class
object Matrix

This library is fundamentally an adaptation of the Java Matrix library, JaMa, by MathWorks Inc. and the National Institute of Standards and Technology.

Attributes

Companion:
class
Source:
Matrix.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Matrix.type

Members list

Concise view

Value members

Concrete methods

def apply[M <: Int, N <: Int](values: Array[Array[Double]])(using ValueOf[M], ValueOf[N]): Matrix[M, N]

Construct a matrix from a 2-D array.

Construct a matrix from a 2-D array.

Attributes

values

Two-dimensional array of doubles.

Throws:
IllegalArgumentException

All rows must have the same length

Source:
Matrix.scala
def apply[M <: Int, N <: Int](value: Double)(using ValueOf[M], ValueOf[N]): Matrix[M, N]

Construct an MxN constant matrix.

Construct an MxN constant matrix.

Attributes

M

the number of rows

N

the number of columns

value

Fill the matrix with this scalar value.

Returns:

an MxN constant matrix.

Source:
Matrix.scala
def apply[M <: Int, N <: Int](vals: Array[Double])(using ValueOf[M], ValueOf[N]): Matrix[M, N]

Construct a matrix from a one-dimensional packed array

Construct a matrix from a one-dimensional packed array

Attributes

m

Number of rows.

vals

One-dimensional array of doubles, packed by columns (ala Fortran).

Throws:
IllegalArgumentException

Array length must be a multiple of m.

Source:
Matrix.scala
def constructWithCopy[M <: Int, N <: Int](values: Array[Array[Double]])(using ValueOf[M], ValueOf[N]): Matrix[M, N]

Construct a matrix from a copy of a 2-D array.

Construct a matrix from a copy of a 2-D array.

Attributes

values

Two-dimensional array of doubles.

Throws:
IllegalArgumentException

All rows must have the same length

Source:
Matrix.scala
def diagonal[M <: Int, N <: Int](value: Double)(using ValueOf[M], ValueOf[N]): Matrix[M, N]

Generate identity matrix scaled by value parameter.

Generate identity matrix scaled by value parameter.

Attributes

columns

Number of colums.

rows

Number of rows.

value

scalar multiplier.

Returns:

An MxN matrix with ones on the diagonal and zeros elsewhere.

Source:
Matrix.scala
def diagonal[D <: Int](v: Vec[D])(using ValueOf[D]): Matrix[D, D]

Generate a square matrix with the supplied vector along the diagonal.

Generate a square matrix with the supplied vector along the diagonal.

Attributes

v

a vector

Source:
Matrix.scala
def diagonal[M <: Int, N <: Int, D <: Int](v: Vec[D])(using ValueOf[M], ValueOf[N], ValueOf[D]): Matrix[M, N]

Attributes

Source:
Matrix.scala
def identity[M <: Int, N <: Int](using ValueOf[M], ValueOf[N]): Matrix[M, N]

Generate identity matrix

Generate identity matrix

Attributes

M

the number of rows

N

the number of columns

Returns:

An MxN matrix with ones on the diagonal and zeros elsewhere.

Source:
Matrix.scala
def random[M <: Int, N <: Int](maxNorm: Double, r: Random)(using ValueOf[M], ValueOf[N]): Matrix[M, N]

Generate matrix with random elements

Generate matrix with random elements

Attributes

M

the number of rows

N

the number of columns

maxNorm

optional Maximum random generated value allowed.

r

optional random instance.

Returns:

An MxN matrix with uniformly distributed random elements.

Source:
Matrix.scala
def zeros[M <: Int, N <: Int](using ValueOf[M], ValueOf[N]): Matrix[M, N]

Construct an MxN matrix of zeros.

Construct an MxN matrix of zeros.

Attributes

M

the number of rows

N

the number of columns

Source:
Matrix.scala
Generated with