clMatrix.Coth Method

Overload List

#	Signature	Description
1	function Coth: TOpenCLMtxVec;	Hyperbolic cotangens.
	└ indexed: function Coth(Index: Integer; Len: Integer): TOpenCLMtxVec;
2	function Coth(const X: TOpenCLMtxVec): TOpenCLMtxVec;	Calculate the hyperbolic cotangens for all X object elements.
	└ indexed: function Coth(const X: TOpenCLMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TOpenCLMtxVec;

Overload 1: function Coth: TOpenCLMtxVec;

Hyperbolic cotangens.

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

Remarks:

Calculate the hyperbolic cotangens of all caling object elements in-place.

Examples

var a: clMatrix;
begin
    a.CopyFromArray(2,2,TSingleArray.Create(1,1.5,2,0.3));
    a.Coth;
end;

See Also: clMatrix.ArcTanh, clMatrix.Coth

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

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

#	Name	Type	Description
1	Index	Integer	start index
2	Len	Integer	element count

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

Remarks:

An exception is raised if array borders are overrun.

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

Calculate the hyperbolic cotangens for all X object elements.

#	Name	Type	Description
1	X	TOpenCLMtxVec

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

Remarks:

Store the results in the calling object. Size and clMatrix.Complex properties of calling object are adjusted automatically.

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

Calculate the hyperbolic cotangens for X object elements [XIndex]..[XIndex+Len-1].

#	Name	Type	Description
1	X	TOpenCLMtxVec
2	XIndex	Integer	X start index
3	Index	Integer	start index
4	Len	Integer	element count

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

Remarks:

The results are stored in 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.