TOpenCLVector.Scale Method

Overload List

#SignatureDescription
1function Scale(const Factor: TCplx): TOpenCLMtxVec;Multiply all calling object elements with a complex Value in-place.
└ indexed: function Scale(const Factor: TCplx; Index: Integer; Len: Integer): TOpenCLMtxVec;
2function Scale(const Factor: Double): TOpenCLMtxVec;Multiply object elements with Value.
└ indexed: function Scale(const Factor: Double; Index: Integer; Len: Integer): TOpenCLMtxVec;

Overload 1: function Scale(const Factor: TCplx): TOpenCLMtxVec;

Multiply all calling object elements with a complex Value in-place.

#NameTypeDescription
1FactorTCplxscalar

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

Indexed: function Scale(const Factor: TCplx; Index: Integer; Len: Integer): TOpenCLMtxVec;

Multipy calling object elements [Index]..[Index+Len-1] with complex Value in-place.

#NameTypeDescription
1FactorTCplxscalar
2IndexIntegerstart index
3LenIntegerelement count

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

Remarks:

An exception is raised if array borders are overrun or underrun.

Overload 2: function Scale(const Factor: Double): TOpenCLMtxVec;

Multiply object elements with Value.

#NameTypeDescription
1FactorDoublescalar

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

Remarks:

Multiply all calling object elements with Value in-place. This method is the same as the TOpenCLMtxVec.Mul method overloads multiplying with vector elements with a scalar.

Examples
var v: clVector;
begin
    v.CopyFromArray(TSingleArray.Create(2,3,5));  // v = [2,3,5]
    v.Scale(3); // v = [6,9,15]
end;

Indexed: function Scale(const Factor: Double; Index: Integer; Len: Integer): TOpenCLMtxVec;

Multipy calling object elements [Index]..[Index+Len-1] with Value in-place.

#NameTypeDescription
1FactorDoublescalar
2IndexIntegerstart index
3LenIntegerelement count

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

Remarks:

An exception is raised if array borders are overrun or underrun.