TMtx::DotProd Method

TMtx Class

Overload List

#SignatureDescription
1double DotProd(TMtxVec *Vec);Scalar product of two real arrays.
2double DotProd(TMtxVec *Vec, int VecIndex, int Index, int Len);Returns the scalar product between Vec elements [VecIndex]..[VecIndex+Len-1] and calling object elements [Index]..[Index+Len-1].

Overload 1: double DotProd(TMtxVec *Vec);

Scalar product of two real arrays.

#NameTypeDescription
1VecTMtxVec *
Remarks:

Calculates the dot product (scalar value) of the calling object and Vec object and returns a real scalar value. The dot product is defined by the equation:

V⋅V=∑k=0Length−1V[k]⋅V[k]\text{V}\cdot \text{V} = \sum _{k=0} ^{\text{Length}-1}\text{V}[k]\cdot \text{V}[k]

Both objects must be of equal size. If they are not, the method will return the dot product of the largest sub-array.

See Also: TMtx::DotProdc
Declared in Dew::Math::TDenseMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler

Overload 2: double DotProd(TMtxVec *Vec, int VecIndex, int Index, int Len);

Returns the scalar product between Vec elements [VecIndex]..[VecIndex+Len-1] and calling object elements [Index]..[Index+Len-1].

#NameTypeDescription
1VecTMtxVec *
2VecIndexint
3Indexint
4Lenint
Remarks:

An exception is raised if Vec and calling object TMtx::Complex property is True. An exception is raised if TMtx::ConditionCheck is True and array borders are overrun or underrun.

Declared in Dew::Math::TDenseMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler