TSparseMtx::ArcCoth Method

TSparseMtx Class

Overload List

#SignatureDescription
1TMtxVec *ArcCoth();Inverse hyperbolic cotangens.
2TMtxVec *ArcCoth(int Index, int Len);Calculate the inverse hyperbolic cotangens for calling object elements [Index]..[Index+Len-1] in-place.
3TMtxVec *ArcCoth(TMtxVec *X);Calculate the inverser hyperbolic cotangens for all X object elements.
4TMtxVec *ArcCoth(TMtxVec *X, int XIndex, int Index, int Len);Calculate the inverse hyperbolic cotangens for X object elements [XIndex]..[XIndex+Len-1].

Overload 1: TMtxVec *ArcCoth();

Inverse hyperbolic cotangens.

Remarks:

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

Examples
#include "Math387.h"
#include "MtxExpr.h"

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    Vector a;
    a.SetIt(DewArray<double>{ 1.5, 2.0, 3.0, 5.0 });
    a.ArcCoth();
    Vector expected;
    expected.SetIt(DewArray<double>{ 0.80471895621705, 0.549306144334055, 0.346573590279973, 0.202732554054082 });
    if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
        throw tException("Vector.ArcCoth: mismatch");
}
See Also: TSparseMtx::Coth
Declared in Dew::Math::TMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler

Overload 2: TMtxVec *ArcCoth(int Index, int Len);

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

#NameTypeDescription
1Indexint
2Lenint
Remarks:

An exception is raised if array borders are overrun.

Declared in Dew::Math::TMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler

Overload 3: TMtxVec *ArcCoth(TMtxVec *X);

Calculate the inverser hyperbolic cotangens for all X object elements.

#NameTypeDescription
1XTMtxVec *
Remarks:

Store the results in calling object. Size and TSparseMtx::Complex properties of calling object are adjusted automatically.

Examples
#include "Math387.h"
#include "MtxExpr.h"

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    Vector a;
    Vector x;
    x.SetIt(DewArray<double>{ 1.5, 2.0, 3.0, 5.0 });
    a.ArcCoth(x);
    Vector expected;
    expected.SetIt(DewArray<double>{ 0.80471895621705, 0.549306144334055, 0.346573590279973, 0.202732554054082 });
    if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
        throw tException("Vector.ArcCoth: mismatch");
}
Declared in Dew::Math::TMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler

Overload 4: TMtxVec *ArcCoth(TMtxVec *X, int XIndex, int Index, int Len);

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

#NameTypeDescription
1XTMtxVec *
2XIndexint
3Indexint
4Lenint
Remarks:

The results are stored in the calling object elements [Index]..[Index+Len-1]. Size and TSparseMtx::Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun.

Declared in Dew::Math::TMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler