Package org.flag4j.core

Interface MatrixManipulationsMixin<T,X extends Number>

Type Parameters:

T - Matrix type.

X - Matrix entry type.

All Known Subinterfaces:

MatrixMixin<T,U,V,W,VV,X,TT,UU>

All Known Implementing Classes:

CMatrix, CooCMatrix, CooMatrix, CsrCMatrix, CsrMatrix, Matrix

public interface MatrixManipulationsMixin<T,X extends Number>

This interface specifies manipulations which all matrices should implement.

Method Summary

Modifier and Type	Method	Description
T	removeCol(int colIndex)	Removes a specified column from this matrix.
T	removeCols(int... colIndices)	Removes a specified set of columns from this matrix.
T	removeRow(int rowIndex)	Removes a specified row from this matrix.
T	removeRows(int... rowIndices)	Removes a specified set of rows from this matrix.
T	set(double value, int row, int col)	Sets an index of this matrix to the specified value.
T	set(X value, int row, int col)	Sets an index of this matrix to the specified value.
T	setCol(double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
T	setCol(int[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
T	setCol(Double[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
T	setCol(Integer[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
T	setCol(X[] values, int colIndex)	Sets a column of this matrix at the given index to the specified values.
T	setRow(double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
T	setRow(int[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
T	setRow(Double[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
T	setRow(Integer[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
T	setRow(X[] values, int rowIndex)	Sets a row of this matrix at the given index to the specified values.
T	setSlice(double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	setSlice(int[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	setSlice(Double[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	setSlice(Integer[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	setSlice(Matrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	setSlice(CooMatrix values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	setSlice(T values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	setSlice(X[][] values, int rowStart, int colStart)	Sets a slice of this matrix to the specified values.
T	swapCols(int colIndex1, int colIndex2)	Swaps columns in the matrix.
T	swapRows(int rowIndex1, int rowIndex2)	Swaps rows in the matrix.

Method Details

set

T set(double value,
 int row,
 int col)

Sets an index of this matrix to the specified value.

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A reference to this matrix.

set

T set(X value,
 int row,
 int col)

Sets an index of this matrix to the specified value.

Parameters:

value - Value to set.

row - Row index to set.

col - Column index to set.

Returns:

A reference to this matrix.

setCol

T setCol(X[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

T setCol(Double[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

T setCol(Integer[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

T setCol(double[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setCol

T setCol(int[] values,
 int colIndex)

Sets a column of this matrix at the given index to the specified values.

Parameters:

values - New values for the column.

colIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of rows of this matrix.

setRow

T setRow(X[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setRow

T setRow(Double[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setRow

T setRow(Integer[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setRow

T setRow(double[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setRow

T setRow(int[] values,
 int rowIndex)

Sets a row of this matrix at the given index to the specified values.

Parameters:

values - New values for the row.

rowIndex - The index of the column which is to be set.

Returns:

A reference to this matrix.

Throws:

IllegalArgumentException - If the values array has a different length than the number of columns of this matrix.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

setSlice

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

Sets a slice of this matrix 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 reference to this matrix.

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.

removeRow

T removeRow(int rowIndex)

Removes a specified row from this matrix.

Parameters:

rowIndex - Index of the row to remove from this matrix.

Returns:

a copy of this matrix with the specified row removed.

removeRows

T removeRows(int... rowIndices)

Removes a specified set of rows from this matrix.

Parameters:

rowIndices - The indices of the rows to remove from this matrix.

Returns:

a copy of this matrix with the specified rows removed.

removeCol

T removeCol(int colIndex)

Removes a specified column from this matrix.

Parameters:

colIndex - Index of the column to remove from this matrix.

Returns:

a copy of this matrix with the specified column removed.

removeCols

T removeCols(int... colIndices)

Removes a specified set of columns from this matrix.

Parameters:

colIndices - Indices of the columns to remove from this matrix.

Returns:

a copy of this matrix with the specified columns removed.

swapRows

T swapRows(int rowIndex1,
 int rowIndex2)

Swaps rows in the matrix.

Parameters:

rowIndex1 - Index of first row to swap.

rowIndex2 - index of second row to swap.

Returns:

A reference to this matrix.

swapCols

T swapCols(int colIndex1,
 int colIndex2)

Swaps columns in the matrix.

Parameters:

colIndex1 - Index of first column to swap.

colIndex2 - index of second column to swap.

Returns:

A reference to this matrix.