TOpenCLVector.Sub Method

Overload List

#SignatureDescription
1function Sub(const Value: TCplx): TOpenCLMtxVec;Subtracts complex Value from all calling object complex elements.
└ indexed: function Sub(const Value: TCplx; Index: Integer; Len: Integer): TOpenCLMtxVec;
2function Sub(const Vec: TOpenCLMtxVec): TOpenCLMtxVec;Array subtraction.
└ indexed: function Sub(const Vec: TOpenCLMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;
3function Sub(const Src: TOpenCLMtxVec; const Value: TCplx): TOpenCLMtxVec;Subtract complex Value from Src.
└ indexed: function Sub(const Src: TOpenCLMtxVec; const Value: TCplx; SrcIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;
4function Sub(const Vec1: TOpenCLMtxVec; const Vec2: TOpenCLMtxVec): TOpenCLMtxVec;Subtract Vec2 elements from Vec1 elements.
└ indexed: function Sub(const Vec1: TOpenCLMtxVec; const Vec2: TOpenCLMtxVec; Vec1Index: Integer; Vec2Index: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;
5function Sub(const Src: TOpenCLMtxVec; const Value: Double): TOpenCLMtxVec;Subtract real Value from Src.
└ indexed: function Sub(const Src: TOpenCLMtxVec; const Value: Double; SrcIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;
6function Sub(const Value: Double): TOpenCLMtxVec;Subtracts Value from object elements.
└ indexed: function Sub(const Value: Double; Index: Integer; Len: Integer): TOpenCLMtxVec;

Overload 1: function Sub(const Value: TCplx): TOpenCLMtxVec;

Subtracts complex Value from all calling object complex elements.

#NameTypeDescription
1ValueTCplxscalar

Result: stored in self (calling object), returns self for chaining

Indexed: function Sub(const Value: TCplx; Index: Integer; Len: Integer): TOpenCLMtxVec;

Subtracts complex Value from calling object complex elements [Index]..[Index+Len-1].

#NameTypeDescription
1ValueTCplxscalar
2IndexIntegerstart index
3LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

An exception is raised if array borders are overrun.

Overload 2: function Sub(const Vec: TOpenCLMtxVec): TOpenCLMtxVec;

Array subtraction.

#NameTypeDescription
1VecTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix

Result: stored in self (calling object), returns self for chaining

Remarks:

Subtract each of Vec elements from corresponding elements in the calling object. An exception is raised if Vec and calling object size and TOpenCLBase.Complex properties do not match.

Indexed: function Sub(const Vec: TOpenCLMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Subtract Vec elements [VecIndex]..[VecIndex+Len-1] from corresponding calling object elements [Index]..[Index+Len-1].

#NameTypeDescription
1VecTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
2VecIndexInteger
3IndexIntegerstart index
4LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

The results are stored in the calling object elements [Index]..[Index+Len-1]. Size and TOpenCLBase.Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun or underrun.

Overload 3: function Sub(const Src: TOpenCLMtxVec; const Value: TCplx): TOpenCLMtxVec;

Subtract complex Value from Src.

#NameTypeDescription
1SrcTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
2ValueTCplxscalar

Result: stored in self (calling object), returns self for chaining

Remarks:

Store the results in calling object. Size and TOpenCLBase.Complex property of calling object are adjusted automatically.

Indexed: function Sub(const Src: TOpenCLMtxVec; const Value: TCplx; SrcIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Subtract complex Value from Src elements [SrcIndex]..[SrcIndex+Len-1].

#NameTypeDescription
1SrcTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
2ValueTCplxscalar
3SrcIndexIntegersource start index
4IndexIntegerstart index
5LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

Stores the result in calling object elements [Index]..[Index+Len-1]. Size and TOpenCLBase.Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun or underrun.

Overload 4: function Sub(const Vec1: TOpenCLMtxVec; const Vec2: TOpenCLMtxVec): TOpenCLMtxVec;

Subtract Vec2 elements from Vec1 elements.

#NameTypeDescription
1Vec1TOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
2Vec2TOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix

Result: stored in self (calling object), returns self for chaining

Remarks:

Stores the results in calling object. Size and TOpenCLBase.Complex property of calling object are adjusted automatically. An exception is raised if Vec1 and Vec2 size and TOpenCLBase.Complex property do not match.

Indexed: function Sub(const Vec1: TOpenCLMtxVec; const Vec2: TOpenCLMtxVec; Vec1Index: Integer; Vec2Index: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Subtract Vec22 elements [Vec2Index]..[Vec2Index+Len-1] from Vec1 object elements [Vec1Index]..[Vec1Index+Len-1].

#NameTypeDescription
1Vec1TOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
2Vec2TOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
3Vec1IndexInteger
4Vec2IndexInteger
5IndexIntegerstart index
6LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

Stores the results in calling object elements [Index]..[Index+Len-1]. Size and TOpenCLBase.Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun or underrun.

Overload 5: function Sub(const Src: TOpenCLMtxVec; const Value: Double): TOpenCLMtxVec;

Subtract real Value from Src.

#NameTypeDescription
1SrcTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
2ValueDoublescalar

Result: stored in self (calling object), returns self for chaining

Remarks:

Store the results in calling object. Size and TOpenCLBase.Complex property of calling object are adjusted automatically.

Indexed: function Sub(const Src: TOpenCLMtxVec; const Value: Double; SrcIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Subtract real Value from Src elements [SrcIndex]..[SrcIndex+Len-1].

#NameTypeDescription
1SrcTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix
2ValueDoublescalar
3SrcIndexIntegersource start index
4IndexIntegerstart index
5LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

Stores the result in calling object elements [Index]..[Index+Len-1]. Size and TOpenCLBase.Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun or underrun.

Overload 6: function Sub(const Value: Double): TOpenCLMtxVec;

Subtracts Value from object elements.

#NameTypeDescription
1ValueDoublescalar

Result: stored in self (calling object), returns self for chaining

Remarks:

Subtracts Value from all calling object elements.

Indexed: function Sub(const Value: Double; Index: Integer; Len: Integer): TOpenCLMtxVec;

Subtracts Value from calling object elements [Index]..[Index+Len-1].

#NameTypeDescription
1ValueDoublescalar
2IndexIntegerstart index
3LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

An exception is raised if array borders are overrun.