TSparseMtx.IsEqual Method

Overload List

#SignatureDescription
1function IsEqual(const Value: TCplx): Boolean;Compares complex Value with all calling object elements.
2function IsEqual(const Value: TCplx; const Tolerance: Double; const Compare: TCompare): Boolean;Compares complex Value with all calling object elements.
3function IsEqual(const Vec: TMtxVec): Boolean;Compares two objects.
└ indexed: function IsEqual(const Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): Boolean;
4function IsEqual(const Vec: TMtxVec; const Precision: Double; const Compare: TCompare): Boolean;Compares Vec elements with coresponding calling object elements.
└ indexed: function IsEqual(const Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer; const Precision: Double; const Compare: TCompare): Boolean;
5function IsEqual(const Value: Double): Boolean;Compares real Value with all calling object elements.
6function IsEqual(const Value: Double; const Tolerance: Double; const Compare: TCompare): Boolean;Compares real Value with all calling object elements.

Overload 1: function IsEqual(const Value: TCplx): Boolean;

Compares complex Value with all calling object elements.

#NameTypeDescription
1ValueTCplxscalar

Returns: Boolean

Overload 2: function IsEqual(const Value: TCplx; const Tolerance: Double; const Compare: TCompare): Boolean;

Compares complex Value with all calling object elements.

#NameTypeDescription
1ValueTCplxscalar
2ToleranceDoublescalar
3CompareTCompare

Returns: Boolean

Remarks:

Algorithm uses the Compare method and specified Tolerance.

Overload 3: function IsEqual(const Vec: TMtxVec): Boolean;

Compares two objects.

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx

Returns: Boolean - True, if they are equal.

Remarks:

Compares two objects and returns True, if they are equal. The IsEqual uses cmpAbsolute comparison method with comparison tolerance of 10*EPS by default.

The method compares only TMtxVec.Complex and TMtxVecBase.Length properties and coresponding values. To compare matrices or sparse matrices, use the Math387.Equal method.

Indexed: function IsEqual(const Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): Boolean;

Compares Vec elements [VecIndex]..[VecIndex+Len-1] with calling object elements [Index]..[Index+Len-1].

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx
2VecIndexInteger
3IndexIntegerstart index
4LenIntegerelement count

Returns: Boolean

Overload 4: function IsEqual(const Vec: TMtxVec; const Precision: Double; const Compare: TCompare): Boolean;

Compares Vec elements with coresponding calling object elements.

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx
2PrecisionDoublescalar
3CompareTCompare

Returns: Boolean

Remarks:

Method uses comparison algorithm specified by TMtxVec.Precision property.

Indexed: function IsEqual(const Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer; const Precision: Double; const Compare: TCompare): Boolean;

Compares Vec elements [VecIndex]..[VecIndex+Len-1] with calling object elements [Index]..[Index+Len-1].

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx
2VecIndexInteger
3IndexIntegerstart index
4LenIntegerelement count
5PrecisionDoublescalar
6CompareTCompare

Returns: Boolean

Remarks:

Algorithm uses the Compare type and specified Precision.

Overload 5: function IsEqual(const Value: Double): Boolean;

Compares real Value with all calling object elements.

#NameTypeDescription
1ValueDoublescalar

Returns: Boolean

Overload 6: function IsEqual(const Value: Double; const Tolerance: Double; const Compare: TCompare): Boolean;

Compares real Value with all calling object elements.

#NameTypeDescription
1ValueDoublescalar
2ToleranceDoublescalar
3CompareTCompare

Returns: Boolean

Remarks:

Algorithm uses the Compare method and specified Tolerance.