TVec.Tanh Method — Dew Math

Overload List

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

Overload 1: TMtxVec Tanh

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

Vector a = new Vector();
a.SetIt(new double[] { 0.0, 0.5, 1.0, 2.0 });
a.Tanh();
Vector expected = new Vector();
expected.SetIt(new double[] { 0.0, 0.46211715726001, 0.761594155955765, 0.964027580075817 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Vector.Tanh: mismatch");

Vector a;
Vector b;
a.SetIt(false,new double[] {1,1.5,2,0.3});
a.Tanh; //or
a = Tanh(a); //same as a.Tanh  (in place operation)
b = Tanh(a); //!in place
b.Tanh(a);    //!in place

Indexed: TMtxVec Tanh(Int32 Index, Int32 Len)

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

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

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

Remarks:

An exception is raised if array borders are overrun.

Overload 2: TMtxVec Tanh(TMtxVec X)

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 Dew.Math.TMtxVec.Complex properties of calling object are adjusted automatically.

Examples

Vector a = new Vector();
Vector x = new Vector();
x.SetIt(new double[] { 0.0, 0.5, 1.0, 2.0 });
a.Tanh(x);
Vector expected = new Vector();
expected.SetIt(new double[] { 0.0, 0.46211715726001, 0.761594155955765, 0.964027580075817 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Vector.Tanh: mismatch");

Indexed: TMtxVec Tanh(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

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

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx
2	XIndex	Int32	X start index
3	Index	Int32	start index
4	Len	Int32	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 Dew.Math.TMtxVec.Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun.