Matrix

java.lang.Object
- com.kylecorry.matrix.Matrix

All Implemented Interfaces:: java.lang.Cloneable

public class Matrix
extends java.lang.Object
implements java.lang.Cloneable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Matrix.Function
A transformation function that can be used to map input to a different output.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Matrix.Function` A transformation function that can be used to map input to a different output.

Constructor Summary

Constructors
Constructor and Description
`Matrix(double[][] values)` A mathematical matrix containing an array of values.
`Matrix(int rows, int cols)` A mathematical matrix containing an array of values.
`Matrix(int rows, int cols, double defaultValue)` A mathematical matrix containing an array of values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Matrix`	`add(double value)` Add a value to every item in the matrix.
`Matrix`	`add(Matrix mat)` Add two matrices together.
`java.lang.Object`	`clone()`
`Matrix`	`convertToOneColumn()` Convert the entire matrix to one column.
`Matrix`	`convertToOneRow()` Convert the entire matrix to one row.
`Matrix`	`dot(Matrix mat)` Apply the dot product to two matrices.
`int[]`	`find(double value)` Find a value in the matrix.
`double`	`get(int row, int col)` Get a value in the matrix.
`double[]`	`getColumn(int col)` Get a column of the matrix.
`int`	`getNumCols()` Get the number of columns in the matrix.
`int`	`getNumRows()` Get the number of rows in the matrix.
`double[]`	`getRow(int row)` Get a row of the matrix.
`double[][]`	`getValues()` Get the values of the matrix.
`Matrix`	`map(Matrix.Function fn)` Map each item in the matrix to a different value using a transformation function.
`double`	`max()` Get the max value of the matrix.
`double`	`min()` Get the min value of the matrix.
`Matrix`	`multiply(double value)` Multiply each item in the matrix by a value.
`Matrix`	`multiply(Matrix mat)` Multiply two matrices together using element wise multiplication.
`Matrix`	`normalize()` Normalize a matrix (All values will be scaled from 0..1 in proportion to the max value)
`Matrix`	`oneHot()` Make the max value in the matrix 1 and all others 0.
`Matrix`	`power(double power)` Raise every item in the matrix to a power.
`void`	`set(int row, int col, double value)` Set a value in the matrix.
`void`	`setValues(double[][] values)` Set the values of the matrix.
`Matrix`	`subtract(double value)` Subtract a value from every item in the matrix.
`Matrix`	`subtract(Matrix mat)` Subtract two matrices.
`double`	`sum()` Get the sum of all of the elements of the matrix.
`java.lang.String`	`toString()`
`Matrix`	`transpose()` Transpose a matrix.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Matrix
```
public Matrix(double[][] values)
```
    A mathematical matrix containing an array of values.
    
    Parameters:
    
    values - The values of the Matrix formated as double[rows][columns]
  - Matrix
```
public Matrix(int rows,
              int cols)
```
    A mathematical matrix containing an array of values.
    
    Parameters:
    
    rows - The number of rows in the matrix.
    
    cols - The number of columns in the matrix.
  - Matrix
```
public Matrix(int rows,
              int cols,
              double defaultValue)
```
    A mathematical matrix containing an array of values.
    
    Parameters:
    
    rows - The number of rows in the matrix.
    
    cols - The number of columns in the matrix.
    
    defaultValue - The default value of each item in the matrix.
- Method Detail
  - map
```
public Matrix map(Matrix.Function fn)
```
    Map each item in the matrix to a different value using a transformation function.
    
    Parameters:
    
    fn - The function to apply to each item in the matrix.
    
    Returns:
    
    A Matrix with the function applied to each item.
  - dot
```
public Matrix dot(Matrix mat)
```
    Apply the dot product to two matrices.
    
    Parameters:
    
    mat - The matrix to multiply by.
    
    Returns:
    
    A matrix that is the dot product of this matrix and mat.
  - power
```
public Matrix power(double power)
```
    Raise every item in the matrix to a power.
    
    Parameters:
    
    power - The power to raise each item to.
    
    Returns:
    
    A matrix that has each item raised to a power.
  - multiply
```
public Matrix multiply(Matrix mat)
```
    Multiply two matrices together using element wise multiplication.
    
    Parameters:
    
    mat - The matrix to multiply by.
    
    Returns:
    
    A matrix that is the element wise product of this matrix and mat.
  - multiply
