Matrix.ArcCoth Method

Overload List

#SignatureDescription
1function ArcCoth: TMtxVec;Inverse hyperbolic cotangens.
└ indexed: function ArcCoth(Index: Integer; Len: Integer): TMtxVec;
2function ArcCoth(const X: TMtxVec): TMtxVec;Calculate the inverser hyperbolic cotangens for all X object elements and store the results in calling object.
└ indexed: function ArcCoth(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Overload 1: function ArcCoth: TMtxVec;

Inverse hyperbolic cotangens.

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

Remarks:

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

Examples
var
    a, expected: Matrix;
begin
    a := [[1.5, 2.0], [3.0, 5.0]];
    a.ArcCoth;
    expected := [[0.80471895621705, 0.549306144334055], [0.346573590279973, 0.202732554054082]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.ArcCoth: mismatch');
end;
See Also: Matrix.Coth

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

Calculate the inverse hyperbolic cotangens 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 ArcCoth(const X: TMtxVec): TMtxVec;

Calculate the inverser hyperbolic cotangens for all X object elements and store the results in calling object.

#NameTypeDescription
1XTMtxVec

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

Remarks:

Size and Matrix.Complex properties of calling object are adjusted automatically.

Examples
var
    a, x, expected: Matrix;
begin
    x := [[1.5, 2.0], [3.0, 5.0]];
    a.ArcCoth(x);
    expected := [[0.80471895621705, 0.549306144334055], [0.346573590279973, 0.202732554054082]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.ArcCoth: mismatch');
end;

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

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

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

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

Remarks:

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