CSMat.Equals Method (CSMat, FSharpOption(Double))

Liquid Quantum Simulator

previous page next page
CSMatEquals Method (CSMat, FSharpOptionDouble)
Determines whether this matrix is equal to another.

Namespace: Microsoft.Research.Liquid
Assembly: Liquid1 (in Liquid1.dll) Version: 1.0.5981.24943 (1.0.*)
Syntax
F#
Copy
member Equals : 
        m2 : CSMat * 
        tol : FSharpOption<float> -> bool

Parameters

m2
Type: Microsoft.Research.LiquidCSMat
The sparse matrix to compare to.
tol
Type: Microsoft.FSharp.CoreFSharpOptionDouble
An optional tolerance for considering real or imaginary parts equal. The default is Complex.Tol.

Return Value

Type: Boolean
true if the matrices are equal, within the tolerance limit, or false otherwise.
See Also
previous page start next page