Click or drag to resize

UnitMatrix Class

Represents a unit matrix.
Inheritance Hierarchy
SystemObject
  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.0.5.0 (4.0.5.0)
Syntax
public class UnitMatrix : AnySquareMatrix

The UnitMatrix type exposes the following members.

Properties
Methods
  NameDescription
Public methodColumn
Gets a copy of the specified column.
(Inherited from AnyRectangularMatrix.)
Public methodEquals(Object)
Determines whether the given object is an equal matrix.
(Inherited from AnyMatrixT.)
Public methodEquals(AnyMatrixT)
Determines whether the given matrix equals the current matrix.
(Inherited from AnyMatrixT.)
Public methodFill
Sets all matrix entries according to a supplied fill function.
(Inherited from AnyMatrixT.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFrobeniusNorm
Computes the Frobenius-norm of the matrix.
(Overrides AnyRectangularMatrixFrobeniusNorm.)
Public methodGetHashCode
Not a valid operation.
(Inherited from AnyMatrixT.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInfinityNorm
Computes the ∞-norm of the matrix.
(Overrides AnyRectangularMatrixInfinityNorm.)
Public methodMaxNorm
Computes the max-norm of the matrix.
(Overrides AnyRectangularMatrixMaxNorm.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMultiplySelfByTranspose
Computes the product of the matrix and its transpose.
(Inherited from AnyRectangularMatrix.)
Public methodMultiplyTransposeBySelf
Computes the product of the matrix's transpose and itself.
(Inherited from AnyRectangularMatrix.)
Public methodStatic memberOfDimension
Returns a unit matrix of the given dimension.
Public methodOneNorm
Computes the 1-norm of the matrix.
(Overrides AnyRectangularMatrixOneNorm.)
Public methodRow
Gets a copy of the specified row.
(Inherited from AnyRectangularMatrix.)
Public methodToArray
Copies the matrix into an array.
(Inherited from AnyMatrixT.)
Public methodToDiagonalMatrix
Returns a diagonal matrix with unit matrix entries.
Public methodToSquareMatrix
Returns a square matrix with unit matrix entries.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToSymmetricMatrix
Returns a symmetric matrix with unit matrix entries.
Public methodTrace
Computes the trace of the square matrix.
(Inherited from AnySquareMatrix.)
Top
Remarks

If 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