TSparseMtx.ArcCoth Method

Overload List

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

Overload 1: TMtxVec ArcCoth

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

Matrix a = new Matrix();
a.SetIt(2, 2, false, new double[] { 1.5, 2.0, 3.0, 5.0 });
a.ArcCoth();
Matrix expected = new Matrix();
expected.SetIt(2, 2, false, new double[] { 0.80471895621705, 0.549306144334055, 0.346573590279973, 0.202732554054082 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Matrix.ArcCoth: mismatch");

Indexed: TMtxVec ArcCoth(Int32 Index, Int32 Len)

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

Calculate the inverser hyperbolic cotangens 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 calling object. Size and Dew.Math.TMtxVec.Complex properties of calling object are adjusted automatically.

Examples

Matrix a = new Matrix();
Matrix x = new Matrix();
x.SetIt(2, 2, false, new double[] { 1.5, 2.0, 3.0, 5.0 });
a.ArcCoth(x);
Matrix expected = new Matrix();
expected.SetIt(2, 2, false, new double[] { 0.80471895621705, 0.549306144334055, 0.346573590279973, 0.202732554054082 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Matrix.ArcCoth: mismatch");

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

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