# Faddeeva Package

### From AbInitio

Revision as of 13:19, 5 October 2012 (edit)Stevenj (Talk | contribs) ← Previous diff |
Revision as of 16:00, 5 October 2012 (edit)Stevenj (Talk | contribs) (→Faddeeva / complex error function) Next diff → |
||

Line 3: |
Line 3: | ||

[http://math.mit.edu/~stevenj Steven G. Johnson] has written [[w:Free and open-source software|free/open-source]] C++ code to compute the '''scaled complex [[w:Error function|error function]]''' ''w''(''z'') = ''e''<sup>−''z''<sup>2</sup></sup>erfc(−''iz''), also called the '''Faddeeva''' function, for arbitrary [[w:complex number|complex]] arguments ''z'' to a given accuracy. Download the source code from: | [http://math.mit.edu/~stevenj Steven G. Johnson] has written [[w:Free and open-source software|free/open-source]] C++ code to compute the '''scaled complex [[w:Error function|error function]]''' ''w''(''z'') = ''e''<sup>−''z''<sup>2</sup></sup>erfc(−''iz''), also called the '''Faddeeva''' function, for arbitrary [[w:complex number|complex]] arguments ''z'' to a given accuracy. Download the source code from: | ||

- | * [http://ab-initio.mit.edu/Faddeeva_w.cc http://ab-initio.mit.edu/Faddeeva_w.cc] (released 4 October 2012) | + | * [http://ab-initio.mit.edu/Faddeeva_w.cc http://ab-initio.mit.edu/Faddeeva_w.cc] (updated 5 October 2012) |

== Usage == | == Usage == | ||

Line 14: |
Line 14: | ||

The function <code>Faddeeva_w(z, relerr)</code> computes ''w''(''z'') to a desired [[w:Approximation error|relative error]] <code>relerr</code>. | The function <code>Faddeeva_w(z, relerr)</code> computes ''w''(''z'') to a desired [[w:Approximation error|relative error]] <code>relerr</code>. | ||

- | Passing <code>relerr=0</code> (or any <code>relerr</code> less than machine precision ε≈10<sup>−16</sup>) corresponds to requesting [[w:Machine epsilon|machine precision]], and in practice a relative error < 10<sup>−12</sup> is usually achieved. Specifying a larger value of <code>relerr</code> generally improves performance (at the expense of accuracy). | + | Passing <code>relerr=0</code> (or any <code>relerr</code> less than machine precision ε≈10<sup>−16</sup>) corresponds to requesting [[w:Machine epsilon|machine precision]], and in practice a relative error < 10<sup>−13</sup> is usually achieved. Specifying a larger value of <code>relerr</code> generally improves performance (at the expense of accuracy). |

You should also compile <code>Faddeeva_w.cc</code> and link it with your program, of course. | You should also compile <code>Faddeeva_w.cc</code> and link it with your program, of course. |

## Revision as of 16:00, 5 October 2012

## Contents |

# Faddeeva / complex error function

Steven G. Johnson has written free/open-source C++ code to compute the **scaled complex error function** *w*(*z*) = *e*^{−z2}erfc(−*iz*), also called the **Faddeeva** function, for arbitrary complex arguments *z* to a given accuracy. Download the source code from:

- http://ab-initio.mit.edu/Faddeeva_w.cc (updated 5 October 2012)

## Usage

To use the code, add the following declaration to your C++ source (or header file):

#include <complex> extern std::complex<double> Faddeeva_w(std::complex<double> z, double relerr);

The function `Faddeeva_w(z, relerr)`

computes *w*(*z*) to a desired relative error `relerr`

.

Passing `relerr=0`

(or any `relerr`

less than machine precision ε≈10^{−16}) corresponds to requesting machine precision, and in practice a relative error < 10^{−13} is usually achieved. Specifying a larger value of `relerr`

generally improves performance (at the expense of accuracy).

You should also compile `Faddeeva_w.cc`

and link it with your program, of course.

## Algorithm

We use the algorithm described in the paper:

- Mofreh R. Zaghloul and Ahmed N. Ali, "Algorithm 916: Computing the Faddeyeva and Voigt Functions,"
*ACM Trans. Math. Soft.***38**(2), 15 (2011). Preprint available at arXiv:1106.0151.

Note that this is SGJ's **independent re-implementation** of this algorithm, based on the description in the paper *only*. In particular, we did not refer to (or even download) the author's Matlab implementation (which is under restrictive "semifree" ACM copyright terms and therefore unusable in free/open-source software).

This algorithm requires an external complementary error function erfc(*x*) function for *real* arguments *x* to be supplied as a subroutine. More precisely, it requires the scaled function erfcx(*x*) = *e*^{x2}erfc(*x*). Here, we include an erfcx function derived from the DERFC routine in SLATEC (modified by SGJ to compute erfcx instead of erfc), originally written by W. Fullerton at Los Alamos National Laboratory.

## Test program

To test the code, a small test program is included at the end of `Faddeeva_w.cc`

which tests *w*(*z*) against several known results (from Wolfram Alpha) and prints the relative errors obtained. To compile the test program, `#define FADDEVA_W_TEST`

in the file (or compile with `-DFADDEVA_W_TEST`

on Unix) and compile `Faddeeva_w.cc`

. The resulting program prints `SUCCESS`

at the end of its output if the errors were acceptable.

## License

The software is distributed under the "MIT License", a simple permissive free/open-source license:

*Copyright © 2012 Massachusetts Institute of Technology*-
*[Also included are functions derived from derfc in SLATEC (netlib.org/slatec), which "is in the public domain" and hence may be redistributed under these or any terms.]*

*Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:**The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.*