Matrix::Ln Method

Matrix Struct

Overload List

#SignatureDescription
1TMtxVec *Ln() const;Natural logarithm.
2TMtxVec *Ln(TMtxVec *X) const;Calculate the natural algorithm for all X elements and store the results in the calling object.
3TMtxVec *Ln(int Index, int Len) const;Calculate the natural logarithm for calling object elements [Index]..[Index+Len-1] in-place.
4TMtxVec *Ln(TMtxVec *X, int XIndex, int Index, int Len) const;Calculate the natural logarithm for X elements [XIndex]..[XIndex+Len-1] and store the results in the calling object elements [Index]..[Index+Len-1].

Overload 1: TMtxVec *Ln() const;

Natural logarithm.

Remarks:

Calculate the natural log for all calling 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>{ 1.0, 2.71828182845905, 7.38905609893065, 20.0855369231877 });
    a.Ln();
    Matrix expected;
    expected.SetIt(2, 2, false, DewArray<double>{ 0.0, 1.0, 2.0, 3.0 });
    if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
        throw tException("Matrix.Ln: 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, 2, 3, 4});
    a.Ln(); //same as:
    a = Ln(a);
    b.Ln(a); //same as:
    b = Ln(a);
}
See Also: Matrix::Exp
Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

Overload 2: TMtxVec *Ln(TMtxVec *X) const;

Calculate the natural algorithm for all X elements and store the results in the calling object.

#NameTypeDescription
1XTMtxVec *
Remarks:

Size and Matrix::Complex properties of the calling Matrix are set implicitly to match the X object.

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>{ 1.0, 2.71828182845905, 7.38905609893065, 20.0855369231877 });
    a.Ln(x);
    Matrix expected;
    expected.SetIt(2, 2, false, DewArray<double>{ 0.0, 1.0, 2.0, 3.0 });
    if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
        throw tException("Matrix.Ln: mismatch");
}
Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

Overload 3: TMtxVec *Ln(int Index, int Len) const;

Calculate the natural logarithm for calling object elements [Index]..[Index+Len-1] in-place.

#NameTypeDescription
1Indexint
2Lenint
Remarks:

An exception is raised if Matrix::ConditionCheck is True and array borders are overrun.

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

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

Calculate the natural logarithm for X elements [XIndex]..[XIndex+Len-1] and store the results in the 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 Matrix::ConditionCheck is True and array borders are overrun.

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