TSparseMtx.Coth Method

Overload List

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

Overload 1: function Coth: TMtxVec;

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,b: Matrix;
begin
    a.SetIt(2,2,False,[1,1.5,2,0.3]);
    a.Coth;
    a := Coth(a);
    b.Coth(a);   //same as
    b := Coth(a);
end;

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

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: TMtxVec): TMtxVec;

Calculate the hyperbolic cotangens for all X object elements.

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx

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

Remarks:

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

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

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

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx
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 TMtxVec.Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun.