Skip to content

Commit

Permalink
tweak description
Browse files Browse the repository at this point in the history
  • Loading branch information
wrathematics committed Nov 27, 2017
1 parent bf4c520 commit ce16840
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 40 deletions.
28 changes: 15 additions & 13 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
Package: float
Type: Package
Title: Single Precision Floats
Title: 32-Bit Floats
Version: 0.1-0
Description: R comes with a suite of utilities for linear algebra with "numeric"
(integer/double precision) vectors/matrices. However, sometimes single
precision (or less!) is more than enough for a particular task. This
package extends R's linear algebra facilities to include single precision
(float) data. Float vectors/matrices have half the precision of their
"numeric"-type counterparts, for a performance vs accuracy trade-off. The
internal representation is an S4 class, which allows us to keep the syntax
identical to that of base R's. Interaction between floats and base types
for binary operators is generally possible; in these cases, type promotion
always defaults to the higher precision. The package ships with copies of
the single precision 'BLAS' and 'LAPACK', which are automatically built in
the event they are not available on the system.
(double precision) vectors/matrices. However, sometimes single precision (or
less!) is more than enough for a particular task. This package extends R's
linear algebra facilities to include 32-bit float (single precision) data.
Float vectors/matrices have half the precision of their "numeric"-type but
are generally faster to numerically operate on, for a performance vs
accuracy trade-off. The internal representation is an S4 class, which
allows us to keep the syntax identical to that of base R's. Interaction
between floats and base types for binary operators is generally possible; in
these cases, type promotion always defaults to the higher precision. The
package ships with copies of the single precision 'BLAS' and 'LAPACK', which
are automatically built in the event they are not available on the system.
License: BSD 2-clause License + file LICENSE
Copyright: The copyright for the single precision BLAS/LAPACK distribution
located in src/lapack is given in the file src/lapack/LICENSE.
Depends:
R (>= 3.1.0), methods
R (>= 3.1.0),
methods
Imports:
utils
ByteCompile: yes
URL: https://github.com/wrathematics/float
BugReports: https://github.com/wrathematics/float/issues
Authors@R: c(
person("Drew", "Schmidt", role=c("aut", "cre", "cph"), email="[email protected]"),
person("Wei-Chen", "Chen", role="ctb", comment="win32 fixes"),
person("ORNL", role="cph")
)
Maintainer: Drew Schmidt <[email protected]>
Expand Down
3 changes: 1 addition & 2 deletions R/00-classes.r
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ setClassUnion("Int", c("integer", "matrix"))

#' Class float32
#'
#' An S4 container for single precision (float) vector/matrix objects.
#' An S4 container for 32-bit float vector/matrix objects.
#'
#' @slot Data
#' A vector or matrix of integers.
Expand All @@ -19,4 +19,3 @@ setClass("float32",

setClassUnion("Mat", c("matrix", "float32"))
setClassUnion("BaseLinAlg", c("matrix", "vector"))

24 changes: 12 additions & 12 deletions R/float-package.r
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
#' Single Precision Floats
#' 32-Bit Floats
#'
#' @description
#' R comes with a suite of utilities for linear algebra with "numeric"
#' (integer/double precision) vectors/matrices. However, sometimes single
#' precision (or less!) is more than enough for a particular task. This
#' package extends R's linear algebra facilities to include single precision
#' (float) data. Float vectors/matrices have half the precision of their
#' "numeric"-type counterparts, for a performance vs accuracy trade-off. The
#' internal representation is an S4 class, which allows us to keep the syntax
#' identical to that of base R's. Interaction between floats and base types
#' for binary operators is generally possible; in these cases, type promotion
#' always defaults to the higher precision. The package ships with copies of
#' the single precision 'BLAS' and 'LAPACK', which are automatically built in
#' the event they are not available on the system.
#' (double precision) vectors/matrices. However, sometimes single precision (or
#' less!) is more than enough for a particular task. This package extends R's
#' linear algebra facilities to include 32-bit float (single precision) data.
#' Float vectors/matrices have half the precision of their "numeric"-type but
#' are generally faster to numerically operate on, for a performance vs
#' accuracy trade-off. The internal representation is an S4 class, which
#' allows us to keep the syntax identical to that of base R's. Interaction
#' between floats and base types for binary operators is generally possible; in
#' these cases, type promotion always defaults to the higher precision. The
#' package ships with copies of the single precision 'BLAS' and 'LAPACK', which
#' are automatically built in the event they are not available on the system.
#'
#' @importFrom utils capture.output
#' @import methods
Expand Down
24 changes: 12 additions & 12 deletions man/float-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/float32-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ce16840

Please sign in to comment.