Package org.flag4j.operations.sparse.coo.real

Class RealSparseMatrixGetSet

java.lang.Object

org.flag4j.operations.sparse.coo.real.RealSparseMatrixGetSet

public class RealSparseMatrixGetSet
extends Object

This class provides methods for getting and setting elements and slices from/to a real sparse matrix.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RealSparseMatrixGetSet()

Method Summary

Modifier and Type	Method	Description
private static CooMatrix	addNotInCol(List<Double> destEntries, List<Integer> destRowIndices, List<Integer> destColIndices, CooMatrix src, int colIdx)	Adds values from a sparse matrix to specified lists if the value is not within a specified column.
private static void	copyValuesNotInSlice(CooMatrix src, List<Double> entries, List<Integer> rowIndices, List<Integer> colIndices, int[] rowRange, int[] colRange)	Copies values in sparse matrix which do not fall in the specified row and column ranges.
static CooVector	getCol(CooMatrix src, int colIdx)	Gets a specified column from this sparse matrix.
static CooVector	getCol(CooMatrix src, int colIdx, int start, int end)	Gets a specified column range from this sparse matrix.
static CooVector	getRow(CooMatrix src, int rowIdx)	Gets a specified row from this sparse matrix.
static CooVector	getRow(CooMatrix src, int rowIdx, int start, int end)	Gets a specified row range from this sparse matrix.
static CooMatrix	getSlice(CooMatrix src, int rowStart, int rowEnd, int colStart, int colEnd)	Gets a specified rectangular slice of a sparse matrix.
private static boolean	inSlice(int row, int col, int rowStart, int rowEnd, int colStart, int colEnd)	Checks if an index is in the specified slice.
static double	matrixGet(CooMatrix src, int row, int col)	Gets the specified element from a sparse matrix.
static CooMatrix	matrixSet(CooMatrix src, int row, int col, double value)	Sets the specified element from a sparse matrix.
static CooMatrix	setCol(CooMatrix src, int colIdx, double[] col)	Sets a column of a sparse matrix to the entries of a dense array.
static CooMatrix	setCol(CooMatrix src, int colIdx, CooVector col)	Sets a column of a sparse matrix to the values in a sparse tensor.
static CooMatrix	setRow(CooMatrix src, int rowIdx, double[] row)	Sets a specified row of a real sparse matrix to the values of a dense array.
static CooMatrix	setSlice(CooMatrix src, double[][] values, int row, int col)	Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.
private static CooMatrix	setSlice(CooMatrix src, double[] values, int numRows, int numCols, int[] sliceRows, int[] sliceCols, int row, int col)	Sets a slice of a sparse matrix to values given in a 1d dense array.
static CooMatrix	setSlice(CooMatrix src, int[][] values, int row, int col)	Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.
static CooMatrix	setSlice(CooMatrix src, Double[][] values, int row, int col)	Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.
static CooMatrix	setSlice(CooMatrix src, Integer[][] values, int row, int col)	Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.
static CooMatrix	setSlice(CooMatrix src, Matrix values, int row, int col)	Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense matrix.
static CooMatrix	setSlice(CooMatrix src, CooMatrix values, int row, int col)	Copies a sparse matrix and sets a slice of the sparse matrix to the entries of another sparse matrix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RealSparseMatrixGetSet

private RealSparseMatrixGetSet()

Method Details

matrixGet

public static double matrixGet(CooMatrix src,
 int row,
 int col)

Gets the specified element from a sparse matrix.

Parameters:

src - Source matrix to get value from.

row - Row index of the value to get from the sparse matrix.

col - Column index of the value to get from the sparse matrix.

Returns:

The value in the sparse matrix at the specified indices.

matrixSet

public static CooMatrix matrixSet(CooMatrix src,
 int row,
 int col,
 double value)

Sets the specified element from a sparse matrix.

Parameters:

src - Sparse matrix to set value in.

row - Row index of the value to set in the sparse matrix.

col - Column index of the value to set in the sparse matrix.

value - Value to set.

Returns:

The

setRow

public static CooMatrix setRow(CooMatrix src,
 int rowIdx,
 double[] row)

Sets a specified row of a real sparse matrix to the values of a dense array.

Parameters:

src - Source matrix to set the row of.

rowIdx - Index of the row to set.

row - Dense array containing the entries of the row to set.

Returns:

A copy of the src matrix with the specified row set to the dense row array.

setCol

public static CooMatrix setCol(CooMatrix src,
 int colIdx,
 double[] col)

Sets a column of a sparse matrix to the entries of a dense array.

Parameters:

src - Source matrix to set column of.

colIdx - The index of the column to set within the src matrix.

col - The dense array containing the new column entries for the src array.

Returns:

A copy of the src matrix with the specified column set to the dense array.

Throws:

IllegalArgumentException - If the colIdx is not within the range of the matrix.

IllegalArgumentException - If the col array does not have the same length as the number of rows in src matrix.

setCol

public static CooMatrix setCol(CooMatrix src,
 int colIdx,
 CooVector col)

Sets a column of a sparse matrix to the values in a sparse tensor.

Parameters:

src - Source matrix to set column of.

colIdx - Index of the column to set.

col - New entries for the specified column.

Returns:

A copy of the src matrix with the specified column set to the col sparse vector.

Throws:

IllegalArgumentException - If the src matrix does not have the same number of rows as total entries in the col vector.

addNotInCol

private static CooMatrix addNotInCol(List<Double> destEntries,
 List<Integer> destRowIndices,
 List<Integer> destColIndices,
 CooMatrix src,
 int colIdx)

Adds values from a sparse matrix to specified lists if the value is not within a specified column.

Parameters:

destEntries - List to add non-zero entries from sparse matrix to.

destRowIndices - List to add non-zero row indices from sparse matrix to.

destColIndices - List to add non-zero column indices from sparse matrix to.

src - The sparse matrix to get non-zero values and indices from.

colIdx - Specified column to not add entries to the lists from.

Returns:

A sparse matrix made from the resulting destEntries, destRowIndices and destColIndices lists.

setSlice

public static CooMatrix setSlice(CooMatrix src,
 CooMatrix values,
 int row,
 int col)

Copies a sparse matrix and sets a slice of the sparse matrix to the entries of another sparse matrix.

Parameters:

src - Source sparse matrix to copy and set values of.

values - Values of the slice to be set.

row - Starting row index of slice.

col - Starting column index of slice.

Returns:

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

Throws:

IllegalArgumentException - If the values matrix does not fit in the src matrix given the row and column index.

setSlice

public static CooMatrix setSlice(CooMatrix src,
 double[][] values,
 int row,
 int col)

Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.

Parameters:

src - Source sparse matrix to copy and set values of.

values - Dense values of the slice to be set.

row - Starting row index of slice.

col - Starting column index of slice.

Returns:

A copy of the src matrix with the specified slice set to the values array.

Throws:

IllegalArgumentException - If the values array does not fit in the src matrix given the row and column index.

setSlice

public static CooMatrix setSlice(CooMatrix src,
 Matrix values,
 int row,
 int col)

Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense matrix.

Parameters:

src - Source sparse matrix to copy and set values of.

values - Dense matrix containing values of the slice to be set.

row - Starting row index of slice.

col - Starting column index of slice.

Returns:

A copy of the src matrix with the specified slice set to the values array.

Throws:

IllegalArgumentException - If the values array does not fit in the src matrix given the row and column index.

setSlice

public static CooMatrix setSlice(CooMatrix src,
 int[][] values,
 int row,
 int col)

Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.

Parameters:

src - Source sparse matrix to copy and set values of.

values - Dense values of the slice to be set.

row - Starting row index of slice.

col - Starting column index of slice.

Returns:

A copy of the src matrix with the specified slice set to the values array.

Throws:

IllegalArgumentException - If the values array does not fit in the src matrix given the row and column index.

setSlice

public static CooMatrix setSlice(CooMatrix src,
 Double[][] values,
 int row,
 int col)

Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.

Parameters:

src - Source sparse matrix to copy and set values of.

values - Dense values of the slice to be set.

row - Starting row index of slice.

col - Starting column index of slice.

Returns:

A copy of the src matrix with the specified slice set to the values array.

Throws:

IllegalArgumentException - If the values array does not fit in the src matrix given the row and column index.

