<< mps_log10 mpscilab mps_log2 >>

mpscilab >> mpscilab > mps_log1p

mps_log1p

Natural logarithm of every element plus one

Calling Sequence

mps_log1p( rop, op )
rop = mps_log1p( op )

Overloaded usage:

rop = log1p( op )

Arguments

rop

multi-precision matrix

op

Scilab or multi-precision matrix

Description

Computes the element-wise natural logarithm of op + 1 and returns the result in rop.

mps_log1p( rop, op )

Sets every element of rop to the natural logarithm of op + 1. rop must be a pre-initialized matrix of the same dimension as op.

rop = mps_log1p( op )

Creates a multi-precision matrix the same size and precision as op containing the result.

rop = log1p( op )

Overloaded Scilab primitive log1p(). Creates a multi-precision matrix the same size and precision as op containing the result.

Usage notes

Like most mps functions the mps_log1p( rop, op ) form is faster and can reuse the space of an existing matrix but requires an already initialized operand. Also, the same form can be used to perform an in-place operation when rop and op are the same.

Examples

// Standard usage.
A = [1 2; 3 4]
mpsA = mps_init2(A,100)
rop = mps_log1p(mpsA)

// Standard usage using a pre-initialized matrix.
A = [1 2; 3 4]
mpsA = mps_init2(A,100)
rop = mps_init(2,2,100)
mps_log1p(rop,mpsA)

// Same but using a Scilab matrix as input.
A = [1 2; 3 4]
rop = mps_init(2,2,100)
mps_log1p(rop,A)

// In-place computation.
A = [1 2; 3 4]
mpsA = mps_init2(A,100)
mps_log1p(mpsA)

// Overloaded usage.
A = [1 2; 3 4]
mpsA = mps_init2(A,100)
rop = log1p(mpsA)

See Also

<< mps_log10 mpscilab mps_log2 >>