AbstractMatrix (Jipes 0.9.17 API)

java.lang.Object
- com.tagtraum.jipes.math.AbstractMatrix

All Implemented Interfaces:

Matrix

Direct Known Subclasses:

MutableAbstractMatrix
```
public abstract class AbstractMatrix
extends Object
implements Matrix
```
Base implementation for a Matrix.

Author:

Hendrik Schreiber

Field Summary

Fields
Modifier and Type Field and Description

protected MatrixBackingBuffer buffer

protected int columns

protected int rows

protected boolean zeroPadded

Fields
Modifier and Type	Field and Description
`protected MatrixBackingBuffer`	`buffer`
`protected int`	`columns`
`protected int`	`rows`
`protected boolean`	`zeroPadded`

Constructor Summary

Constructors
Constructor and Description

AbstractMatrix()

Constructors
Constructor and Description
`AbstractMatrix()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Matrix`	`add(Matrix m)` Creates a view that is equal to the result of an addition.
`protected void`	`checkBounds(int row, int column)`
`float[]`	`columnSum()` Compute the sum for each column.
`Matrix`	`enlarge(Matrix m)` Creates a view that is as large as the larger of the two involved matrices.
`boolean`	`equals(Object o)`
`protected float`	`get(int index)`
`float`	`get(int row, int column)` Gets the value from `row` and `column`.
`float[]`	`getColumn(int column)` Gets the value from `column`.
`int`	`getNumberOfColumns()` Number of columns.
`int`	`getNumberOfRows()` Number of rows
`float[]`	`getRow(int row)` Gets the values from `row`.
`Matrix`	`hadamardMultiply(Matrix m)` Creates a view that is equal to the result of a Hadamard multiplication.
`int`	`hashCode()`
`protected boolean`	`isInvalid(int row, int column)`
`protected boolean`	`isValidXORZeroPadded(int row, int column)`
`boolean`	`isZeroPadded()` Indicates whether this matrix is zero padded.
`Matrix`	`multiply(float scalar)` Creates a view that is equal to the result of a scalar multiplication.
`Matrix`	`multiply(Matrix m)` Creates a view that is equal to the result of a matrix multiplication.
`float[]`	`rowSum()` Compute the sum for each row.
`Matrix`	`subtract(Matrix m)` Creates a view that is equal to the result of an subtraction.
`float`	`sum()` Compute the sum of all elements.
`protected int`	`toIndex(int row, int column)`
`String`	`toString()`
`Matrix`	`translate(int rows, int columns)` Creates a view that is equal to the result of a matrix translation.
`Matrix`	`transpose()` Creates a view that is equal to the result of a matrix transposition.

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

- Field Detail
  - rows
```
protected int rows
```
  - columns
```
protected int columns
```
  - zeroPadded
```
protected boolean zeroPadded
```
  - buffer
```
protected MatrixBackingBuffer buffer
```
- Constructor Detail
  - AbstractMatrix
```
public AbstractMatrix()
```
- Method Detail
  - add
```
public Matrix add(Matrix m)
```
    Description copied from interface: Matrix
    
    Creates a view that is equal to the result of an addition.
    
    Specified by:
    
    add in interface Matrix
    
    Parameters:
    
    m - matrix to add to this
    
    Returns:
    
    add view
  - subtract
```
public Matrix subtract(Matrix m)
```
    Description copied from interface: Matrix
    
    Creates a view that is equal to the result of an subtraction.
    
    Specified by:
    
    subtract in interface Matrix
    
    Parameters:
    
    m - matrix to subtract from this
    
    Returns:
    
    subtract view
  - multiply
```
public Matrix multiply(float scalar)
```
    Description copied from interface: Matrix
    
    Creates a view that is equal to the result of a scalar multiplication.
    
    Specified by:
    
    multiply in interface Matrix
    
    Parameters:
    
    scalar - scalar
    
    Returns:
    
    multiplication view
  - multiply
```
public Matrix multiply(Matrix m)
```
    Description copied from interface: Matrix
    
    Creates a view that is equal to the result of a matrix multiplication.
    
    Specified by:
    
    multiply in interface Matrix
    
    Parameters:
    
    m - matrix to multiply this with
    
    Returns:
    
    multiplication view
  - transpose
```
public Matrix transpose()
```
    Description copied from interface: Matrix
    
    Creates a view that is equal to the result of a matrix transposition.
    
    Specified by:
    
    transpose in interface Matrix
    
    Returns:
    
    transposition view
  - translate
