Overload List
| # | Signature | Description |
|---|---|---|
| 1 | TCplx DotProdc(TOpenCLMtxVec *Vec); | Scalar product of two complex arrays. |
| 2 | TCplx DotProdc(TOpenCLMtxVec *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]. |
| 3 | TCplx DotProdc(TOpenCLMtxVec *Vec, bool ConjVec); | Returns the scalar product between Vec and calling object complex elements. |
| 4 | TCplx DotProdc(TOpenCLMtxVec *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(TOpenCLMtxVec *Vec);
Scalar product of two complex arrays.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TOpenCLMtxVec * |
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 TOpenCLBase::Complex property is false. The dot product is defined by the equation:
Both objects must be of equal size. If they are not, the method will return the dot product of the largest sub-array.
Overload 2: TCplx DotProdc(TOpenCLMtxVec *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].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TOpenCLMtxVec * | |
| 2 | VecIndex | int | |
| 3 | Index | int | |
| 4 | Len | int |
An exception is raised if Vec and calling object TOpenCLBase::Complex property is False. An exception is raised if array borders are overrun or underrun.
Overload 3: TCplx DotProdc(TOpenCLMtxVec *Vec, bool ConjVec);
Returns the scalar product between Vec and calling object complex elements.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TOpenCLMtxVec * | |
| 2 | ConjVec | bool |
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 TOpenCLBase::Complex property is False.
Overload 4: TCplx DotProdc(TOpenCLMtxVec *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].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TOpenCLMtxVec * | |
| 2 | ConjVec | bool | |
| 3 | VecIndex | int | |
| 4 | Index | int | |
| 5 | Len | int |
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 TOpenCLBase::Complex property is False. An exception is raised if array borders are overrun or underrun.