TSparseMtx::Ln Method

TSparseMtx Class

Overload List

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

Overload 1: TMtxVec *Ln();

Natural logarithm.

Remarks:

Calculate the natural log for all calling object elements in-place.

Examples
#include "Units.MtxVec.h"

using namespace Dew;
using namespace Dew::Math;
using namespace Dew::Math::Units::MtxVec;

void Example()
{
    TVec* a;
    CreateIt(a);
    a->SetIt(false, DewArray<double>{1,8});
    a->Ln();
    FreeIt(a);
}
#include "Math387.h"
#include "MtxExpr.h"

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    Vector a;
    a.SetIt(DewArray<double>{ 1.0, 2.71828182845905, 7.38905609893065, 20.0855369231877 });
    a.Ln();
    Vector expected;
    expected.SetIt(DewArray<double>{ 0.0, 1.0, 2.0, 3.0 });
    if (!a.IsEqual(expected, 1e-10, TCompare::cmpAbsolute))
        throw tException("Vector.Ln: mismatch");
}
See Also: TSparseMtx::Exp
Declared in Dew::Math::TMtxVec · Dew.Math/AbstractMtxVec.h · Cross-compiler

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

Calculate the natural algorithm for all X elements.

#NameTypeDescription
1XTMtxVec *
Remarks:

Store the results in the calling object. Size and TSparseMtx::Complex properties of the calling vector are set implicitly to match the X object.

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

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

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

#NameTypeDescription
1Indexint
2Lenint
Remarks:

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

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

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

Calculate the natural logarithm for X elements [XIndex]..[XIndex+Len-1].

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

Store the results 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 TSparseMtx::ConditionCheck is True and array borders are overrun.

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