```
public Matrix translate(int rows,
                        int columns)
```
    Description copied from interface: Matrix
    
    Creates a view that is equal to the result of a matrix translation. I.e. the content of the matrix is moved to a different position in a larger matrix.
    
    Specified by:
    
    translate in interface Matrix
    
    Parameters:
    
    rows - number of rows to move the matrix
    
    columns - number of columns to move the matrix
    
    Returns:
    
    transposition view
  - hadamardMultiply
```
public Matrix hadamardMultiply(Matrix m)
```
    Description copied from interface: Matrix
    
    Creates a view that is equal to the result of a Hadamard multiplication.
    
    Specified by:
    
    hadamardMultiply in interface Matrix
    
    Parameters:
    
    m - matrix to multiply this with
    
    Returns:
    
    multiplication view
  - enlarge
```
public Matrix enlarge(Matrix m)
```
    Description copied from interface: Matrix
    
    Creates a view that is as large as the larger of the two involved matrices. Values are equal to the values of this matrix, as long as its maximal indices aren't exceeded. Once they are exceeded, the given matrix is used as "backup". If its indices are also exceeded its padding (if available) is returned upon read operations.
    In essence this operation adds the given matrix to this matrix for those rows and columns where this matrix isn't defined. The existing values of the given matrix are invisible for those indices where this matrix is defined.
    
    Specified by:
    
    enlarge in interface Matrix
    
    Parameters:
    
    m - matrix
    
    Returns:
    
    enlarged matrix combining this and the given matrix
  - getNumberOfColumns
```
public int getNumberOfColumns()
```
    Description copied from interface: Matrix
    
    Number of columns.
    
    Specified by:
    
    getNumberOfColumns in interface Matrix
    
    Returns:
    
    columns
  - getNumberOfRows
```
public int getNumberOfRows()
```
    Description copied from interface: Matrix
    
    Number of rows
    
    Specified by:
    
    getNumberOfRows in interface Matrix
    
    Returns:
    
    rows
  - isZeroPadded
```
public boolean isZeroPadded()
```
    Description copied from interface: Matrix
    
    Indicates whether this matrix is zero padded. I.e. access to undefined rows or columns leads to a return value 0f, instead of an exception.
    
    Specified by:
    
    isZeroPadded in interface Matrix
    
    Returns:
    
    true or false
  - get
```
public float get(int row,
                 int column)
```
    Description copied from interface: Matrix
    
    Gets the value from row and column. If the matrix supports zero-padding, this method may return 0f for undefined rows or columns.
    
    Specified by:
    
    get in interface Matrix
    
    Parameters:
    
    row - row
    
    column - column
    
    Returns:
    
    value
  - sum
```
public float sum()
```
    Description copied from interface: Matrix
    
    Compute the sum of all elements.
    
    Specified by:
    
    sum in interface Matrix
    
    Returns:
    
    sum
  - rowSum
```
public float[] rowSum()
```
    Description copied from interface: Matrix
    
    Compute the sum for each row.
    
    Specified by:
    
    rowSum in interface Matrix
    
    Returns:
    
    sum for all rows
  - columnSum
```
public float[] columnSum()
```
    Description copied from interface: Matrix
    
    Compute the sum for each column.
    
    Specified by:
    
    columnSum in interface Matrix
    
    Returns:
    
    sum for all columns
  - getRow
```
public float[] getRow(int row)
```
    Description copied from interface: Matrix
    
    Gets the values from row. If the matrix supports zero-padding, this method may return 0f for undefined rows or columns.
    
    Specified by:
    
    getRow in interface Matrix
    
    Parameters:
    
    row - row
    
    Returns:
    
    value
  - getColumn
```
public float[] getColumn(int column)
```
    Description copied from interface: Matrix
    
    Gets the value from column. If the matrix supports zero-padding, this method may return 0f for undefined columns.
    
    Specified by:
    
    getColumn in interface Matrix
    
    Parameters:
    
    column - column
    
    Returns:
    
    value
  - isValidXORZeroPadded
```
protected boolean isValidXORZeroPadded(int row,
                                       int column)
```
  - checkBounds
```
protected void checkBounds(int row,
                           int column)
```
  - isInvalid
```
protected boolean isInvalid(int row,
                            int column)
```
  - toIndex
```
protected int toIndex(int row,
                      int column)
```
  - get
```
protected float get(int index)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractMatrix

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rows

columns

zeroPadded

buffer

Constructor Detail

AbstractMatrix

Method Detail

add

subtract

multiply

multiply

transpose

translate

hadamardMultiply

enlarge

getNumberOfColumns

getNumberOfRows

isZeroPadded

get

sum

rowSum

columnSum

getRow

getColumn

isValidXORZeroPadded

checkBounds

isInvalid

toIndex

get

equals

hashCode

toString