```
public Matrix multiply(double value)
```
    Multiply each item in the matrix by a value.
    
    Parameters:
    
    value - The value to multiply each item by.
    
    Returns:
    
    A matrix that has been scaled by value.
  - transpose
```
public Matrix transpose()
```
    Transpose a matrix.
    
    Returns:
    
    A transposed matrix.
  - add
```
public Matrix add(Matrix mat)
```
    Add two matrices together.
    
    Parameters:
    
    mat - The matrix to add to this matrix.
    
    Returns:
    
    The element wise sum of the two matrices.
  - add
```
public Matrix add(double value)
```
    Add a value to every item in the matrix.
    
    Parameters:
    
    value - The amount to add to each item.
    
    Returns:
    
    A matrix shifted positively by value.
  - subtract
```
public Matrix subtract(Matrix mat)
```
    Subtract two matrices.
    
    Parameters:
    
    mat - The matrix to subtract from this matrix.
    
    Returns:
    
    The element wise difference of the two matrices.
  - subtract
```
public Matrix subtract(double value)
```
    Subtract a value from every item in the matrix.
    
    Parameters:
    
    value - The amount to subtract from each item.
    
    Returns:
    
    A matrix shifted negatively by value.
  - normalize
```
public Matrix normalize()
```
    Normalize a matrix (All values will be scaled from 0..1 in proportion to the max value)
    
    Returns:
    
    A normalized matrix.
  - oneHot
```
public Matrix oneHot()
```
    Make the max value in the matrix 1 and all others 0.
    
    Returns:
    
    A one-hot matrix.
  - convertToOneRow
```
public Matrix convertToOneRow()
```
    Convert the entire matrix to one row.
    
    Returns:
    
    A matrix that is a single row.
  - convertToOneColumn
```
public Matrix convertToOneColumn()
```
    Convert the entire matrix to one column.
    
    Returns:
    
    A matrix that is a single column.
  - max
```
public double max()
```
    Get the max value of the matrix.
    
    Returns:
    
    The max value of the matrix.
  - min
```
public double min()
```
    Get the min value of the matrix.
    
    Returns:
    
    The min value of the matrix.
  - find
```
public int[] find(double value)
```
    Find a value in the matrix.
    
    Parameters:
    
    value - The target value.
    
    Returns:
    
    The position of the target value [row, col] or [-1, -1] if the value can't be found.
  - sum
```
public double sum()
```
    Get the sum of all of the elements of the matrix.
    
    Returns:
    
    The sum of the matrix elements.
  - getValues
```
public double[][] getValues()
```
    Get the values of the matrix.
    
    Returns:
    
    The values of the matrix as a double[][].
  - setValues
```
public void setValues(double[][] values)
```
    Set the values of the matrix.
    
    Parameters:
    
    values - The new values of the matrix as a double[][].
  - getNumRows
```
public int getNumRows()
```
    Get the number of rows in the matrix.
    
    Returns:
    
    The number of rows in the matrix.
  - getNumCols
```
public int getNumCols()
```
    Get the number of columns in the matrix.
    
    Returns:
    
    The number of columns in the matrix.
  - get
```
public double get(int row,
                  int col)
```
    Get a value in the matrix.
    
    Parameters:
    
    row - The row of the value.
    
    col - The column of the value.
    
    Returns:
    
    The value at [row, col].
  - set
```
public void set(int row,
                int col,
                double value)
```
    Set a value in the matrix.
    
    Parameters:
    
    row - The row of the value.
    
    col - The column of the value
    
    value - The new value for [row, col]
  - getRow
```
public double[] getRow(int row)
```
    Get a row of the matrix.
    
    Parameters:
    
    row - The row number of the matrix.
    
    Returns:
    
    The row of the matrix as a double[].
  - getColumn
```
public double[] getColumn(int col)
```
    Get a column of the matrix.
    
    Parameters:
    
    col - The column number of the matrix.
    
    Returns:
    
    The column of the matrix as a double[].
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class Matrix

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Matrix

Matrix

Matrix

Method Detail

map

dot

power

multiply

multiply

transpose

add

add

subtract

subtract

normalize

oneHot

convertToOneRow

convertToOneColumn

max

min

find

sum

getValues

setValues

getNumRows

getNumCols

get

set

getRow

getColumn

toString

clone