clMatrix::Coth Method

Overload List

#SignatureDescription
1TOpenCLMtxVec *Coth() const;Hyperbolic cotangens.
2TOpenCLMtxVec *Coth(int Index, int Len) const;Calculate the hyperbolic cotangens for calling object elements [Index]...[Index+Len-1] in-place.
3TOpenCLMtxVec *Coth(TOpenCLMtxVec *X) const;Calculate the hyperbolic cotangens for all X object elements.
4TOpenCLMtxVec *Coth(TOpenCLMtxVec *X, int XIndex, int Index, int Len) const;Calculate the hyperbolic cotangens for X object elements [XIndex]..[XIndex+Len-1].

Overload 1: TOpenCLMtxVec *Coth() const;

Hyperbolic cotangens.

Remarks:

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

Examples
#include "clMtxExpr.h"

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    clMatrix a;

    a.CopyFromArray(2, 2, DewArray<float>{1, 1.5, 2, 0.3});
    a.Coth();
}
See Also: clMatrix::ArcTanh, clMatrix::Coth
Declared in Dew::Math::clMatrix · Dew.Math/clMtxExpr.h · Cross-compiler

Overload 2: TOpenCLMtxVec *Coth(int Index, int Len) const;

Calculate the 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::clMatrix · Dew.Math/clMtxExpr.h · Cross-compiler

Overload 3: TOpenCLMtxVec *Coth(TOpenCLMtxVec *X) const;

Calculate the hyperbolic cotangens for all X object elements.

#NameTypeDescription
1XTOpenCLMtxVec *
Remarks:

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

Declared in Dew::Math::clMatrix · Dew.Math/clMtxExpr.h · Cross-compiler

Overload 4: TOpenCLMtxVec *Coth(TOpenCLMtxVec *X, int XIndex, int Index, int Len) const;

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

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

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

Declared in Dew::Math::clMatrix · Dew.Math/clMtxExpr.h · Cross-compiler