Vector.Difference Method

Vector Class

Overload List

#SignatureDescription
1function Difference(const Vec: TMtxVec; Lag: Integer): TVec;Calculate the difference for all Vec elements and store the results in the calling vector.
2function Difference(Lag: Integer): TVec;The difference between two succesive vector elements.
3function Difference(const Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TMtxVec;Difference.

Overload 1: function Difference(const Vec: TMtxVec; Lag: Integer): TVec;

Calculate the difference for all Vec elements and store the results in the calling vector.

#NameTypeDescription
1VecTMtxVec
2LagInteger

Result: stored in self (calling object), returns self for chaining

Remarks:

The Vector.Length of the calling vector is set to one less the length of Vec and Vector.Complex property is set to Vec.Complex.

Overload 2: function Difference(Lag: Integer): TVec;

The difference between two succesive vector elements.

#NameTypeDescription
1LagInteger

Result: stored in self (calling object), returns self for chaining

Remarks:

Calculate the difference for all calling vector elements. The following formula is used to calculate the difference:

Δ[k]=Vec[k+1]−Vec[k],0≤k<Vec.Length−1\Delta [k] = \text{Vec}[k+1] - \text{Vec}[k], \quad 0\leq k < \text{Vec.Length}-1

The Length of calling vector is automatically decremented by one.

Overload 3: function Difference(const Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Difference.

#NameTypeDescription
1VecTMtxVec
2VecIndexInteger
3IndexIntegerstart index
4LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

Calculate the difference for Vec elements [VecIndex]..[VecIndex+Len-1] and store the results in the calling object elements [Index]..[Index+Len-1]. Size and Vector.Complex properties of the calling vector must be set explicitly. The following formula is used to calculate the difference:

Δ[k]=Vec[k+1]−Vec[k],0≤k<Vec.Length−1\Delta [k] = \text{Vec}[k+1] - \text{Vec}[k], \quad 0\leq k < \text{Vec.Length}-1

An exception is raised if Vector.ConditionCheck is True and array borders are overrun or underrun.