RcppFaddeeva v0.1.0

0

Monthly downloads

0th

Percentile

by Baptiste Auguie

'Rcpp' Bindings for the 'Faddeeva' Package

Access to a family of Gauss error functions for arbitrary complex arguments is provided via the 'Faddeeva' package by Steven G. Johnson (see <http://ab-initio.mit.edu/wiki/index.php/Faddeeva_Package> for more information).

Readme

RcppFaddeeva Build Status License

Wrapper to the Faddeeva Package by Steven G. Johnson

What is Faddeeva?

The Faddeeva package provides C++ code to compute the various error functions of arbitrary complex arguments, in particular the Faddeeva function, error function, complementary error function, scaled complementary error function and imaginary error function as well as the Dawson function. With these, Voigt functions, Fresnel integrals and more can be computed.

Why this package?

The package was created to provide a fast implementation of the Voigt lineshape, formally defined as the convolution between a Lorentzian and a Gaussian. The imaginary part of the Faddeeva function, properly scaled, provides directly the result.

This package also results in a nice example for creating Rcpp wrappers for a small and self-contained C++ library, in this case a single header file along with a single code file.

Authors

Baptiste Auguié and Dirk Eddelbuettel

License

GPL (>= 2)

Functions in RcppFaddeeva

Name Description
RcppFaddeeva-package RcppFaddeeva
Faddeeva_w Faddeeva family of error functions of the complex variable
Voigt The Voigt function, corresponding to the convolution of a lorentzian and a gaussian distribution
No Results!

Last month downloads

Details

Type Package
Date 2015-06-07
License GPL (>= 2)
VignetteBuilder knitr
LinkingTo Rcpp
NeedsCompilation yes
Packaged 2015-06-08 20:01:12 UTC; baptiste
Repository CRAN
Date/Publication 2015-06-09 07:48:31

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/RcppFaddeeva)](http://www.rdocumentation.org/packages/RcppFaddeeva)