 | ReadOnlyDoubleMatrix Class |
Represents a read only collection of doubles arranged in rows and columns.
Provides methods to operate algebraically on matrices when operands are
both writable and read only.
Inheritance HierarchyNamespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.0.0
Syntaxpublic class ReadOnlyDoubleMatrix : IEnumerable<double>, IEnumerable, IList<double>, ICollection<double>, IReadOnlyList<double>, IReadOnlyCollection<double>, IComplexMatrixPatterns, IMatrixPatterns, IReadOnlyTabularCollection<double, DoubleMatrix>, ITabularCollection<double, DoubleMatrix>
The ReadOnlyDoubleMatrix type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ColumnNames |
Exposes the dictionary of column names, keyed by column indexes.
|
| Count |
Gets the number of entries in this instance.
|
| HasColumnNames |
Gets a value indicating whether this instance has at least a named column.
|
| HasRowNames |
Gets a value indicating whether this instance has at least a named row.
|
| IsBidiagonal |
Gets a value indicating whether this instance is bidiagonal.
|
| IsColumnVector |
Gets a value indicating whether this instance is a column vector.
|
| IsDiagonal |
Gets a value indicating whether this instance is diagonal.
|
| IsHermitian |
Gets a value indicating whether this instance is Hermitian.
|
| IsHessenberg |
Gets a value indicating whether this instance is Hessenberg.
|
| IsLowerBidiagonal |
Gets a value indicating whether this instance is lower bidiagonal.
|
| IsLowerHessenberg |
Gets a value indicating whether this instance is lower Hessenberg.
|
| IsLowerTriangular |
Gets a value indicating whether this instance is lower triangular.
|
| IsReadOnly |
Gets a value indicating whether this instance is read-only.
|
| IsRowVector |
Gets a value indicating whether this instance is a row vector.
|
| IsScalar |
Gets a value indicating whether this instance is scalar.
|
| IsSkewHermitian |
Gets a value indicating whether this instance is Skew-Hermitian.
|
| IsSkewSymmetric |
Gets a value indicating whether this instance is skew symmetric.
|
| IsSquare |
Gets a value indicating whether this instance is square.
|
| IsSymmetric |
Gets a value indicating whether this instance is symmetric.
|
| IsTriangular |
Gets a value indicating whether this instance is triangular.
|
| IsTridiagonal |
Gets a value indicating whether this instance is tridiagonal.
|
| IsUpperBidiagonal |
Gets a value indicating whether this instance is upper bidiagonal.
|
| IsUpperHessenberg |
Gets a value indicating whether this instance is upper Hessenberg.
|
| IsUpperTriangular |
Gets a value indicating whether this instance is upper triangular.
|
| IsVector |
Gets a value indicating whether this instance is a vector.
|
 | ItemInt32 |
Gets the entry of this instance corresponding to the specified linear
index.
|
| ItemIndexCollection, IndexCollection |
Gets the elements of this instance corresponding to the specified row
and column indexes.
|
| ItemIndexCollection, Int32 |
Gets the elements of this instance corresponding to the specified row
and column indexes.
|
| ItemIndexCollection, String |
Gets the elements of this instance corresponding to
the specified row and column indexes.
|
| ItemInt32, IndexCollection |
Gets the elements of this instance corresponding to the specified row
and column indexes.
|
| ItemInt32, Int32 |
Gets the element of this instance corresponding to the
specified row and column indexes.
|
| ItemInt32, String |
Gets the elements of this instance corresponding to the
specified row and column indexes.
|
| ItemString, IndexCollection |
Gets the elements of this instance corresponding to
the specified row and column indexes.
|
| ItemString, Int32 |
Gets the elements of this instance corresponding to the specified row
and column indexes.
|
| ItemString, String |
Gets the elements of this instance corresponding to
the specified row and column indexes.
|
| LowerBandwidth |
Gets the lower bandwidth of this instance.
|
| Name |
Gets or sets the name of this instance.
|
| NumberOfColumns |
Gets the number of columns of this instance.
|
| NumberOfRows |
Gets the number of rows of this instance.
|
| RowNames |
Exposes the dictionary of row names, keyed by row indexes.
|
| StorageOrder |
Gets the storage order of this instance.
|
| StorageScheme |
Gets the storage scheme of this instance.
|
| UpperBandwidth |
Gets the upper bandwidth of this instance.
|
Methods| Name | Description | |
|---|---|---|
  | Add(Complex, ReadOnlyDoubleMatrix) |
