SciViews (version 0.9-13.1)

ln: 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 defaultbase = exp(1)argument and forlog1p(), respectively. For similar reasons,lg()is a wrapper oflog10()(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.Eis the Euler constant and is provided for convenience asexp(1). Finallylb()is a synonym oflog2()`.

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

# NOT RUN {
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()
# }