Click or drag to resize
CSMat Methods

The CSMat type exposes the following members.

Methods
  NameDescription
Public methodAdj
Computes the adjoint (complex conjugate transpose) of this matrix.
Public methodClear
Clears out this matrix, setting all elements to zero.
Public methodCopy
Makes a copy of this matrix.
Public methodDense
Creates a dense matrix from this sparse matrix.
Public methodDump
Dumps this matrix as a list of row-column indices and element complex values. Note that all non-zero elements are listed, so the output may be quite long.
Public methodDumpDense
Dumps this sparse matrix in the same format as a dense matrix.
Public methodDumpMCC
Dumps this matrix as a list of row-column indices and element squared magnitudes. Note that all non-zero elements are listed, so the output may be quite long.
Public methodDumpML
Dumps this matrix in MatLab format.
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEquals(CSMat, FSharpOptionDouble)
Determines whether this matrix is equal to another.
Public methodFilled
Return indicies of filled entries in the sparse matrix (may include zeros)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodKron(Int32)
Computes the Kronecker Product of this matrix with an identity matrix. The identity matrix is on the right-hand side of the product.
Public methodKron(CSMat)
Computes the Kronecker Product of this matrix with another matrix.
Public methodMul(CSMat)
Computes the product of this matrix and another matrix. Highly efficient.
Public methodMul(CVec)
Computes the product of this matric and a vector.
Public methodStatic memberRead
Reads a matrix from a stream. The matrix must originally have been written using the Write method.
Public methodToString
Gets a string representation of this matrix. Note that all non-zero elements are listed, so this string may be quite long.
(Overrides ObjectToString.)
Public methodUnitaryError
Performs a rough check to see if this matrix is actually unitary. It calculates the biggest deviation from 1 of the diagonal elements of (this adj)*this. In other words, it calculates the largest deviation of the length of a row, viewed as a complex vector, from 1. The orthogonality of different rows is not checked.
Public methodWrite
Writes this matrix to a stream. The matrix may be recreated by using the Read method.
Top
See Also