DenseMatrix (Tribuo 4.1.1 API)

java.lang.Object
- org.tribuo.math.la.DenseMatrix

All Implemented Interfaces:

Serializable, Iterable<MatrixTuple>, Matrix, Tensor

Direct Known Subclasses:

ShrinkingMatrix
```
public class DenseMatrix
extends Object
implements Matrix
```
A dense matrix, backed by a primitive array.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected int dim1

protected int dim2

protected double[][] values

Fields
Modifier and Type	Field and Description
`protected int`	`dim1`
`protected int`	`dim2`
`protected double[][]`	`values`

Constructor Summary

Constructors
Constructor and Description
`DenseMatrix(DenseMatrix other)` Copies the supplied matrix.
`DenseMatrix(int dim1, int dim2)` Creates a dense matrix full of zeros.
`DenseMatrix(Matrix other)` Copies the supplied matrix, densifying it if it's sparse.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int i, int j, double value)` Adds the argument value to the value at the supplied index.
`void`	`addAcrossDim1(int[] indices, double value)`
`void`	`addAcrossDim2(int[] indices, double value)`
`void`	`broadcastIntersectAndAddInPlace(SGDVector input, boolean broadcastOverDim1)` Broadcasts the input vector and adds it to each row/column of the matrix.
`DenseVector`	`columnSum()` Returns the dense vector containing each column sum.
`double`	`columnSum(int columnIndex)` Calculates the sum of the specified column.
`DenseMatrix`	`copy()` Copies the matrix.
`static DenseMatrix`	`createDenseMatrix(double[][] values)` Defensively copies the values before construction.
`boolean`	`equals(Object o)`
`void`	`foreachInPlace(DoubleUnaryOperator f)` Applies a `DoubleUnaryOperator` elementwise to this `Tensor`.
`DenseVector`	`gatherAcrossDim1(int[] elements)`
`DenseVector`	`gatherAcrossDim2(int[] elements)`
`double`	`get(int i, int j)` Gets an element from this `Matrix`.
`DenseVector`	`getColumn(int index)` Returns a copy of the specified column.
`int`	`getDimension1Size()` The size of the first dimension.
`int`	`getDimension2Size()` The size of the second dimension.
`DenseVector`	`getRow(int i)` Extract a row as an `SGDVector`.
`int[]`	`getShape()` Returns an int array specifying the shape of this `Tensor`.
`void`	`hadamardProductInPlace(Tensor other, DoubleUnaryOperator f)` Updates this `Tensor` with the Hadamard product (i.e., a term by term multiply) of this and `other`.
`int`	`hashCode()`
`void`	`intersectAndAddInPlace(Tensor other, DoubleUnaryOperator f)` Updates this `Tensor` by adding all the values from the intersection with `other`.
`MatrixIterator`	`iterator()`
`DenseVector`	`leftMultiply(SGDVector input)` Multiplies this Matrix by a `SGDVector` returning a vector of the appropriate size.
`DenseMatrix`	`matrixMultiply(Matrix other)` Multiplies this Matrix by another `Matrix` returning a matrix of the appropriate size.
`DenseMatrix`	`matrixMultiply(Matrix other, boolean transposeThis, boolean transposeOther)` Multiplies this Matrix by another `Matrix` returning a matrix of the appropriate size.
`void`	`normalizeRows(VectorNormalizer normalizer)` Normalizes each row using the supplied normalizer in place.
`int`	`numActiveElements(int row)` The number of non-zero elements in that row.
`Tensor`	`reshape(int[] newShape)` Reshapes the Tensor to the supplied shape.
`DenseVector`	`rightMultiply(SGDVector input)` Multiplies this Matrix by a `SGDVector` returning a vector of the appropriate size.
`void`	`rowScaleInPlace(DenseVector scalingCoefficients)` Scales each row by the appropriate value in the `DenseVector`.
`DenseVector`	`rowSum()` Generates a `DenseVector` representing the sum of each row.
`double`	`rowSum(int rowIndex)` Calculates the sum of the specified row.
`void`	`set(int i, int j, double value)` Sets an element at the supplied location.
`String`	`toString()`
`DenseMatrix`	`transpose()` Returns a transposed copy of this matrix.
`double`	`twoNorm()` Calculates the euclidean norm for this vector.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tribuo.math.la.Tensor
hadamardProductInPlace, intersectAndAddInPlace, scalarAddInPlace, scaleInPlace, shapeCheck, shapeSum

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - values
```
protected final double[][] values
```
  - dim1
