clMatrix.SubFrom Method

Overload List

#SignatureDescription
1function SubFrom(Value: TCplx): TOpenCLMtxVec;Subtract each of calling object elements from complex Value.
└ indexed: function SubFrom(Value: TCplx; Index: Integer; Len: Integer): TOpenCLMtxVec;
2function SubFrom(Value: TCplx; Vec: TOpenCLMtxVec): TOpenCLMtxVec;subtract complex Vec elements from Value.
└ indexed: function SubFrom(Value: TCplx; Vec: TOpenCLMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;
3function SubFrom(Value: Double): TOpenCLMtxVec;Subtraction from value.
└ indexed: function SubFrom(Value: Double; Index: Integer; Len: Integer): TOpenCLMtxVec;
4function SubFrom(Value: Double; Vec: TOpenCLMtxVec): TOpenCLMtxVec;subtract Vec elements from Value.
└ indexed: function SubFrom(Value: Double; Vec: TOpenCLMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Overload 1: function SubFrom(Value: TCplx): TOpenCLMtxVec;

Subtract each of calling object elements from complex Value.

#NameTypeDescription
1ValueTCplxscalar

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

Remarks:

If the calling vector s not complex, the conversion is performed automatically in a performance efficient way.

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

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

#NameTypeDescription
1ValueTCplxscalar
2IndexIntegerstart index
3LenIntegerelement count

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

Remarks:

Store the result in calling object. If the calling vector is not complex, the conversion to complex is performed automatically in performance efficient way. An exception is raised if array borders are overrun or underrun.

Overload 2: function SubFrom(Value: TCplx; Vec: TOpenCLMtxVec): TOpenCLMtxVec;

subtract complex Vec elements from Value.

#NameTypeDescription
1ValueTCplxscalar
2VecTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix

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

Remarks:

Stores the result in the calling object. Size property of the calling object is set automatically. clMatrix.Complex property of the calling object is set to True.

Indexed: function SubFrom(Value: TCplx; Vec: TOpenCLMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

subtract Vec elements [VecIndex]..[VecIndex+Len-1] from complex Value and store the result to the calling object elements [Index]..[Index+Len-1].

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

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

Remarks:

Size property of the calling object is not changed. An exception is raised if array borders are overrun or underrun. clMatrix.Complex property of the calling object is set to True.

Overload 3: function SubFrom(Value: Double): TOpenCLMtxVec;

Subtraction from value.

#NameTypeDescription
1ValueDoublescalar

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

Remarks:

Subtract each of calling object elements from Value.

See Also: clMatrix.Add, clMatrix.Sub

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

Subtract elements [Index]..[Index+Len-1] from Value.

#NameTypeDescription
1ValueDoublescalar
2IndexIntegerstart index
3LenIntegerelement count

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

Remarks:

Store the result in calling vector. An exception is raised if array borders are overrun or underrun.

Overload 4: function SubFrom(Value: Double; Vec: TOpenCLMtxVec): TOpenCLMtxVec;

subtract Vec elements from Value.

#NameTypeDescription
1ValueDoublescalar
2VecTOpenCLMtxVecsource TOpenCLVector or TOpenCLMatrix

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

Remarks:

Stores the result in the calling object. Size and clMatrix.Complex properties of calling object are adjusted automatically.

Indexed: function SubFrom(Value: Double; Vec: TOpenCLMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

subtract Vec elements [VecIndex]..[VecIndex+Len-1] from Value.

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

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

Remarks:

Stores the result to the calling object elements [Index]..[Index+Len-1]. Size property of the calling object is not changed. An exception is raised if array borders are overrun or underrun. clMatrix.Complex property of the calling object is adjusted automatically.