TVec.ArcTanh Method

Overload List

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

Overload 1: TMtxVec ArcTanh

Inverse hyperbolic tangens.

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

Remarks:

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

Examples

Vector a = new Vector();
a.SetIt(new double[] { 0.0, 0.25, 0.5, 0.75 });
a.ArcTanh();
Vector expected = new Vector();
expected.SetIt(new double[] { 0.0, 0.255412811882995, 0.549306144334055, 0.972955074527657 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Vector.ArcTanh: mismatch");

Indexed: TMtxVec ArcTanh(Int32 Index, Int32 Len)

Calculate the inverse 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 ArcTanh(TMtxVec X)

Calculate the inverse 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.25, 0.5, 0.75 });
a.ArcTanh(x);
Vector expected = new Vector();
expected.SetIt(new double[] { 0.0, 0.255412811882995, 0.549306144334055, 0.972955074527657 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Vector.ArcTanh: mismatch");

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

Calculate the inverse 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 storedi n 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.