Matrix.Ln Method — Dew Math

Overload List

#	Signature	Description
1	TMtxVec Ln	Natural logarithm.
	└ indexed: TMtxVec Ln(Int32 Index, Int32 Len)
2	TMtxVec Ln(TMtxVec X)	Calculate the natural algorithm for all X elements and store the results in the calling object.
	└ indexed: TMtxVec Ln(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

Overload 1: TMtxVec Ln

Natural logarithm.

Result: stored in self (calling object), returns self for chaining

Remarks:

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

Examples

Matrix a = new Matrix();
a.SetIt(2, 2, false, new double[] { 1.0, 2.71828182845905, 7.38905609893065, 20.0855369231877 });
a.Ln();
Matrix expected = new Matrix();
expected.SetIt(2, 2, false, new double[] { 0.0, 1.0, 2.0, 3.0 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Matrix.Ln: mismatch");

Matrix a;
Matrix b;
a.SetIt(2,2,false,new double[] {1,2,3,4});
a.Ln;    //same as:
a = Ln(a);
b.Ln(a); //same as:
b = Ln(a);

See Also: Matrix.Exp

Indexed: TMtxVec Ln(Int32 Index, Int32 Len)

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

#	Name	Type	Description
1	Index	Int32	start index
2	Len	Int32	element count

Result: stored in self (calling object), returns self for chaining

Remarks:

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

Overload 2: TMtxVec Ln(TMtxVec X)

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

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx

Result: stored in self (calling object), returns self for chaining

Remarks:

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

Examples

Matrix a = new Matrix();
Matrix x = new Matrix();
x.SetIt(2, 2, false, new double[] { 1.0, 2.71828182845905, 7.38905609893065, 20.0855369231877 });
a.Ln(x);
Matrix expected = new Matrix();
expected.SetIt(2, 2, false, new double[] { 0.0, 1.0, 2.0, 3.0 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Matrix.Ln: mismatch");

Indexed: TMtxVec Ln(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

Calculate the natural logarithm for X elements [XIndex]..[XIndex+Len-1] and store the results in the calling object elements [Index]..[Index+Len-1].

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx
2	XIndex	Int32	X start index
3	Index	Int32	start index
4	Len	Int32	element count

Result: stored in self (calling object), returns self for chaining

Remarks:

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