Click or drag to resize

SparseCompressedRowMatrixStorageT Class

Stores a sparse matrix in compressed-row format.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.LinearAlgebra.StorageMatrixStorageT
    Altaxo.Calc.LinearAlgebra.StorageSparseCompressedRowMatrixStorageT

Namespace: Altaxo.Calc.LinearAlgebra.Storage
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
Copy
[SerializableAttribute]
public class SparseCompressedRowMatrixStorage<T> : MatrixStorage<T>
where T : struct, new(), IEquatable<T>, IFormattable

Type Parameters

T
The type of the stored values.

The SparseCompressedRowMatrixStorageT type exposes the following members.

Properties
 NameDescription
Public propertyIsDense True if the matrix storage format is dense.
(Overrides MatrixStorageTIsDense)
Public propertyIsFullyMutable True if all fields of this matrix can be set to any value. False if some fields are fixed, like on a diagonal matrix.
(Overrides MatrixStorageTIsFullyMutable)
Public propertyItem Gets or sets the value at the given row and column, with range checking.
(Inherited from MatrixStorageT)
Public propertyValueCount Gets the number of non zero elements in the matrix.
Top
Methods
 NameDescription
Public methodAsArray Gets the underlying two-dimensional array when directly available.
(Inherited from MatrixStorageT)
Public methodAsColumnArrays Gets the underlying column arrays when directly available.
(Inherited from MatrixStorageT)
Public methodAsColumnMajorArray Gets the underlying column-major array when directly available.
(Inherited from MatrixStorageT)
Public methodAsRowArrays Gets the underlying row arrays when directly available.
(Inherited from MatrixStorageT)
Public methodAsRowMajorArray Gets the underlying row-major array when directly available.
(Inherited from MatrixStorageT)
Public methodAt(Int32, Int32) Retrieves the requested element without range checking.
(Overrides MatrixStorageTAt(Int32, Int32))
Public methodAt(Int32, Int32, T) Sets the element without range checking.
(Overrides MatrixStorageTAt(Int32, Int32, T))
Public methodClear Sets all matrix entries to zero.
(Overrides MatrixStorageTClear)
Public methodClear(Int32, Int32, Int32, Int32) Sets a submatrix to zero.
(Inherited from MatrixStorageT)
Public methodClearColumns Sets the specified columns to zero.
(Inherited from MatrixStorageT)
Public methodClearRows Sets the specified rows to zero.
(Inherited from MatrixStorageT)
Public methodCopyColumnTo Copies a column into vector storage.
(Inherited from MatrixStorageT)
Public methodCopyRowTo Copies a row into vector storage.
(Inherited from MatrixStorageT)
Public methodCopySubColumnTo Copies part of a column into vector storage.
(Inherited from MatrixStorageT)
Public methodCopySubMatrixTo Copies a submatrix into another storage instance.
(Inherited from MatrixStorageT)
Public methodCopySubRowTo Copies part of a row into vector storage.
(Inherited from MatrixStorageT)
Public methodCopyTo Copies this matrix into another storage instance.
(Inherited from MatrixStorageT)
Public methodEnumerate Enumerates all matrix values.
(Overrides MatrixStorageTEnumerate)
Public methodEnumerateIndexed Enumerates all matrix values together with their indices.
(Overrides MatrixStorageTEnumerateIndexed)
Public methodEnumerateNonZero Enumerates all non-zero matrix values.
(Overrides MatrixStorageTEnumerateNonZero)
Public methodEnumerateNonZeroIndexed Enumerates all non-zero matrix values together with their indices.
(Overrides MatrixStorageTEnumerateNonZeroIndexed)
Public methodEquals(MatrixStorageT) Indicates whether the current object is equal to another object of the same type.
(Inherited from MatrixStorageT)
Public methodEquals(Object) Determines whether the specified Object is equal to the current Object.
(Inherited from MatrixStorageT)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFind Finds the first element matching a predicate.
(Overrides MatrixStorageTFind(FuncT, Boolean, Zeros))
Public methodFind2TOther Finds the first pair of elements from two matrices that matches a predicate.
(Inherited from MatrixStorageT)
Public methodFindItem Find item Index in nonZeroValues array
Public methodFold2TOther, TState Folds values from this matrix and another matrix into a single state value.
(Inherited from MatrixStorageT)
Public methodFoldByColumnTU Folds each column into a target state array.
(Inherited from MatrixStorageT)
Public methodFoldByRowTU Folds each row into a target state array.
(Inherited from MatrixStorageT)
Public methodGetHashCode Returns a hash code for this instance.
(Overrides MatrixStorageTGetHashCode)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsMutableAt True if the specified field can be set to any value. False if the field is fixed, like an off-diagonal field on a diagonal matrix.
(Overrides MatrixStorageTIsMutableAt(Int32, Int32))
Public methodMap2To Maps pairs of values from two matrices into a target matrix.
(Inherited from MatrixStorageT)
Public methodMapIndexedInplace Applies an indexed mapping function to each value in place.
(Overrides MatrixStorageTMapIndexedInplace(FuncInt32, Int32, T, T, Zeros))
Public methodMapIndexedToTU Maps each indexed value into another matrix storage.
(Inherited from MatrixStorageT)
Public methodMapInplace Applies a mapping function to each value in place.
(Overrides MatrixStorageTMapInplace(FuncT, T, Zeros))
Public methodMapSubMatrixIndexedToTU Maps an indexed submatrix into another matrix storage.
(Inherited from MatrixStorageT)
Public methodMapToTU Maps each value into another matrix storage.
(Inherited from MatrixStorageT)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodNormalize Normalizes the storage ordering and removes explicit zero entries.
Public methodNormalizeDuplicates Eliminate duplicate entries by adding them together.
Public methodNormalizeOrdering Sorts the column indices within each row.
Public methodNormalizeZeros Removes explicit zero entries from the sparse storage.
Public methodStatic memberOfArray Creates a sparse compressed-row matrix storage from a two-dimensional array.
Public methodStatic memberOfColumnArrays Creates a sparse compressed-row matrix storage from column arrays.
Public methodStatic memberOfColumnEnumerables Creates a sparse compressed-row matrix storage from column enumerables.
Public methodStatic memberOfColumnMajorList Creates a sparse compressed-row matrix storage from column-major data.
Public methodStatic memberOfColumnVectors Creates a sparse compressed-row matrix storage from column vectors.
Public methodStatic memberOfCompressedSparseColumnFormat Create a new sparse matrix storage from a compressed sparse column (CSC) format. This new storage will be independent from the given arrays. A new memory block will be allocated.
Public methodStatic memberOfCompressedSparseRowFormat Create a new sparse storage from a compressed sparse row (CSR) format. This new storage will be independent from the given arrays. A new memory block will be allocated for storing the matrix.
Public methodStatic memberOfCoordinateFormat Create a new sparse storage from a coordinate (COO) format. This new storage will be independent from the given arrays. A new memory block will be allocated for storing the matrix.
Public methodStatic memberOfDiagonalInit Creates a sparse compressed-row matrix storage with initialized diagonal entries.
Public methodStatic memberOfIndexedEnumerable(Int32, Int32, IEnumerableTupleInt32, Int32, T) Creates a sparse compressed-row matrix storage from indexed values.
Public methodStatic memberOfIndexedEnumerable(Int32, Int32, IEnumerableValueTupleInt32, Int32, T) Creates a sparse compressed-row matrix storage from indexed tuple values.
Public methodStatic memberOfInit Creates a sparse compressed-row matrix storage initialized by an index-based initializer.
Public methodStatic memberOfMatrix Creates a sparse compressed-row matrix storage from another matrix storage.
Public methodStatic memberOfRowArrays Creates a sparse compressed-row matrix storage from row arrays.
Public methodStatic memberOfRowEnumerables Creates a sparse compressed-row matrix storage from row enumerables.
Public methodStatic memberOfRowMajorEnumerable Creates a sparse compressed-row matrix storage from row-major data.
Public methodStatic memberOfRowVectors Creates a sparse compressed-row matrix storage from row vectors.
Public methodStatic memberOfValue Creates a sparse compressed-row matrix storage initialized with a constant value.
Public methodPopulateExplicitZerosOnDiagonal Fill zeros explicitly on the diagonal entries as required by the Intel MKL direct sparse solver.
Public methodToArray Creates a rectangular array copy of the matrix data.
(Overrides MatrixStorageTToArray)
Public methodToColumnArrays Creates jagged column-array copies of the matrix data.
(Overrides MatrixStorageTToColumnArrays)
Public methodToColumnMajorArray Creates a column-major array copy of the matrix data.
(Overrides MatrixStorageTToColumnMajorArray)
Public methodToRowArrays Creates jagged row-array copies of the matrix data.
(Overrides MatrixStorageTToRowArrays)
Public methodToRowMajorArray Creates a row-major array copy of the matrix data.
(Overrides MatrixStorageTToRowMajorArray)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTransposeTo Copies the transpose of this matrix into another storage instance.
(Inherited from MatrixStorageT)
Top
Fields
 NameDescription
Public fieldColumnCount Gets the number of columns in the matrix.
(Inherited from MatrixStorageT)
Public fieldColumnIndices An array containing the column indices of the non-zero values. Element "j" of the array is the number of the column in matrix that contains the j-th value in the Values array.
Public fieldRowCount Gets the number of rows in the matrix.
(Inherited from MatrixStorageT)
Public fieldRowPointers The array containing the row indices of the existing rows. Element "i" of the array gives the index of the element in the Values array that is first non-zero element in a row "i". The last value is equal to ValueCount, so that the number of non-zero entries in row "i" is always given by RowPointers[i+i] - RowPointers[i]. This array thus has length RowCount+1.
Public fieldValues Array that contains the non-zero elements of matrix. Values of the non-zero elements of matrix are mapped into the values array using the row-major storage mapping described in a compressed sparse row (CSR) format.
Top
See Also