Click or drag to resize

FloatHermitianMatrix Class

Class FloatHermitianMatrix represents a matrix of single-precision floating point complex values.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CoreFloatHermitianMatrix

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.3
Syntax
[SerializableAttribute]
public class FloatHermitianMatrix : ICloneable

The FloatHermitianMatrix type exposes the following members.

Constructors
  NameDescription
Public methodFloatHermitianMatrix(Int32)
Constructs a FloatHermitianMatrix instance with the specified size.
Public methodFloatHermitianMatrix(FloatComplexMatrix)
Constructs a square FloatHermitianMatrix instance by extracting the upper triangular part of a square general matrix.
Public methodFloatHermitianMatrix(FloatComplexVector)
Constructs a FloatHermitianMatrix instance using the data in the given vector.
Public methodFloatHermitianMatrix(FloatComplexVector, Int32)
Constructs a FloatHermitianMatrix instance with the specified size, and using the data in the given vector.
Top
Properties
  NameDescription
Public propertyCols
Gets the number of columns in the matrix.
Public propertyDataVector
Gets the data vector referenced by this matrix.
Public propertyItem
Gets and sets the value at the specified position. Symmetry is maintained.
Public propertyOrder
Gets the order of the matrix.
Public propertyRows
Gets the number of rows in the matrix.
Top
Methods
  NameDescription
Public methodStatic memberAdd(FloatComplex, FloatHermitianMatrix)
Adds a scalar and an Hermitian matrix.
Public methodStatic memberAdd(FloatHermitianMatrix, FloatComplex)
Adds an Hermitian matrix and a scalar.
Public methodStatic memberAdd(FloatHermitianMatrix, FloatHermitianMatrix)
Adds two Hermitian matrices.
Public methodClone
Creates a deep copy of this matrix.
Public methodDeepenThisCopy
Guarantees that there is only one reference to the underlying data and that this data is in contiguous storage.
Public methodStatic memberDivide(FloatComplex, FloatHermitianMatrix)
Divide a scalar by an Hermitian matrix.
Public methodStatic memberDivide(FloatHermitianMatrix, FloatComplex)
Divide an Hermitian matrix by a scalar.
Public methodStatic memberDivide(FloatHermitianMatrix, FloatHermitianMatrix)
Divide an Hermitian matrix by another.
Public methodEquals
Tests for equality of this matrix and another matrix. Two matrices are equal if they have the same dimensions and all values are equal.
(Overrides ObjectEquals(Object).)
Public methodGetHashCode
Returns an integer hash code for this matrix.
(Overrides ObjectGetHashCode.)
Public methodLeadingSubmatrix
Returns the k by k upper left corner of the matrix. The matrix and the submatrix share the same data.
Public methodMakeDiagonalReal
Sets the imaginary parts on the main diagonal to zero thereby meeting the strict definition of an Hermitian matrix.
Public methodStatic memberMultiply(FloatComplex, FloatHermitianMatrix)
Multiply a scalar and an Hermitian matrix.
Public methodStatic memberMultiply(FloatHermitianMatrix, FloatComplex)
Multiply an Hermitian matrix and a scalar.
Public methodStatic memberMultiply(FloatHermitianMatrix, FloatHermitianMatrix)
Multiply two lower Hermitian matrices.
Public methodStatic memberNegate
Negation operator.
Public methodOnDeserialized
Checks that the matrix is square following deserialization
Public methodResize
Changes the order of this matrix to that specified, adding zeros or truncating as necessary.
Public methodShallowCopy
Creates a shallow copy of this matrix.
Public methodStatic memberSubtract(FloatComplex, FloatHermitianMatrix)
Subtracts an Hermitian matrix from a scalar.
Public methodStatic memberSubtract(FloatHermitianMatrix, FloatComplex)
Subtracts a scalar from an Hermitian matrix.
Public methodStatic memberSubtract(FloatHermitianMatrix, FloatHermitianMatrix)
Subtracts one Hermitian matrix from another.
Public methodToGeneralMatrix
Converts this Hermitian matrix to a general matrix.
Public methodCode exampleToString (Overrides ObjectToString.)
Public methodCode exampleToString(String)
Returns a formatted string representation of this matrix. Numbers are displayed using the specified format.

ToTabDelimited

ToTabDelimited(String)

Public methodCode exampleToTabDelimited
Returns a formatted string representation of this matrix using tabs and newlines.
Public methodCode exampleToTabDelimited(String)
Returns a formatted string representation of this matrix using tabs and newlines. Numbers are formatted using the specified format string.
Public methodTranspose
Transposes the Hermitian matrix.
Top
Operators
  NameDescription
Public operatorStatic memberAddition(FloatComplex, FloatHermitianMatrix)
Adds a scalar and an Hermitian matrix.
Public operatorStatic memberAddition(FloatHermitianMatrix, FloatComplex)
Adds an Hermitian matrix and a scalar.
Public operatorStatic memberAddition(FloatHermitianMatrix, FloatHermitianMatrix)
Adds two Hermitian matrices.
Public operatorStatic memberDivision(FloatComplex, FloatHermitianMatrix)
Divide a scalar by an Hermitian matrix.
Public operatorStatic memberDivision(FloatHermitianMatrix, FloatComplex)
Divide an Hermitian matrix by a scalar.
Public operatorStatic memberDivision(FloatHermitianMatrix, FloatHermitianMatrix)
Divide an Hermitian matrix by another.
Public operatorStatic memberEquality
Tests for equality of two Hermitian matrices. Two matrices are equal if they have the same order and all values are equal.
Public operatorStatic member(FloatSymmetricMatrix to FloatHermitianMatrix)
Implicitly converts a FloatSymmetricMatrix instance into a FloatHermitianMatrix instance.
Public operatorStatic memberInequality
Tests for inequality of two Hermitian matrices. Two matrices are equal if they have the same order and all values are equal.
Public operatorStatic memberMultiply(FloatComplex, FloatHermitianMatrix)
Multiply a scalar and an Hermitian matrix.
Public operatorStatic memberMultiply(FloatHermitianMatrix, FloatComplex)
Multiply an Hermitian matrix and a scalar.
Public operatorStatic memberMultiply(FloatHermitianMatrix, FloatHermitianMatrix)
Multiply two lower Hermitian matrices. Multiply two lower Hermitian matrices.
Public operatorStatic memberSubtraction(FloatComplex, FloatHermitianMatrix)
Subtracts an Hermitian matrix from a scalar.
Public operatorStatic memberSubtraction(FloatHermitianMatrix, FloatComplex)
Subtracts a scalar from an Hermitian matrix.
Public operatorStatic memberSubtraction(FloatHermitianMatrix, FloatHermitianMatrix)
Subtracts one Hermitian matrix from another.
Public operatorStatic memberUnaryNegation
Negation operator.
Public operatorStatic memberUnaryPlus
Unary + operator. Just returns the input matrix.
Top
Remarks
An Hermitian matrix is equal to its conjugate transpose. In other words, A[i,j] = conj(A[j,i]) for all elements i,j in matrix A.
The matrix is stored in a vector column by column. For efficiency, only the upper triangle is stored. For example, the following 5 by 5 Hermitian matrix:
    | a00 a01 a02 a03 a04 |
    | a10 a11 a12 a13 a14 |
A = | a20 a21 a22 a23 a24 |
    | a30 a31 a32 a33 a34 |
    | a40 a41 a42 a43 a44 |
is stored in a data vector v as:
v = [a00 a01 a11 a02 a12 a22 a03 a13 a23 a33 a04 a14 a24 a34 a44 ]
In general, A[i,j] = v[j(j+1)/2+i], i<=j conj(v[i(i+1)/2+j]), j<i
See Also