setSlice

public static CooMatrix setSlice(CooMatrix src,
 Integer[][] values,
 int row,
 int col)

Copies a sparse matrix and sets a slice of the sparse matrix to the entries of a dense array.

Parameters:

src - Source sparse matrix to copy and set values of.

values - Dense values of the slice to be set.

row - Starting row index of slice.

col - Starting column index of slice.

Returns:

A copy of the src matrix with the specified slice set to the values array.

Throws:

IllegalArgumentException - If the values array does not fit in the src matrix given the row and column index.

setSlice

private static CooMatrix setSlice(CooMatrix src,
 double[] values,
 int numRows,
 int numCols,
 int[] sliceRows,
 int[] sliceCols,
 int row,
 int col)

Sets a slice of a sparse matrix to values given in a 1d dense array.

Parameters:

src - Source sparse matrix to copy non-slice from.

values - Dense value for slice.

numRows - Number of rows in the matrix represented by values.

numCols - Number of columns in the matrix represented by values.

sliceRows - Row indices for slice.

sliceCols - Column indices for slice.

row - Starting row index of slice.

col - Starting column index of slice.

Returns:

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

getRow

public static CooVector getRow(CooMatrix src,
 int rowIdx)

Gets a specified row from this sparse matrix.

Parameters:

src - Source sparse matrix to extract row from.

rowIdx - Index of the row to extract from the src matrix.

Returns:

Returns the specified row from this sparse matrix.

getRow

public static CooVector getRow(CooMatrix src,
 int rowIdx,
 int start,
 int end)

Gets a specified row range from this sparse matrix.

Parameters:

src - Source sparse matrix to extract row from.

rowIdx - Index of the row to extract from the src matrix.

start - Staring column index of the column to be extracted (inclusive).

end - Ending column index of the column to be extracted (exclusive)

Returns:

Returns the specified column range from this sparse matrix.

getCol

public static CooVector getCol(CooMatrix src,
 int colIdx)

Gets a specified column from this sparse matrix.

Parameters:

src - Source sparse matrix to extract column from.

colIdx - Index of the column to extract from the src matrix.

Returns:

Returns the specified column from this sparse matrix.

getCol

public static CooVector getCol(CooMatrix src,
 int colIdx,
 int start,
 int end)

Gets a specified column range from this sparse matrix.

Parameters:

src - Source sparse matrix to extract column from.

colIdx - Index of the column to extract from the src matrix.

start - Staring row index of the column to be extracted (inclusive).

end - Ending row index of the column to be extracted (exclusive)

Returns:

Returns the specified column range from this sparse matrix.

getSlice

public static CooMatrix getSlice(CooMatrix src,
 int rowStart,
 int rowEnd,
 int colStart,
 int colEnd)

Gets a specified rectangular slice of a sparse matrix.

Parameters:

src - Sparse matrix to extract slice from.

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

rowEnd - Ending row index of the slice (exclusive).

colStart - Staring column index of a slice (inclusive).

colEnd - Ending column index of the slice (exclusive).

Returns:

The specified slice of the sparse matrix.

inSlice

private static boolean inSlice(int row,
 int col,
 int rowStart,
 int rowEnd,
 int colStart,
 int colEnd)

Checks if an index is in the specified slice.

Parameters:

row - Row index of value.

col - Column index of value.

rowStart - Starting row index of slice (inclusive).

rowEnd - Ending row index of slice (exclusive).

colStart - Starting column index of slice (inclusive).

colEnd - Ending column index of slice (exclusive).

Returns:

True if the indices are in the slice. False otherwise.

copyValuesNotInSlice

private static void copyValuesNotInSlice(CooMatrix src,
 List<Double> entries,
 List<Integer> rowIndices,
 List<Integer> colIndices,
 int[] rowRange,
 int[] colRange)

Copies values in sparse matrix which do not fall in the specified row and column ranges.

Parameters:

src - Source sparse matrix to copy from.

entries - Destination list to add copied values to.

rowIndices - Destination list to add copied row indices to.

colIndices - Destination list to add copied column indices to.

rowRange - List of row indices to NOT copy from.

colRange - List of column indices to NOT copy from.