Determines the addition of a scalar to a matrix.
|
| Add(Double, ReadOnlyDoubleMatrix) |
Determines the addition of a scalar to a matrix.
|
| Add(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the sum of two matrices.
|
| Add(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the sum of two matrices.
|
| Add(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the sum of two matrices.
|
| Add(ReadOnlyDoubleMatrix, Double) |
Determines the addition of a matrix to a scalar.
|
| Add(ReadOnlyDoubleMatrix, Complex) |
Determines the addition of a matrix to a scalar.
|
| Apply |
Evaluates the specified function at each entry of this instance,
and returns a matrix whose entries are given by
the corresponding function values.
|
| AsColumnMajorDenseArray |
Returns a column major ordered, dense representation of this instance.
|
| Contains | Determines whether the ICollectionT contains a specific value. |
| CopyTo | |
| Divide(Complex, ReadOnlyDoubleMatrix) |
Determines the division of a scalar by a matrix.
|
| Divide(Double, ReadOnlyDoubleMatrix) |
Determines the division of a scalar by a matrix.
|
| Divide(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the division of a matrix by another.
|
| Divide(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the division of a matrix by another.
|
| Divide(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the division of a matrix by another.
|
| Divide(ReadOnlyDoubleMatrix, Double) |
Determines the division of a matrix by a scalar.
|
| Divide(ReadOnlyDoubleMatrix, Complex) |
Determines the division of a matrix by a scalar.
|
| ElementWiseMultiply(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the element wise product of two matrices.
|
| ElementWiseMultiply(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the element wise product of two matrices.
|
| ElementWiseMultiply(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the element wise product of two matrices.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Find |
Searches for entries in this instance that equal the specified value,
and returns their zero-based linear indexes.
|
| FindNonzero |
Searches for nonzero entries in this instance,
and returns their zero-based linear indexes.
|
| FindWhile |
Searches for entries in this instance that matches the conditions defined by the specified predicate,
and returns their zero-based linear indexes.
|
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf | Determines the index of a specific item in the IListT. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Multiply(Complex, ReadOnlyDoubleMatrix) |
Determines the multiplication of a scalar by a matrix.
|
| Multiply(Double, ReadOnlyDoubleMatrix) |
Determines the multiplication of a scalar by a matrix.
|
| Multiply(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the product of two matrices.
|
| Multiply(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the product of two matrices.
|
| Multiply(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the product of two matrices.
|
| Multiply(ReadOnlyDoubleMatrix, Double) |
Determines the multiplication of a matrix by a scalar.
|
| Multiply(ReadOnlyDoubleMatrix, Complex) |
Determines the multiplication of a matrix by a scalar.
|
| Negate |
Determines the negation of a matrix.
|
| Subtract(Complex, ReadOnlyDoubleMatrix) |
Determines the subtraction of a matrix from a scalar.
|
| Subtract(Double, ReadOnlyDoubleMatrix) |
Determines the subtraction of a matrix from a scalar.
|
| Subtract(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the difference between two matrices.
|
| Subtract(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the difference between two matrices.
|
| Subtract(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the difference between two matrices.
|
| Subtract(ReadOnlyDoubleMatrix, Double) |
Determines the subtraction of a scalar from a matrix.
|
| Subtract(ReadOnlyDoubleMatrix, Complex) |
Determines the subtraction of a scalar from a matrix.
|
| ToDouble |
Converts
from ReadOnlyDoubleMatrix to Double.
|
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
| Transpose |
Returns the transpose of this instance.
|
| TryGetColumnName |
Tries to get the name of the specified column.
|
| TryGetRowName |
Tries to get the name of the specified row.
|
| Vec |
Returns the vectorization of this instance.
|
| Vec(IndexCollection) |
Returns a column vector obtained by stacking the specified elements of this instance.
|
Operators| Name | Description | |
|---|---|---|
 | Addition(Complex, ReadOnlyDoubleMatrix) |
Determines the addition of a scalar to a matrix.
|
| Addition(Double, ReadOnlyDoubleMatrix) |
Determines the addition of a scalar to a matrix.
|
| Addition(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the sum of two matrices.
|
| Addition(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the sum of two matrices.
|
| Addition(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the sum of two matrices.
|
| Addition(ReadOnlyDoubleMatrix, Double) |
Determines the addition of a matrix to a scalar.
|
| Addition(ReadOnlyDoubleMatrix, Complex) |
Determines the addition of a matrix to a scalar.
|
| Division(Complex, ReadOnlyDoubleMatrix) |
Determines the division of a scalar by a matrix.
|
| Division(Double, ReadOnlyDoubleMatrix) |
Determines the division of a scalar by a matrix.
|
| Division(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the division of a matrix by another.
|
| Division(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the division of a matrix by another.
|
| Division(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the division of a matrix by another.
|
| Division(ReadOnlyDoubleMatrix, Double) |
Determines the division of a matrix by a scalar.
|
| Division(ReadOnlyDoubleMatrix, Complex) |
Determines the division of a matrix by a scalar.
|
| (ReadOnlyDoubleMatrix to Double) |
Performs an explicit conversion
from ReadOnlyDoubleMatrix to Double.
|
| Multiply(Complex, ReadOnlyDoubleMatrix) |
Determines the multiplication of a scalar by a matrix.
|
| Multiply(Double, ReadOnlyDoubleMatrix) |
Determines the multiplication of a scalar by a matrix.
|
| Multiply(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the product of two matrices.
|
| Multiply(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the product of two matrices.
|
| Multiply(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the product of two matrices.
|
| Multiply(ReadOnlyDoubleMatrix, Double) |
Determines the multiplication of a matrix by a scalar.
|
| Multiply(ReadOnlyDoubleMatrix, Complex) |
Determines the multiplication of a matrix by a scalar.
|
| Subtraction(Complex, ReadOnlyDoubleMatrix) |
Determines the subtraction of a matrix from a scalar.
|
| Subtraction(Double, ReadOnlyDoubleMatrix) |
Determines the subtraction of a matrix from a scalar.
|
| Subtraction(DoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the difference between two matrices.
|
| Subtraction(ReadOnlyDoubleMatrix, DoubleMatrix) |
Determines the difference between two matrices.
|
| Subtraction(ReadOnlyDoubleMatrix, ReadOnlyDoubleMatrix) |
Determines the difference between two matrices.
|
| Subtraction(ReadOnlyDoubleMatrix, Double) |
Determines the subtraction of a scalar from a matrix.
|
| Subtraction(ReadOnlyDoubleMatrix, Complex) |
Determines the subtraction of a scalar from a matrix.
|
| UnaryNegation |
Determines the negation of a matrix.
|
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | ICollectionDoubleAdd |
Adds an item to the ICollectionT.
This implementation always throws a NotSupportedException.
|
| ICollectionDoubleClear |
Removes all items from the ICollectionT.
This implementation always throws a NotSupportedException.
|
| ICollectionDoubleRemove |
Removes the first occurrence of a specific object from
the ICollectionT.
This implementation always throws a NotSupportedException.
|
| IEnumerableGetEnumerator |
Returns an enumerator that iterates through a collection.
|
| IListDoubleInsert |
Inserts an item to the IListT at the specified index.
This implementation always throws a NotSupportedException.
|
 | IListDoubleItem |
Gets the element at the specified index.
A NotSupportedException occurs if you try to set the item
at the specified index.
|
| IListDoubleRemoveAt |
Removes the IListT item at the specified index.
This implementation always throws a NotSupportedException.
|
| ITabularCollectionDouble, DoubleMatrixItemIndexCollection, IndexCollection |
Gets or sets the elements of this instance corresponding to the specified row
and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemIndexCollection, Int32 |
Gets or sets the elements of this instance corresponding to the specified row
and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemIndexCollection, String |
Gets or sets the elements of this instance corresponding to
the specified row and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemInt32, IndexCollection |
Gets or sets the elements of this instance corresponding to the specified row
and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemInt32, Int32 |
Gets or sets the element of this instance corresponding to the
specified row and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemInt32, String |
Gets or sets the elements of this instance corresponding to the
specified row and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemString, IndexCollection |
Gets or sets the elements of this instance corresponding to
the specified row and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemString, Int32 |
Gets or sets the elements of this instance corresponding to the specified row
and column indexes.
|
| ITabularCollectionDouble, DoubleMatrixItemString, String |
Gets or sets the elements of this instance corresponding to
the specified row and column indexes.
|
See Also