clVector::DotProdc Method

Overload List

#	Signature	Description
1	TCplx DotProdc(TOpenCLMtxVec Vec) const*;	Scalar product of two complex arrays.
2	TCplx DotProdc(TOpenCLMtxVec Vec, int* VecIndex, int Index, int Len) const;	Returns the scalar product between Vec (complex) elements [VecIndex]..[VecIndex+Len-1] and calling object (complex) elements [Index]..[Index+Len-1].
3	TCplx DotProdc(TOpenCLMtxVec Vec, bool* ConjVec) const;	Returns the scalar product between Vec and calling object complex elements.
4	TCplx DotProdc(TOpenCLMtxVec Vec, bool* ConjVec, int VecIndex, int Index, int Len) const;	Returns the scalar product between Vec (complex) elements [VecIndex]..[VecIndex+Len-1] and calling object (complex) elements [Index]..[Index+Len-1].

Overload 1: TCplx DotProdc(TOpenCLMtxVec *Vec) const;

Scalar product of two complex arrays.

#	Name	Type	Description
1	Vec	TOpenCLMtxVec *

Remarks:

Calculates the dot product (scalar value) of the calling object and Vec object and returns a complex scalar value. An exception is raised if calling or Vec object clVector::Complex property is false. 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()
{
    TOpenCLVector *a, *b;
    CreateIt(a, b);
    a->CopyCplxFromArray(DewArray<double>{1,2,3,4});
    b->CopyCplxFromArray(DewArray<double>{5,6,7,8});
    TCplx prod = a->DotProdc(b); //= (1+2i)*(5+6i)+(3+4i)*(7+8i)
    FreeIt(a, b);
}

See Also: clVector::DotProd

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

Overload 2: TCplx DotProdc(TOpenCLMtxVec *Vec, int VecIndex, int Index, int Len) const;

Returns the scalar product between Vec (complex) elements [VecIndex]..[VecIndex+Len-1] and calling object (complex) 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 clVector::Complex property is False. An exception is raised if array borders are overrun or underrun.

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

Overload 3: TCplx DotProdc(TOpenCLMtxVec *Vec, bool ConjVec) const;

Returns the scalar product between Vec and calling object complex elements.

#	Name	Type	Description
1	Vec	TOpenCLMtxVec *
2	ConjVec	bool

Remarks:

If ConjVec is True, scalar product between calling object and conjugated Vec object elements is calculated. An exception is raised if Vec and calling object clVector::Complex property is False.

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

Overload 4: TCplx DotProdc(TOpenCLMtxVec *Vec, bool ConjVec, int VecIndex, int Index, int Len) const;

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

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

Remarks:

If ConjVec is True, scalar product between calling object and conjugated Vec object elements is calculated. An exception is raised if Vec and calling object clVector::Complex property is False. An exception is raised if array borders are overrun or underrun.

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