UnitMatrix Class |
Represents a unit matrix.
Inheritance HierarchySystemObject
Meta.Numerics.MatricesAnyMatrixDouble
Meta.Numerics.MatricesAnyRectangularMatrix
Meta.Numerics.MatricesAnySquareMatrix
Meta.Numerics.MatricesUnitMatrix
Meta.Numerics.MatricesAnyMatrixDouble
Meta.Numerics.MatricesAnyRectangularMatrix
Meta.Numerics.MatricesAnySquareMatrix
Meta.Numerics.MatricesUnitMatrix
Namespace: Meta.Numerics.Matrices
Assembly: Meta.Numerics (in Meta.Numerics.dll) Version: 4.1.4
SyntaxThe UnitMatrix type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ColumnCount |
Gets the number of matrix columns.
(Inherited from AnySquareMatrix.) |
| Dimension |
Gets or sets the dimension of the square matrix.
(Overrides AnySquareMatrixDimension.) |
| IsReadOnly |
Gets a flag indicating whether the matrix is read-only.
(Inherited from AnyMatrixT.) |
| Item |
Gets or sets the value of a matrix entry.
(Overrides AnyMatrixTItemInt32, Int32.) |
| RowCount |
Gets the number of matrix rows.
(Inherited from AnySquareMatrix.) |
Methods| Name | Description | |
|---|---|---|
 | Column |
Gets a copy of the specified column.
(Inherited from AnyRectangularMatrix.) |
| Equals(Object) |
Determines whether the given object is an equal matrix.
(Inherited from AnyMatrixT.) |
| Equals(AnyMatrixT) |
Determines whether the given matrix equals the current matrix.
(Inherited from AnyMatrixT.) |
| Fill |
Sets all matrix entries according to a supplied fill function.
(Inherited from AnyMatrixT.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FrobeniusNorm |
Computes the Frobenius-norm of the matrix.
(Overrides AnyRectangularMatrixFrobeniusNorm.) |
| GetHashCode |
Not a valid operation.
(Inherited from AnyMatrixT.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InfinityNorm |
Computes the ∞-norm of the matrix.
(Overrides AnyRectangularMatrixInfinityNorm.) |
| MaxNorm |
Computes the max-norm of the matrix.
(Overrides AnyRectangularMatrixMaxNorm.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MultiplySelfByTranspose |
Computes the product of the matrix and its transpose.
(Inherited from AnyRectangularMatrix.) |
| MultiplyTransposeBySelf |
Computes the product of the matrix's transpose and itself.
(Inherited from AnyRectangularMatrix.) |
 | OfDimension |
Returns a unit matrix of the given dimension.
|
| OneNorm |
Computes the 1-norm of the matrix.
(Overrides AnyRectangularMatrixOneNorm.) |
| Row |
Gets a copy of the specified row.
(Inherited from AnyRectangularMatrix.) |
| ToArray |
Copies the matrix into an array.
(Inherited from AnyMatrixT.) |
| ToDiagonalMatrix |
Returns a diagonal matrix with unit matrix entries.
|
| ToSquareMatrix |
Returns a square matrix with unit matrix entries.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToSymmetricMatrix |
Returns a symmetric matrix with unit matrix entries.
|
| Trace |
Computes the trace of the square matrix.
(Inherited from AnySquareMatrix.) |
RemarksIf you need to use the unit matrix in your calculations, this class will do the job with a minimal memory footprint. Use the static OfDimension(Int32) method to get a unit matrix of the desired dimension. Since this class can only ever represent a unit matrix, it is read-only, and any attempts to set elements will result in an InvalidOperationException. If you want to start with a unit matrix and then modify it, you can use the ToSquareMatrix, ToSymmetricMatrix, and ToDiagonalMatrix methods to produce modify-able matrices of those sorts with initial unit matrix entries.
See Also