TVec::DotProd Method

Overload List

#	Signature	Description
1	double DotProd(TMtxVec *Vec);	Scalar product of two real arrays.
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].

Overload 1: double DotProd(TMtxVec *Vec);

Scalar product of two real arrays.

#	Name	Type	Description
1	Vec	TMtxVec *

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:

\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.

Examples

#include "MtxVec.h"
#include "Units.MtxVec.h"

using namespace Dew;
using namespace Dew::Math;
using namespace Dew::Math::Units::MtxVec;

void Example()
{
    TVec *a, *b;
    CreateIt(a, b);
    a->SetIt(false, DewArray<double>{1,2,3,4});
    b->SetIt(false, DewArray<double>{5,6,7,8});
    double prod = a->DotProd(b); // = 1*5 + 2*6 + * 3*7 + 4*8
    FreeIt(a,b);
}

See Also: TVec::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].

#	Name	Type
1	Vec	TMtxVec *
2	VecIndex	int
3	Index	int
4	Len	int

Remarks:

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

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