TMtx::DotProdc Method

TMtx Class

Overload List

#SignatureDescription
1TCplx DotProdc(TMtxVec *Src1, TMtxVec *Src2, const bool ConjVec, const int VecIndex, const int Index, const int Len);
2TCplx DotProdc(TMtxVec *Vec);Scalar product of two complex arrays.
3TCplx DotProdc(TMtxVec *Vec, int VecIndex, int Index, int Len);Returns the scalar product between Vec (complex) elements [VecIndex]..[VecIndex+Len-1] and calling object (complex) elements [Index]..[Index+Len-1].
4TCplx DotProdc(TMtxVec *Vec, bool ConjVec);Returns the scalar product between Vec and calling object complex elements.
5TCplx DotProdc(TMtxVec *Vec, bool ConjVec, int VecIndex, int Index, int Len);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(TMtxVec *Src1, TMtxVec *Src2, const bool ConjVec, const int VecIndex, const int Index, const int Len);

#NameTypeDescription
1Src1TMtxVec *
2Src2TMtxVec *
3ConjVecconst bool
4VecIndexconst int
5Indexconst int
6Lenconst int
Declared in Dew::Math::TMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler

Overload 2: TCplx DotProdc(TMtxVec *Vec);

Scalar product of two complex arrays.

#NameTypeDescription
1VecTMtxVec *
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 TMtx::Complex property is false. 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.

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(true, DewArray<double>{1, 2, 3, 4});
    b->SetIt(true, DewArray<double>{5, 6, 7, 8});
    TCplx prod = a->DotProdc(b); //= (1+2i)*(5+6i)+(3+4i)*(7+8i)
    FreeIt(a, b);
}
See Also: TMtx::DotProd
Declared in Dew::Math::TDenseMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler

Overload 3: TCplx DotProdc(TMtxVec *Vec, int VecIndex, int Index, int Len);

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

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

An exception is raised if Vec and calling object TMtx::Complex property is False. 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

Overload 4: TCplx DotProdc(TMtxVec *Vec, bool ConjVec);

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

#NameTypeDescription
1VecTMtxVec *
2ConjVecbool
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 TMtx::Complex property is False.

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

Overload 5: TCplx DotProdc(TMtxVec *Vec, bool ConjVec, int VecIndex, int Index, int Len);

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

#NameTypeDescription
1VecTMtxVec *
2ConjVecbool
3VecIndexint
4Indexint
5Lenint
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 TMtx::Complex property is False. 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