clMatrix.Ln Method

Overload List

#SignatureDescription
1function Ln: TOpenCLMtxVec;Natural logarithm.
└ indexed: function Ln(Index: Integer; Len: Integer): TOpenCLMtxVec;
2function Ln(const X: TOpenCLMtxVec): TOpenCLMtxVec;Calculate the natural algorithm for all X elements.
└ indexed: function Ln(const X: TOpenCLMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Overload 1: function Ln: TOpenCLMtxVec;

Natural logarithm.

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

Remarks:

Calculate the natural log for all calling object elements in-place.

Examples
var a: clMatrix;
begin
    a.CopyFromArray(2,2,TSingleArray.Create(1,2,3,4));
    a.Ln;
end;
See Also: clMatrix.Exp

Indexed: function Ln(Index: Integer; Len: Integer): TOpenCLMtxVec;

Calculate the natural logarithm for calling object elements [Index]..[Index+Len-1] in-place.

#NameTypeDescription
1IndexIntegerstart index
2LenIntegerelement count

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

Remarks:

An exception is raised if array borders are overrun.

Overload 2: function Ln(const X: TOpenCLMtxVec): TOpenCLMtxVec;

Calculate the natural algorithm for all X elements.

#NameTypeDescription
1XTOpenCLMtxVec

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

Remarks:

Store the results in the calling object. Size and clMatrix.Complex properties of the calling vector are set implicitly to match the X object.

Indexed: function Ln(const X: TOpenCLMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Calculate the natural logarithm for X elements [XIndex]..[XIndex+Len-1].

#NameTypeDescription
1XTOpenCLMtxVec
2XIndexIntegerX start index
3IndexIntegerstart index
4LenIntegerelement count

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

Remarks:

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