Vector.IsEqual Method

Overload List

#SignatureDescription
1Boolean IsEqual(TCplx Value)Compares complex Value with all calling object elements.
2Boolean IsEqual(TCplx Value, Double Tolerance, TCompare Compare)Compares complex Value with all calling object elements with Compare method and specified Tolerance.
3Boolean IsEqual(TMtxVec Vec)Compares two objects and returns True, if they are equal.
└ indexed: Boolean IsEqual(TMtxVec Vec, Int32 VecIndex, Int32 Index, Int32 Len)
4Boolean IsEqual(TMtxVec Vec, Double Precision, TCompare Compare)Compares Vec elements with coresponding calling object elements with Compare method and specified Precision.
└ indexed: Boolean IsEqual(TMtxVec Vec, Int32 VecIndex, Int32 Index, Int32 Len, Double Precision, TCompare Compare)
5Boolean IsEqual(Double Value)Compares real Value with all calling object elements.
6Boolean IsEqual(Double Value, Double Tolerance, TCompare Compare)Compares real Value with all calling object elements with Compare method and specified Tolerance.

Overload 1: Boolean IsEqual(TCplx Value)

Compares complex Value with all calling object elements.

#NameTypeDescription
1ValueTCplxscalar

Returns: Boolean

Overload 2: Boolean IsEqual(TCplx Value, Double Tolerance, TCompare Compare)

Compares complex Value with all calling object elements with Compare method and specified Tolerance.

#NameTypeDescription
1ValueTCplxscalar
2ToleranceDoublescalar
3CompareTCompare

Returns: Boolean

Overload 3: Boolean IsEqual(TMtxVec Vec)

Compares two objects and returns True, if they are equal.

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx

Returns: Boolean

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 Dew.Math.Vector.Complex and Dew.Math.Vector.Length properties and coresponding values. To compare matrices or sparse matrices, use the Equal method.

See Also: Matrix.Equal, TSparseMtx.Equal, Vector.Equal

Indexed: Boolean IsEqual(TMtxVec Vec, Int32 VecIndex, Int32 Index, Int32 Len)

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

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx
2VecIndexInt32
3IndexInt32start index
4LenInt32element count

Returns: Boolean

Overload 4: Boolean IsEqual(TMtxVec Vec, Double Precision, TCompare Compare)

Compares Vec elements with coresponding calling object elements with Compare method and specified Precision.

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx
2PrecisionDoublescalar
3CompareTCompare

Returns: Boolean

Indexed: Boolean IsEqual(TMtxVec Vec, Int32 VecIndex, Int32 Index, Int32 Len, Double Precision, TCompare Compare)

Compares Vec elements [VecIndex]..[VecIndex+Len-1] with calling object elements [Index]..[Index+Len-1] with Compare method and specified Precision.

#NameTypeDescription
1VecTMtxVecsource TVec or TMtx
2VecIndexInt32
3IndexInt32start index
4LenInt32element count
5PrecisionDoublescalar
6CompareTCompare

Returns: Boolean

Overload 5: Boolean IsEqual(Double Value)

Compares real Value with all calling object elements.

#NameTypeDescription
1ValueDoublescalar

Returns: Boolean

Overload 6: Boolean IsEqual(Double Value, Double Tolerance, TCompare Compare)

Compares real Value with all calling object elements with Compare method and specified Tolerance.

#NameTypeDescription
1ValueDoublescalar
2ToleranceDoublescalar
3CompareTCompare

Returns: Boolean