Package org.flag4j.core.dense_base

Interface DenseMatrixMixin<T,X>

Type Parameters:

T - Type of the dense matrix.

X - Type of an individual entry in the matrix.

All Known Implementing Classes:

CMatrix, Matrix

public interface DenseMatrixMixin<T,X>

This interface specifies methods which all dense matrices should implement.

Method Summary

Modifier and Type	Method	Description
void	addEq(Matrix B)	Computes the element-wise addition of a matrix with a real dense matrix.
void	addEq(CooMatrix B)	Computes the element-wise addition of a matrix with a real sparse matrix.
T	setSliceCopy(double[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setSliceCopy(int[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setSliceCopy(Double[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setSliceCopy(Integer[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setSliceCopy(Matrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setSliceCopy(CooMatrix values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setSliceCopy(T values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setSliceCopy(X[][] values, int rowStart, int colStart)	Creates a copy of this matrix and sets a slice of the copy to the specified values.
T	setValues(double[][] values)	Sets the value of this matrix using a 2D array.
T	setValues(int[][] values)	Sets the value of this matrix using a 2D array.
T	setValues(Double[][] values)	Sets the value of this matrix using a 2D array.
T	setValues(X[][] values)	Sets the value of this matrix using a 2D array.
void	subEq(Matrix B)	Computes the element-wise subtraction of this matrix with a real dense matrix.
void	subEq(CooMatrix B)	Computes the element-wise subtraction of this matrix with a real sparse matrix.

Method Details

setValues

T setValues(X[][] values)

Sets the value of this matrix using a 2D array.

Parameters:

values - New values of the matrix.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

setValues

T setValues(Double[][] values)

Sets the value of this matrix using a 2D array.

Parameters:

values - New values of the matrix.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

setValues

T setValues(double[][] values)

Sets the value of this matrix using a 2D array.

Parameters:

values - New values of the matrix.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

setValues

T setValues(int[][] values)

Sets the value of this matrix using a 2D array.

Parameters:

values - New values of the matrix.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different shape then this matrix.

addEq

void addEq(Matrix B)

Computes the element-wise addition of a matrix with a real dense matrix. The result is stored in this matrix.

Parameters:

B - The matrix to add to this matrix.

subEq

void subEq(Matrix B)

Computes the element-wise subtraction of this matrix with a real dense matrix. The result is stored in this matrix.

Parameters:

B - The matrix to subtract from this matrix.

addEq

void addEq(CooMatrix B)

Computes the element-wise addition of a matrix with a real sparse matrix. The result is stored in this matrix.

Parameters:

B - The sparse matrix to add to this matrix.

subEq

void subEq(CooMatrix B)

Computes the element-wise subtraction of this matrix with a real sparse matrix. The result is stored in this matrix.

Parameters:

B - The sparse matrix to subtract from this matrix.

setSliceCopy

T setSliceCopy(T values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSliceCopy

T setSliceCopy(X[][] values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSliceCopy

T setSliceCopy(Double[][] values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSliceCopy

T setSliceCopy(Integer[][] values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSliceCopy

T setSliceCopy(double[][] values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSliceCopy

T setSliceCopy(int[][] values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSliceCopy

T setSliceCopy(Matrix values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.

setSliceCopy

T setSliceCopy(CooMatrix values,
 int rowStart,
 int colStart)

Creates a copy of this matrix and sets a slice of the copy to the specified values. The rowStart and colStart parameters specify the upper left index location of the slice to set.

Parameters:

values - New values for the specified slice.

rowStart - Starting row index for the slice (inclusive).

colStart - Starting column index for the slice (inclusive).

Returns:

A copy of this matrix with the given slice set to the specified values.

Throws:

IndexOutOfBoundsException - If rowStart or colStart are not within the matrix.

IllegalArgumentException - If the values slice, with upper left corner at the specified location, does not fit completely within this matrix.