R: Wrappers for the Gnu Scientific Library

gsl-package {gsl} | R Documentation

## Wrappers for the Gnu Scientific Library

### Description

An R wrapper for some of the functionality of the Gnu Scientific Library.

### Details

The DESCRIPTION file:

Package: | gsl
Version: | 2.1-6
Depends: | R (>= 3.1.0)
Title: | Wrapper for the Gnu Scientific Library
Authors@R: | c(person(given=c("Robin", "K. S."), family="Hankin", role = c("aut","cre"), email="hankin.robin@gmail.com", comment = c(ORCID = "0000-0001-5982-0415")), person(given="Andrew",family="Clausen",role="ctb",comment="multimin functionality"), person(given="Duncan",family="Murdoch",role="ctb",comment="qrng functions"))
SystemRequirements: | Gnu Scientific Library version >= 2.1
Description: | An R wrapper for some of the functionality of the Gnu Scientific Library.
Maintainer: | Robin K. S. Hankin <hankin.robin@gmail.com>
License: | GPL-3
URL: | https://github.com/RobinHankin/gsl.git
BugReports: | https://github.com/RobinHankin/gsl/issues
Author: | Robin K. S. Hankin [aut, cre] (<https://orcid.org/0000-0001-5982-0415>), Andrew Clausen [ctb] (multimin functionality), Duncan Murdoch [ctb] (qrng functions)

Index of help topics:

    Airy                    Airy functions
    Bessel                  Bessel functions
    Clausen                 Clausen functions
    Coulomb                 Coulomb functions
    Coupling                Coupling functions
    Dawson                  Dawson functions
    Debye                   Debye functions
    Dilog                   Dilog functions
    Ellint                  Elliptic functions
    Elljac                  Elliptic functions
    Error                   Error functions
    Expint                  exponential functions
    Fermi_Dirac             Fermi-Dirac functions
    Gamma                   gamma functions
    Gegenbauer              Gegenbauer functions
    Hyperg                  Hypergeometric functions
    Laguerre                Laguerre functions
    Lambert                 Lambert's W function
    Legendre                Legendre functions
    Log                     Log functions
    Misc                    Argument processing and general info
    Poly                    Polynomials
    Psi                     Psi (digamma) functions
    Qrng                    Quasi-random sequences
    Rng                     Random numbers generation
    Synchrotron             Synchrotron functions
    Transport               Transport functions
    Trig                    Trig functions
    Zeta                    Zeta functions
    gsl-deprecated          gsl-deprecated
    gsl-package             Wrappers for the Gnu Scientific Library
    multimin                Function minimization
    pow_int                 Power functions

The function naming scheme directly copies the GSL manual except that leading `gsl_sf_` and, if present, the trailing `_e` is stripped: thus `gsl_sf_Airy_Ai_e` goes to R function `airy_Ai()`; however, some functions retain the prefix to avoid conflicts (viz `gsl_sf_sin()`, `gsl_sf_cos()`, `gsl_sf_gamma()`, `gsl_sf_ choose()`, `gsl_sf_beta()`).

R\ function arguments have the same names as in the GSL reference manual, except for the quasirandom functions documented in the `Qrng` manpage.

The package is organized into units corresponding to GSL header files; the `.c`, `.R`, and `.Rd` filenames match the GSL header filenames, except that the `.Rd` files are capitalized. Functions appear in all files in the same order as the GSL reference manual, which precludes the use of the tidying method given in section 3.1 of R-exts. Error forms of GSL functions (`_e` versions) are used if available.

In general, documentation is limited to: (a), a pointer to the GSL reference book, which would in any case dominate any docs here; and (b), re-productions of some tables and figures in Abramowitz and Stegun (June 1964).

### Author(s)

NA

Maintainer: Robin K. S. Hankin <hankin.robin@gmail.com>

### References

- M. Abramowitz and I. A. Stegun 1965. Handbook of mathematical functions. New York: Dover

- M. Galassi et al. 2007. GNU Scientific Library. Reference Manual edition 1.10, for GSL version 1.10; 10 September 2007

- R. K. S. Hankin 2006. Introducing gsl, a wrapper for the Gnu Scientific Library. Rnews 6(4):24-26

### Examples

    airy_Ai(1:5)

[Package gsl version 2.1-6 Index]