Click or drag to resize

MatrixStorageT Class

Represents the storage backing a matrix.
Inheritance Hierarchy

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

Type Parameters

T
The element type.

The MatrixStorageT type exposes the following members.

Constructors
 NameDescription
Protected methodMatrixStorageT Initializes a new instance of the MatrixStorageT class.
Top
Properties
 NameDescription
Public propertyIsDense True if the matrix storage format is dense.
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.
Public propertyItem Gets or sets the value at the given row and column, with range checking.
Top
Methods
 NameDescription
Public methodAsArray Gets the underlying two-dimensional array when directly available.
Public methodAsColumnArrays Gets the underlying column arrays when directly available.
Public methodAsColumnMajorArray Gets the underlying column-major array when directly available.
Public methodAsRowArrays Gets the underlying row arrays when directly available.
Public methodAsRowMajorArray Gets the underlying row-major array when directly available.
Public methodAt(Int32, Int32) Retrieves the requested element without range checking.
Public methodAt(Int32, Int32, T) Sets the element without range checking.
Public methodClear Sets all matrix entries to zero.
Public methodClear(Int32, Int32, Int32, Int32) Sets a submatrix to zero.
Public methodClearColumns Sets the specified columns to zero.
Public methodClearRows Sets the specified rows to zero.
Public methodCopyColumnTo Copies a column into vector storage.
Public methodCopyRowTo Copies a row into vector storage.
Public methodCopySubColumnTo Copies part of a column into vector storage.
Public methodCopySubMatrixTo Copies a submatrix into another storage instance.
Public methodCopySubRowTo Copies part of a row into vector storage.
Public methodCopyTo Copies this matrix into another storage instance.
Public methodEnumerate Enumerates all matrix values.
Public methodEnumerateIndexed Enumerates all matrix values together with their indices.
Public methodEnumerateNonZero Enumerates all non-zero matrix values.
Public methodEnumerateNonZeroIndexed Enumerates all non-zero matrix values together with their indices.
Public methodEquals(MatrixStorageT) Indicates whether the current object is equal to another object of the same type.
Public methodEquals(Object) Determines whether the specified Object is equal to the current Object.
(Overrides ObjectEquals(Object))
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.
Public methodFind2TOther Finds the first pair of elements from two matrices that matches a predicate.
Public methodFold2TOther, TState Folds values from this matrix and another matrix into a single state value.
Public methodFoldByColumnTU Folds each column into a target state array.
Public methodFoldByRowTU Folds each row into a target state array.
Public methodGetHashCode Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode)
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.
Public methodMap2To Maps pairs of values from two matrices into a target matrix.
Public methodMapIndexedInplace Applies an indexed mapping function to each value in place.
Public methodMapIndexedToTU Maps each indexed value into another matrix storage.
Public methodMapInplace Applies a mapping function to each value in place.
Public methodMapSubMatrixIndexedToTU Maps an indexed submatrix into another matrix storage.
Public methodMapToTU Maps each value into another matrix storage.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToArray Creates a rectangular array copy of the matrix data.
Public methodToColumnArrays Creates jagged column-array copies of the matrix data.
Public methodToColumnMajorArray Creates a column-major array copy of the matrix data.
Public methodToRowArrays Creates jagged row-array copies of the matrix data.
Public methodToRowMajorArray Creates a row-major array copy of the matrix data.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTransposeTo Copies the transpose of this matrix into another storage instance.
Top
Fields
 NameDescription
Public fieldColumnCount Gets the number of columns in the matrix.
Public fieldRowCount Gets the number of rows in the matrix.
Protected fieldStatic memberZero Gets the default zero value for the storage element type.
Top
See Also