File: simplenumber.Rd

package info (click to toggle)
r-cran-spatstat.utils 1.13-0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 444 kB
  • sloc: ansic: 1,390; sh: 4; makefile: 2
file content (48 lines) | stat: -rw-r--r-- 1,088 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
\name{simplenumber}
\alias{simplenumber}
\title{
  Simple Rational Number
}
\description{
  Given a numeric value, try to express it
  as a simple rational number.
}
\usage{
simplenumber(x, unit = "", multiply = "*", tol = .Machine$double.eps)
}
\arguments{
  \item{x}{
    A single numeric value.
  }
  \item{unit}{
    Optional. Character string giving the name of the unit 
    in which \code{x} is expressed. Typically an irrational number
    such as \code{pi}. See Examples.
  }
  \item{multiply}{
    Optional. Character string representing multiplication.
  }
  \item{tol}{
    Numerical tolerance.
  }
}
\details{
  The code tries to express \code{x} as an integer \code{x=n}, or as
  the reciprocal of an integer \code{x=1/n}, or
  as a simple rational number \code{x = m/n}, where \code{m,n} are
  small integers.
}
\value{
  A character string representing the simple number,
  or \code{NULL} if not successful.
}
\author{
  \adrian.
}
\examples{
  simplenumber(0.3)
  simplenumber(0.333333333333333333333333)
  x <- pi * 2/3
  simplenumber(x/pi, "pi")
}
\keyword{symbolmath}