Overload List
| # | Signature | Description |
|---|---|---|
| 1 | TMtxVec *Tanh() const; | Hyperbolic tangens. |
| 2 | TMtxVec *Tanh(int Index, int Len) const; | Calculate the hyperbolic tangens for calling object elements [Index]..[Index+Len-1] in-place. |
| 3 | TMtxVec *Tanh(TMtxVec *X) const; | Calculate the hyperbolic tangens for all X object elements and store the results in the calling object. |
| 4 | TMtxVec *Tanh(TMtxVec *X, int XIndex, int Index, int Len) const; | Calculate the hyperbolic tangens for X object elements [XIndex]..[XIndex+Len-1]. The results are stored in the calling object elements [Index]..[Index+Len-1]. |
Overload 1: TMtxVec *Tanh() const;
Hyperbolic tangens.
Remarks:
Calculate the hyperbolic tangens 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.Tanh();
Matrix expected;
expected.SetIt(2, 2, false, DewArray<double>{ 0.0, 0.46211715726001, 0.761594155955765, 0.964027580075817 });
if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
throw tException("Matrix.Tanh: mismatch");
}#include "MtxExpr.h"
#include "Units.MtxExpr.h"
using namespace Dew;
using namespace Dew::Math;
using namespace Dew::Math::Units::MtxExpr;
void Example()
{
Matrix a, b;
a.SetIt(2, 2, false, DewArray<double>{1, 1.5, 2, 0.3});
a.Tanh(); //or
a = Tanh(a); //same as a.Tanh (in place operation)
b = Tanh(a); //not in place
b.Tanh(a); //not in place
}See Also: Matrix::ArcTanh, Matrix::Coth
Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler
Overload 2: TMtxVec *Tanh(int Index, int Len) const;
Calculate the hyperbolic tangens for calling object elements [Index]..[Index+Len-1] in-place.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Index | int | |
| 2 | Len | int |
Remarks:
An exception is raised if array borders are overrun.
Examples
#include "MtxExpr.h"
#include "Units.MtxExpr.h"
using namespace Dew;
using namespace Dew::Math;
using namespace Dew::Math::Units::MtxExpr;
void Example()
{
Matrix a, b;
a = {{1, 1.5}, {2, 0.3}};
a.Tanh(); //or
a = Tanh(a); //same as a.Tanh (in place operation)
b = Tanh(a); //not in place
b.Tanh(a); //not in place
}Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler
Overload 3: TMtxVec *Tanh(TMtxVec *X) const;
Calculate the hyperbolic tangens for all X object elements and store the results in the calling object.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | X | TMtxVec * |
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.Tanh(x);
Matrix expected;
expected.SetIt(2, 2, false, DewArray<double>{ 0.0, 0.46211715726001, 0.761594155955765, 0.964027580075817 });
if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
throw tException("Matrix.Tanh: mismatch");
}Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler
Overload 4: TMtxVec *Tanh(TMtxVec *X, int XIndex, int Index, int Len) const;
Calculate the hyperbolic tangens for X object elements [XIndex]..[XIndex+Len-1]. The results are stored in the calling object elements [Index]..[Index+Len-1].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | X | TMtxVec * | |
| 2 | XIndex | int | |
| 3 | Index | int | |
| 4 | Len | int |
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