gsl (version 1.3-1)

Misc: Argument processing and general info

Description

Massages arguments into a form suitable for passing to C functions; also general info

Usage

process.args(...)
strictify(val,status)

Arguments

...

Argument list to be coerced to the same length.

val

Value component of &result

status

status integer

Details

Functions that retain the gsl_sf_ prefix: gsl_sf_sin(), gsl_sf_cos(), gsl_sf_gamma(), gsl_sf_ choose(), gsl_sf_beta().

Function process.args() et seq is called, if possible, to massage the arguments into a form suitable for passing to .C(). For example, in function hyperg_0F1(c,x), one wants hyperg_0F1(0.1, c(0.3,0.4)) and hyperg_0F1(c(0.1,0.2), 0.3) and hyperg_0F1(c(0.1,0.2),c(0.3,0.4) to behave sensibly. Function process.arg() does this by returning a list whose elements are vectors of the same length.

Function strictify() uses the status value returned by the error form of the GSL special functions to make values returned with a nonzero error a NaN. This function is called if argument strict takes its default value of TRUE. Setting it to FALSE sometimes returns a numerical value as per the GSL reference manual.

If argument give takes its default value of FALSE, a numerical value only is returned. If TRUE, error information and the status (see preceding paragraph) is also returned.