TSparseMtx.Sinh Method

Overload List

#SignatureDescription
1function Sinh: TMtxVec;Hyperbolic sine.
└ indexed: function Sinh(Index: Integer; Len: Integer): TMtxVec;
2function Sinh(const X: TMtxVec): TMtxVec;Calculate the hyperbolic sine of all X object elements.
└ indexed: function Sinh(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Overload 1: function Sinh: TMtxVec;

Hyperbolic sine.

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

Remarks:

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

Examples
var a: Matrix;
begin
    a.SetIt(2,2,False,[1,1.5,2,0.3]);
    a.Sinh; // or
    a := Sinh(a);
end;
var
    a, expected: Matrix;
begin
    a := [[0.0, 0.5], [1.0, 2.0]];
    a.Sinh;
    expected := [[0.0, 0.521095305493747], [1.1752011936438, 3.62686040784702]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.Sinh: mismatch');
end;

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

Calculate the hyperbolic sine of 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 Sinh(const X: TMtxVec): TMtxVec;

Calculate the hyperbolic sine of all X object elements.

#NameTypeDescription
1XTMtxVecsource 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.

Examples
var
    a, x, expected: Matrix;
begin
    x := [[0.0, 0.5], [1.0, 2.0]];
    a.Sinh(x);
    expected := [[0.0, 0.521095305493747], [1.1752011936438, 3.62686040784702]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.Sinh: mismatch');
end;

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

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

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