| CSMat Class |
A sparse matrix of complex numbers.
Inheritance HierarchyNamespace: Microsoft.Research.Liquid
Assembly: Liquid1 (in Liquid1.dll) Version: 1.0.5981.24943 (1.0.*)
SyntaxF#
[<SerializableAttribute>] type CSMat = class end
The CSMat type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CSMat(Int32, FSharpListTupleInt32, Int32, Double, Double) |
Creates a matrix from a list of elements.
|
| CSMat(Int32, FSharpOptionBoolean) |
Creates a new square identity or zero matrix.
|
| CSMat(CMat, FSharpOptionDouble) |
Creates a sparse matrix from a dense matrix.
|
Properties| Name | Description | |
|---|---|---|
 | Item |
Gets an element of the matrix.
|
| Length |
The dimension of this matrix; that is, the number of rows or columns.
|
Methods| Name | Description | |
|---|---|---|
| Adj |
Computes the adjoint (complex conjugate transpose) of this matrix.
|
| Clear |
Clears out this matrix, setting all elements to zero.
|
| Copy |
Makes a copy of this matrix.
|
| Dense |
Creates a dense matrix from this sparse matrix.
|
| Dump |
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.
|
| DumpDense |
Dumps this sparse matrix in the same format as a dense matrix.
|
| DumpMCC |
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.
|
| DumpML |
Dumps this matrix in MatLab format.
|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Equals(CSMat, FSharpOptionDouble) |
Determines whether this matrix is equal to another.
|
| Filled |
Return indicies of filled entries in the sparse matrix (may include zeros)
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Kron(Int32) |
Computes the Kronecker Product of this matrix with an identity matrix.
The identity matrix is on the right-hand side of the product.
|
| Kron(CSMat) |
Computes the Kronecker Product of this matrix with another matrix.
|
| Mul(CSMat) |
Computes the product of this matrix and another matrix.
Highly efficient.
|
| Mul(CVec) |
Computes the product of this matric and a vector.
|
 | Read |
Reads a matrix from a stream.
The matrix must originally have been written using the
Write method.
|
| ToString |
Gets a string representation of this matrix.
Note that all non-zero elements are listed, so this string may be quite long.
(Overrides ObjectToString.) |
| UnitaryError |
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.
|
| Write |
Writes this matrix to a stream.
The matrix may be recreated by using the
Read method.
|
Operators| Name | Description | |
|---|---|---|
 | Multiply(CSMat, CSMat) |
Computes the product of two matrices.
Highly efficient.
|
| Multiply(CSMat, CVec) |
Computes the product of a matrix and a vector.
|
| MultiplyBang |
Computes the Kronecker product of two matrices
|
See Also