Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 3.09 KB

README.md

File metadata and controls

33 lines (27 loc) · 3.09 KB

This library provides fast numerical integration of one dimensional, real valued, functions over finite intervals. It is pure safe rust, and cross-platform.

The primary function is quadrature::integrate, which uses the double exponential algorithm. It is a port of the Fast Numerical Integration from C++ to rust. The original code is by John D. Cook, and is licensed under the BSD.

The double exponential algorithm is naturally adaptive, it stops calling the integrand when the error is reduced to below the desired threshold. It also does not allocate. No box, no vec, etc. It has a hard coded maximum of approximately 350 function evaluations. This guarantees that the algorithm will return. The error in the algorithm decreases exponentially in the number of function evaluations, specifically O(exp(-cN/log(N))). So if 350 function evaluations is not giving the desired accuracy than the programmer probably needs to give some guidance by splitting up the range at singularities or other preparation techniques.

Other Algorithms

The clenshaw_curtis module provides a integrate function with the same signature as quadrature::integrate. The implemented variant of clenshaw curtis quadrature is adaptive, however the weights change for each adaptation. This unfortunately means that the sum needs to be recalculated for each layer of adaptation. It also does not allocate on the heap, however it does use a [f64; 129] to store the function values. It has a hard coded maximum of approximately 257 function evaluations. This guarantees that the algorithm will return. The clenshaw curtis algorithm exactly integrates polynomials of order N. This implementation starts with an N of approximately 5 and increases up to an N of approximately 257. In general the error in the algorithm decreases exponentially in the number of function evaluations. In summary clenshaw curtis will in general use more stack space and run slower than the double exponential algorithm, unless clenshaw curtis can get the exact solution.

Features

By default, this library is build with the std feature. For no_std compatibility, this feature can be disabled. Note that this disables the double exponential algorithm, because it requires logarithms, which are not available for no_std builds. Accordingly, the clenshaw curtis algorithm is used for quadrature::integrate without the std feature.

Testing

I have been testing against rust 1.8 with:

> rustup override set 1.8.0
> cargo test
> rustup override set nightly
> cargo test
> cargo bench

It is also tested on travis Build Status and appver Build status. I think bumping rust version is a breaking change, and will be respected in semver.