```
protected final int dim1
```
  - dim2
```
protected final int dim2
```
- Constructor Detail
  - DenseMatrix
```
public DenseMatrix(int dim1,
                   int dim2)
```
    Creates a dense matrix full of zeros.
    
    Parameters:
    
    dim1 - The first dimension.
    
    dim2 - The second dimension.
  - DenseMatrix
```
public DenseMatrix(DenseMatrix other)
```
    Copies the supplied matrix.
    
    Parameters:
    
    other - The matrix to copy.
  - DenseMatrix
```
public DenseMatrix(Matrix other)
```
    Copies the supplied matrix, densifying it if it's sparse.
    
    Parameters:
    
    other - The matrix to copy.
- Method Detail
  - createDenseMatrix
```
public static DenseMatrix createDenseMatrix(double[][] values)
```
    Defensively copies the values before construction.
    Throws IllegalArgumentException if the supplied values are a ragged array.
    
    Parameters:
    
    values - The values of this dense matrix.
    
    Returns:
    
    A new dense matrix.
  - getShape
```
public int[] getShape()
```
    Description copied from interface: Tensor
    
    Returns an int array specifying the shape of this Tensor.
    
    Specified by:
    
    getShape in interface Tensor
    
    Returns:
    
    An int array.
  - reshape
```
public Tensor reshape(int[] newShape)
```
    Description copied from interface: Tensor
    
    Reshapes the Tensor to the supplied shape. Throws IllegalArgumentException if the shape isn't compatible.
    
    Specified by:
    
    reshape in interface Tensor
    
    Parameters:
    
    newShape - The desired shape.
    
    Returns:
    
    A Tensor of the desired shape.
  - copy
```
public DenseMatrix copy()
```
    Copies the matrix.
    
    Returns:
    
    A deep copy of the matrix.
  - get
```
public double get(int i,
                  int j)
```
    Description copied from interface: Matrix
    
    Gets an element from this Matrix.
    
    Specified by:
    
    get in interface Matrix
    
    Parameters:
    
    i - The index for the first dimension.
    
    j - The index for the second dimension.
    
    Returns:
    
    The value at matrix[i][j].
  - gatherAcrossDim1
```
public DenseVector gatherAcrossDim1(int[] elements)
```
  - gatherAcrossDim2
```
public DenseVector gatherAcrossDim2(int[] elements)
```
  - transpose
```
public DenseMatrix transpose()
```
    Returns a transposed copy of this matrix.
    
    Returns:
    
    A transposed copy.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - set
```
public void set(int i,
                int j,
                double value)
```
    Description copied from interface: Matrix
    
    Sets an element at the supplied location.
    
    Specified by:
    
    set in interface Matrix
    
    Parameters:
    
    i - The index for the first dimension.
    
    j - The index for the second dimension.
    
    value - The value to be stored at matrix[i][j].
  - getDimension1Size
```
public int getDimension1Size()
```
    Description copied from interface: Matrix
    
    The size of the first dimension.
    
    Specified by:
    
    getDimension1Size in interface Matrix
    
    Returns:
    
    The size of the first dimension.
  - getDimension2Size
```
public int getDimension2Size()
```
    Description copied from interface: Matrix
    
    The size of the second dimension.
    
    Specified by:
    
    getDimension2Size in interface Matrix
    
    Returns:
    
    The size of the second dimension.
  - leftMultiply
