TSparseMtx.Tanh Method

Overload List

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

Overload 1: function Tanh: TMtxVec;

Hyperbolic tangens.

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

Remarks:

Calculate the hyperbolic tangens 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.Tanh; //or
    a := Tanh(a); //same as a.Tanh  (in place operation)
    b := Tanh(a); //not in place
    b.Tanh(a);    //not in place
end;

var
    a, expected: Matrix;
begin
    a := [[0.0, 0.5], [1.0, 2.0]];
    a.Tanh;
    expected := [[0.0, 0.46211715726001], [0.761594155955765, 0.964027580075817]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.Tanh: mismatch');
end;

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

Calculate the hyperbolic tangens 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 Tanh(const X: TMtxVec): TMtxVec;

Calculate the hyperbolic tangens 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.

Examples

var
    a, x, expected: Matrix;
begin
    x := [[0.0, 0.5], [1.0, 2.0]];
    a.Tanh(x);
    expected := [[0.0, 0.46211715726001], [0.761594155955765, 0.964027580075817]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.Tanh: mismatch');
end;

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

Calculate the hyperbolic tangens 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 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.