Rmpfr (version 0.1-7)

formatMpfr: Formatting MPFR (multiprecision) Numbers

Description

Flexible formatting of multiprecision numbers, i.e., objects of class mpfr. This is also the mpfr method of the generic format function.

Usage

formatMpfr(x, digits = NULL, trim = FALSE, scientific = NA,
           big.mark = "", big.interval = 3L,
           small.mark = "", small.interval = 5L, decimal.mark = ".",
           zero.print = NULL, drop0trailing = FALSE, ...)

Arguments

x

an MPFR number (vector or array).

digits

how many significant digits are to be used for numeric and complex x. The default, NULL, uses enough digits to represent the full precission.

trim

logical; if FALSE, numbers are right-justified to a common width: if TRUE the leading blanks for justification are suppressed.

scientific

either a logical specifying whether MPFR numbers should be encoded in scientific format, or an integer penalty (see options("scipen")). Missing values correspond to the current default penalty.

big.mark, big.interval, small.mark, small.interval, decimal.mark, zero.print, drop0trailing

used for prettying decimal sequences, these are passed to prettyNum and that help page explains the details.

...

further arguments passed to or from other methods.

Value

• a character vector of the same length as x.

References

The MPFR manual's description of mpfr_get_str() which is the C-internal workhorse for the (internal) Rfunction .mpfr2str() on which formatMpfr builds.

See Also

mpfr for creation and the mpfr class description with its many methods. The format generic, and the prettyNum utility on which formatMpfr is based as well.

Examples

## Printing of MPFR numbers  uses formatMpfr() internally.
 ## Note how each components uses the "necessary" number of digits:
 ( x3 <- c(Const("pi", 168), mpfr(pi, 140), 3.14) )
 format(x3[3], 15)
 format(x3[3], 15, drop0 = TRUE)# "3.14" .. dropping the trailing zeros
 x3[4] <- 2^30
 x3[4] # automatically drops trailing zeros
 format(x3[1], dig = 41, small.mark = "'") # (41 - 1 = ) 40 digits after "."