```
public DenseVector leftMultiply(SGDVector input)
```
    Description copied from interface: Matrix
    
    Multiplies this Matrix by a SGDVector returning a vector of the appropriate size.
    The input must have dimension equal to Matrix.getDimension2Size().
    
    Specified by:
    
    leftMultiply in interface Matrix
    
    Parameters:
    
    input - The input vector.
    
    Returns:
    
    A new SGDVector of size Matrix.getDimension1Size().
  - rightMultiply
```
public DenseVector rightMultiply(SGDVector input)
```
    Description copied from interface: Matrix
    
    Multiplies this Matrix by a SGDVector returning a vector of the appropriate size.
    The input must have dimension equal to Matrix.getDimension1Size().
    
    Specified by:
    
    rightMultiply in interface Matrix
    
    Parameters:
    
    input - The input vector.
    
    Returns:
    
    A new SGDVector of size Matrix.getDimension2Size().
  - matrixMultiply
```
public DenseMatrix matrixMultiply(Matrix other)
```
    Description copied from interface: Matrix
    
    Multiplies this Matrix by another Matrix returning a matrix of the appropriate size.
    The input must have dimension 1 equal to Matrix.getDimension2Size().
    
    Specified by:
    
    matrixMultiply in interface Matrix
    
    Parameters:
    
    other - The input matrix.
    
    Returns:
    
    A new Matrix of size Matrix.getDimension1Size(), input.getDimension2Size().
  - matrixMultiply
```
public DenseMatrix matrixMultiply(Matrix other,
                                  boolean transposeThis,
                                  boolean transposeOther)
```
    Description copied from interface: Matrix
    
    Multiplies this Matrix by another Matrix returning a matrix of the appropriate size.
    Must obey the rules of matrix multiplication after the transposes are applied.
    
    Specified by:
    
    matrixMultiply in interface Matrix
    
    Parameters:
    
    other - The input matrix.
    
    transposeThis - Implicitly transposes this matrix just for the multiplication.
    
    transposeOther - Implicitly transposes other just for the multiplication.
    
    Returns:
    
    A new Matrix.
  - rowSum
```
public DenseVector rowSum()
```
    Description copied from interface: Matrix
    
    Generates a DenseVector representing the sum of each row.
    
    Specified by:
    
    rowSum in interface Matrix
    
    Returns:
    
    A new DenseVector of size Matrix.getDimension1Size().
  - rowScaleInPlace
```
public void rowScaleInPlace(DenseVector scalingCoefficients)
```
    Description copied from interface: Matrix
    
    Scales each row by the appropriate value in the DenseVector.
    
    Specified by:
    
    rowScaleInPlace in interface Matrix
    
    Parameters:
    
    scalingCoefficients - A DenseVector with size Matrix.getDimension1Size().
  - add
```
public void add(int i,
                int j,
                double value)
```
    Description copied from interface: Matrix
    
    Adds the argument value to the value at the supplied index.
    
    Specified by:
    
    add in interface Matrix
    
    Parameters:
    
    i - The index for the first dimension.
    
    j - The index for the second dimension.
    
    value - The value to add.
  - addAcrossDim1
```
public void addAcrossDim1(int[] indices,
                          double value)
```
  - addAcrossDim2
```
public void addAcrossDim2(int[] indices,
                          double value)
```
  - intersectAndAddInPlace
```
public void intersectAndAddInPlace(Tensor other,
                                   DoubleUnaryOperator f)
```
    Description copied from interface: Tensor
    
    Updates this Tensor by adding all the values from the intersection with other.
    The function f is applied to all values from other before the addition.
    Each value is updated as value += f(otherValue).
    
    Specified by:
    
    intersectAndAddInPlace in interface Tensor
    
    Parameters:
    
    other - The other Tensor.
    
    f - A function to apply.
  - hadamardProductInPlace
