Click or drag to resize
CMat Class
A dense matrix of complex numbers.
Inheritance Hierarchy
SystemObject
  Microsoft.Research.LiquidCMat

Namespace: Microsoft.Research.Liquid
Assembly: Liquid1 (in Liquid1.dll) Version: 1.0.5981.24943 (1.0.*)
Syntax
F#
[<SerializableAttribute>]
type CMat =  class end

The CMat type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyItem
Gets an individual element of the matrix, as a Complex number.
Public propertyLength
The number of rows or columns in the matrix, for square matrices.
Public propertyLengthC
The number of columns in the matrix.
Public propertyLengthR
The number of rows in the matrix.
Top
Methods
  NameDescription
Public methodAdd
Adds another matrix to this matrix. The two matrices must have the same number of rows and columns.
Public methodAdj
Computes the adjoint (complex conjugate transpose) of this matrix.
Public methodClear
Clears this matrix, setting it to a 0x0 matrix.
Public methodCopy
Makes a new copy, independent copy of this matrix.
Public methodStatic memberCreMat
Creates an array that can be filled in and passed to the array-based CMat constructor.
Public methodStatic memberCreZer
Creates an array filled with zeros that can be filled in and passed to the array-based CMat constructor.
Public methodDiv
Scales this matrix by a constant divisor. This matrix is updated in place, rather than a new matrix being created.
Public methodDump
Dumps this matrix. Note that there is no limit on the size of the result; every row and column entry is included.
Public methodDumpML
Dumps this matrix in Matlab format for debugging.
Public methodDumpNarrow
Dumps this matrix. This method will produce a relatively compact representation of the matrix.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFixUnitary
Makes this matrix closer to being unitary by applying an iterative correction.
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(CMat)
Computes the Kronecker Product of this matrix with another matrix.
Public methodKron(Int32, FSharpOptionBoolean)
Computes the Kronecker Product of this matrix with an identity matrix
Public methodMul(Double)
Scales this matrix by a constant multiplier. This matrix is updated in place, rather than a new matrix being created.
Public methodMul(CMat)
Computes the product of this matrix with another matrix. This matrix is on the left-hand side of the product, and the argument matrix is on the right-hand side. This matrix must have the same number of columns as the other matrix has rows.
Public methodMul(CVec)
Calculates the product of this matrix and a vector. The vector's length must match the numder of columns in this matrix.
Public methodPower
Computes an integer power of this matrix. NOTE: This destroys the contents of the current matrix.
Public methodStatic memberRead
Reads a matrix from a stream.
Public methodToString
Gets a string representation of this matrix. Note that there is no limit on the size of the result; every row and column entry is included.
(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 for serialization.
Top
Operators
  NameDescription
Public operatorStatic memberAdditionAssignment
Adds one matrix to another.
Public operatorStatic memberDivisionAssignment
Scales a matrix by a constant divisor. The matrix is updated in place, rather than a new matrix being created.
Public operatorStatic memberMultiply(CMat, CMat)
Computes the product of two matrices. The first matrix must have the same number of columns as the second matrix has rows.
Public operatorStatic memberMultiply(CMat, CVec)
Computes the product of a matrix and a vector. The vector's length must match the numder of columns in the matrix.
Public operatorStatic memberMultiplyAssignment
Scales a matrix by a constant multiplier. The matrix is updated in place, rather than a new matrix being created.
Public operatorStatic memberMultiplyBang
Computes the Kronecker product of two matrices
Top
See Also

Reference

[T::Microsoft.Research.Liquid.CSMat]