rtron-math/io.rtron.math.linear/RealMatrix

RealMatrix

class RealMatrix(rows: Array<DoubleArray>)

Real matrix of double values.

Parameters

rows

the rows of the matrix represented as DoubleArray

Constructors

RealMatrix

constructor(matrix: RealMatrix)

constructor(matrix: DoubleArray, columnDimension: Int)

constructor(rowVectors: List<RealVector>)

constructor(rows: Array<DoubleArray>)

Types

Companion

object Companion

Properties

columnDimension

val columnDimension: Int

number of columns

dimension

val dimension: Pair<Int, Int>

dimension of matrix as (rowDimension, columnDimension)

entries

val entries: Array<DoubleArray>

entry values of matrix whereby each DoubleArray represents a row

entriesFlattened

val entriesFlattened: DoubleArray

entry values of the matrix flattened to one DoubleArray

rowDimension

val rowDimension: Int

number of rows

Functions

appendColumn

fun RealMatrix.appendColumn(newColumn: DoubleArray): RealMatrix

Appends a newColumn to a RealMatrix.

appendRow

fun RealMatrix.appendRow(newRow: DoubleArray): RealMatrix

Appends a newRow to a RealMatrix.

containsNaN

fun containsNaN(): Boolean

Returns true, if any value of the vector is NaN.

equals

open operator override fun equals(other: Any?): Boolean

get

operator fun get(rowIndex: Int): DoubleArray

getColumn

fun getColumn(columnIndex: Int): DoubleArray

Returns the column of columnIndex as double array.

getColumnMatrix

fun getColumnMatrix(columnIndex: Int): RealMatrix

Returns the column of columnIndex as a real matrix.

getColumnVector

fun getColumnVector(columnIndex: Int): RealVector

Returns the column of columnIndex as real vector.

getRow

fun getRow(rowIndex: Int): DoubleArray

Returns the row of rowIndex as double array.

getRowMatrix

fun getRowMatrix(rowIndex: Int): RealMatrix

Returns the row of rowIndex as a real matrix.

getRowVector

fun getRowVector(rowIndex: Int): RealVector

Returns the row of rowIndex as real vector.

getSubMatrix

fun getSubMatrix(selectedRows: IntArray, selectedColumns: IntArray): RealMatrix

fun getSubMatrix(selectedRows: IntRange, selectedColumns: IntRange): RealMatrix

Returns a submatrix of the complete matrix by only selecting the selectedRows and selectedColumns.

hashCode

open override fun hashCode(): Int

inverse

fun inverse(): RealMatrix

Returns the inverse matrix of this matrix.

multiply

fun multiply(other: RealMatrix): RealMatrix

Returns this matrix multiplied with other (return = this x other).

fun multiply(vector: RealVector): RealVector

Returns this matrix multiplied with a vector (return = this x vector).

normalize

fun normalize(rowIndex: Int, columnIndex: Int): RealMatrix

preMultiply

fun preMultiply(other: RealMatrix): RealMatrix

Returns the other matrix multiplied with this (return = other x this).

fun preMultiply(vector: RealVector): RealVector

Returns a vector multiplied with this matrix (return = vector x this).

scalarAdd

fun scalarAdd(summand: Double): RealMatrix

Returns this matrix multiplied with a scalar summand.

scalarMultiply

fun scalarMultiply(factor: Double): RealMatrix

Returns this matrix multiplied with a scalar factor.

toDoubleArray

fun toDoubleArray(): DoubleArray

toDoubleList

fun toDoubleList(): List<Double>

toRealMatrixCM

fun toRealMatrixCM(): RealMatrix

Conversion to adapted Real Matrix class from Apache Commons Math.

toString

open override fun toString(): String

transpose

fun transpose(): RealMatrix

Returns the transposed matrix of this matrix.