```
public void hadamardProductInPlace(Tensor other,
                                   DoubleUnaryOperator f)
```
    Description copied from interface: Tensor
    
    Updates this Tensor with the Hadamard product (i.e., a term by term multiply) of this and other.
    The function f is applied to all values from other before the addition.
    Each value is updated as value *= f(otherValue).
    
    Specified by:
    
    hadamardProductInPlace in interface Tensor
    
    Parameters:
    
    other - The other Tensor.
    
    f - A function to apply.
  - foreachInPlace
```
public void foreachInPlace(DoubleUnaryOperator f)
```
    Description copied from interface: Tensor
    
    Applies a DoubleUnaryOperator elementwise to this Tensor.
    
    Specified by:
    
    foreachInPlace in interface Tensor
    
    Parameters:
    
    f - The function to apply.
  - broadcastIntersectAndAddInPlace
```
public void broadcastIntersectAndAddInPlace(SGDVector input,
                                            boolean broadcastOverDim1)
```
    Broadcasts the input vector and adds it to each row/column of the matrix.
    
    Parameters:
    
    input - The input vector.
    
    broadcastOverDim1 - If true broadcasts over the first dimension, else broadcasts over the second.
  - numActiveElements
```
public int numActiveElements(int row)
```
    Description copied from interface: Matrix
    
    The number of non-zero elements in that row.
    An element could be active and zero, if it was active on construction.
    
    Specified by:
    
    numActiveElements in interface Matrix
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    The number of non-zero elements.
  - getRow
```
public DenseVector getRow(int i)
```
    Description copied from interface: Matrix
    
    Extract a row as an SGDVector.
    This refers to the same values as the matrix, so updating this vector will update the matrix.
    
    Specified by:
    
    getRow in interface Matrix
    
    Parameters:
    
    i - The index of the row to extract.
    
    Returns:
    
    An SGDVector.
  - getColumn
```
public DenseVector getColumn(int index)
```
    Returns a copy of the specified column.
    
    Parameters:
    
    index - The column index.
    
    Returns:
    
    A copy of the column.
  - rowSum
```
public double rowSum(int rowIndex)
```
    Calculates the sum of the specified row.
    
    Parameters:
    
    rowIndex - The index of the row to sum.
    
    Returns:
    
    The row sum.
  - columnSum
```
public double columnSum(int columnIndex)
```
    Calculates the sum of the specified column.
    
    Parameters:
    
    columnIndex - The index of the column to sum.
    
    Returns:
    
    The column sum.
  - twoNorm
```
public double twoNorm()
```
    Description copied from interface: Tensor
    
    Calculates the euclidean norm for this vector.
    
    Specified by:
    
    twoNorm in interface Tensor
    
    Returns:
    
    The euclidean norm.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - iterator
```
public MatrixIterator iterator()
```
    Specified by:
    
    iterator in interface Iterable<MatrixTuple>
  - normalizeRows
```
public void normalizeRows(VectorNormalizer normalizer)
```
    Normalizes each row using the supplied normalizer in place.
    
    Parameters:
    
    normalizer - The vector normalizer to use.
  - columnSum
```
public DenseVector columnSum()
```
    Returns the dense vector containing each column sum.
    
    Returns:
    
    The column sums.

Class DenseMatrix

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.tribuo.math.la.Tensor

Methods inherited from interface java.lang.Iterable

Field Detail

values

dim1

dim2

Constructor Detail

DenseMatrix

DenseMatrix

DenseMatrix

Method Detail

createDenseMatrix

getShape

reshape

copy

get

gatherAcrossDim1

gatherAcrossDim2

transpose

equals

hashCode

set

getDimension1Size

getDimension2Size

leftMultiply

rightMultiply

matrixMultiply

matrixMultiply

rowSum

rowScaleInPlace

add

addAcrossDim1

addAcrossDim2

intersectAndAddInPlace

hadamardProductInPlace

foreachInPlace

broadcastIntersectAndAddInPlace

numActiveElements

getRow

getColumn

rowSum

columnSum

twoNorm

toString

iterator

normalizeRows

columnSum