clMatrix::DotProd Method

Overload List

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

Overload 1: double DotProd(TOpenCLMtxVec *Vec) const;

Scalar product of two real arrays.

#	Name	Type	Description
1	Vec	TOpenCLMtxVec *

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 "Units.clMtxVec.h"
#include "clMtxVec.h"

using namespace Dew;
using namespace Dew::Math;
using namespace Dew::Math::Units::ClMtxVec;

void Example()
{
    TOpenCLMatrix *a, *b;
    CreateIt(a, b);
    a->Size(2,2, TclFloatPrecision::clFloat, false);
    b->Size(2,2, TclFloatPrecision::clFloat, false);

    a->CopyFromArray(DewArray<double>{1,2,3,4});
    b->CopyFromArray(DewArray<double>{4,3,2,1});

    double prod = a->DotProd(b); // = 1*4 + 2*3 + 3*2 + 4*1
    FreeIt(a, b);
}

See Also: clMatrix::DotProdc

Declared in Dew::Math::clMatrix · Dew.Math/clMtxExpr.h · Cross-compiler

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

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

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

Remarks:

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

Declared in Dew::Math::clMatrix · Dew.Math/clMtxExpr.h · Cross-compiler