matr-api/matr/MatrixFactory/Builder

Builder

trait Builder[R <: Int, C <: Int, T] extends Matrix[R, C, T]

A Builder is a "Matrix under construction" that itself forms a (mutable) Matrix. Utilizing Builder is the preferred way of creating new Matrices in Matrix operations.

A Builder is a "Matrix under construction" that itself forms a (mutable) Matrix. Utilizing Builder is the preferred way of creating new Matrices in Matrix operations.

One instance of a Builder is used to create one Matrix. This means that invoking the same Builder instance multiple times is OK, but letting a Builder leave a local scope is not OK (it's mutable!).

Implementations of this trait must return zero for uninitialized element positions.

trait Matrix[R, C, T]
class Object
trait Matchable
class Any

Type members

Inherited types

type This = Matrix[R, C, T]

Convenience type alias for this Matrix.

Convenience type alias for this Matrix.

Inherited from
Matrix

Value members

Abstract methods

def result: Matrix[R, C, T]

Creates the Matrix resulting from this Builder.

Creates the Matrix resulting from this Builder.

def update(rowIdx: Int, colIdx: Int, v: T): Builder[R, C, T]

Sets the specified element at the specified position.

Sets the specified element at the specified position.

Inherited methods

final def +(rhs: This)(using ma: MatrixAddition[R, C, T]): This

Performs a Matrix Addition.

Performs a Matrix Addition.

Inherited from
Matrix
final def -(rhs: This)(using ms: MatrixSubtraction[R, C, T]): This

Performs a Matrix Subtraction.

Performs a Matrix Subtraction.

Inherited from
Matrix
final def ===(rhs: This)(using me: MatrixEquality[R, C, T]): Boolean

Checks the equality of this and the other Matrix by performing element-wise comparision.

Checks the equality of this and the other Matrix by performing element-wise comparision.

Returns

true if both Matrices are equal

Inherited from
Matrix
def apply[RowIdx <: Int, ColIdx <: Int](using RowIdx < R =:= true, ColIdx < C =:= true)(using vri: ValueOf[RowIdx], vci: ValueOf[ColIdx]): T

Returns the element at the index specified at compile-time.

Returns the element at the index specified at compile-time.

Type Params
ColIdx

column index

RowIdx

row index

Inherited from
Matrix
def apply(rowIdx: Int, colIdx: Int): T

Returns the element at the index specified at runtime.

Returns the element at the index specified at runtime.

Value Params
colIdx

column index

rowIdx

row index

Inherited from
Matrix
final def colDim: Int

Returns the column dimension.

Returns the column dimension.

Inherited from
Matrix
def combine[U, V](rhs: Matrix[R, C, U])(op: (T, U) => V)(using mf: MatrixFactory[R, C, V]): Matrix[R, C, V]

Combines this Matrix and the other Matrix by applying the specified operation on the respective corresponding elements.

Combines this Matrix and the other Matrix by applying the specified operation on the respective corresponding elements.

Inherited from
Matrix
final def dot[L <: Int, U](rhs: Matrix[C, L, U])(using mm: MatrixMultiplication[R, C, L, T, U]): Out

Performs a Matrix Multiplication by calculating the dot product.

Performs a Matrix Multiplication by calculating the dot product.

Inherited from
Matrix
def fold[S](start: S)(op: (S, Int, Int) => S): S

Folds over the elements of this Matrix by invoking the specified operation with each element's index and the result of the previous invocation.

Folds over the elements of this Matrix by invoking the specified operation with each element's index and the result of the previous invocation.

Value Params
op

operation applied to each element (index)

start

value provided to the first invocation

Returns

result of the last invocation of the specified operation

Inherited from
Matrix
def iterate(op: (Int, Int) => Unit): Unit

Iterates over this Matrix by invoking the specified operation with each element's index.

Iterates over this Matrix by invoking the specified operation with each element's index.

Inherited from
Matrix
def map[U](op: T => U)(using mf: MatrixFactory[R, C, U]): Matrix[R, C, U]

Maps this Matrix to a new Matrix by applying the specified operation element-wise.

Maps this Matrix to a new Matrix by applying the specified operation element-wise.

Inherited from
Matrix
def mkString(elemToString: T => String): String

Renders this Matrix to a String using the specified function.

Renders this Matrix to a String using the specified function.

Inherited from
Matrix
def mkString: String

Renders this Matrix to a String using the elements' toString method.

Renders this Matrix to a String using the elements' toString method.

Inherited from
Matrix
def modify(using mf: MatrixFactory[R, C, T]): Builder[R, C, T]

Allows to easily "modify" this Matrix by creating a Builder initialized with the values of this Matrix.

Allows to easily "modify" this Matrix by creating a Builder initialized with the values of this Matrix.

Inherited from
Matrix
final def rowDim: Int

Returns the row dimension.

Returns the row dimension.

Inherited from
Matrix
final def submatrix[RowIdxTL <: Int, ColIdxTL <: Int, RowIdxBR <: Int, ColIdxBR <: Int](using sub: Submatrix[RowIdxTL, ColIdxTL, RowIdxBR, ColIdxBR, R, C, T]): Matrix[RowIdxBR - RowIdxTL + 1, ColIdxBR - ColIdxTL + 1, T]

Returns the submatrix with the specified bounds.

Returns the submatrix with the specified bounds.

Type Params
ColIdxBR

column index of the bottom-right vertex

ColIdxTL

column index of the top-left vertex

RowIdxBR

row index of the bottom-right vertex

RowIdxTL

row index of the top-left vertex

Inherited from
Matrix
final def transpose(using mt: Transpose[R, C, T]): Matrix[C, R, T]

Returns the transposed Matrix.

Returns the transposed Matrix.

Inherited from
Matrix