ln: Logarithms.

View source: R/ln.R

lnR Documentation

Logarithms.

Description

To avoid confusion using the default 'log()' function, which is natural logarithm, but spells out like base 10 logarithm in the mind of some beginneRs, we define 'ln()' and 'ln1p()' as wrappers for 'log()“ with default 'base = exp(1)' argument and for 'log1p()', respectively. For similar reasons, 'lg()' is a wrapper of 'log10()' (there is no possible confusion here, but 'lg' is another common notation for base 10 logarithm). 'lg1p()' is a convenient way to use the optimized code to calculate the logarithm of x + 1, but returning the result in base 10 logarithm. 'E' is the Euler constant and is provided for convenience as 'exp(1)'. Finally 'lb()' is a synonym of 'log2()'.

Usage

ln(x)

ln1p()

lg()

lg1p(x)

E

lb()

Arguments

x

A numeric or complex vector.

Format

An object of class numeric of length 1.

See Also

[log()]

Examples

ln(exp(3))              # Same as log(exp(3))
ln1p(c(0, 1, 10, 100))  # Wrapper for log1p()
lg(10^3)                # Same as log10(10^3)
lg1p(c(0, 1, 10, 100))  # log10(x + 1), but optimized for x << 1
E^4                     # Similar to exp(4), but different calculation!
lb(1:3)                 # Wrapper for log2()

SciViews documentation built on June 8, 2025, 1:52 p.m.