Matrix::Sech Method

Overload List

#SignatureDescription
1TMtxVec *Sech() const;Hyperbolic secant.
2TMtxVec *Sech(int Index, int Len) const;Calculate the hyperbolic secant for calling object elements [Index]...[Index+Len-1] in-place.
3TMtxVec *Sech(TMtxVec *X) const;Calculate the hyperbolic secant for all X object elements and store the results in the calling object.
4TMtxVec *Sech(TMtxVec *X, int XIndex, int Index, int Len) const;Calculate the hyperbolic secant for X object elements [XIndex]..[XIndex+Len-1]. The results are stored in calling object elements [Index]..[Index+Len-1].

Overload 1: TMtxVec *Sech() const;

Hyperbolic secant.

Remarks:

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

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

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    Matrix a;
    a.SetIt(2, 2, false, DewArray<double>{ 0.0, 0.5, 1.0, 2.0 });
    a.Sech();
    Matrix expected;
    expected.SetIt(2, 2, false, DewArray<double>{ 1.0, 0.886818883970074, 0.648054273663885, 0.26580222883408 });
    if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
        throw tException("Matrix.Sech: mismatch");
}
See Also: Matrix::ArcSech, Matrix::Csch
Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

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

Calculate the hyperbolic secant 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::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

Overload 3: TMtxVec *Sech(TMtxVec *X) const;

Calculate the hyperbolic secant for all X object elements and store the results in the calling object.

#NameTypeDescription
1XTMtxVec *
Remarks:

Size and Matrix::Complex properties of calling object are adjusted automatically.

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

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    Matrix a;
    Matrix x;
    x.SetIt(2, 2, false, DewArray<double>{ 0.0, 0.5, 1.0, 2.0 });
    a.Sech(x);
    Matrix expected;
    expected.SetIt(2, 2, false, DewArray<double>{ 1.0, 0.886818883970074, 0.648054273663885, 0.26580222883408 });
    if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
        throw tException("Matrix.Sech: mismatch");
}
Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

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

Calculate the hyperbolic secant for X object elements [XIndex]..[XIndex+Len-1]. The results are stored in calling object elements [Index]..[Index+Len-1].

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

Size and Matrix::Complex properties of the calling object must be set explicitly. An exception is raised if array borders are overrun.

Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler