rint 0.1.0

A pure Rust library for the numerical integration of real or complex valued functions of real variables in multiple dimensions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

use crate::ScalarF64;

/// The value of a function evaluated with Gauss-Kronrod integration and associated error
/// estimation.
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct IntegralEstimate<T> {
    result: T,
    error: f64,
    iterations: usize,
    evaluations: usize,
}

/// # Getters
impl<T: ScalarF64> IntegralEstimate<T> {
    /// Return the numerically approximated value of the integral.
    #[must_use]
    pub const fn result(&self) -> T {
        self.result
    }

    /// Return the numerically approximated error.
    #[must_use]
    pub const fn error(&self) -> f64 {
        self.error
    }

    /// Return the number of iterations used in integration.
    #[must_use]
    pub const fn iterations(&self) -> usize {
        self.iterations
    }

    /// Return the number of function evaluations used in the integration.
    #[must_use]
    pub const fn evaluations(&self) -> usize {
        self.evaluations
    }
}

impl<T: ScalarF64> IntegralEstimate<T> {
    pub(crate) fn new() -> Self {
        let result = T::zero();
        Self {
            result,
            error: 0.0,
            iterations: 0,
            evaluations: 0,
        }
    }

    pub(crate) fn with_result(mut self, result: T) -> Self {
        self.result = result;
        self
    }

    pub(crate) fn with_error(mut self, error: f64) -> Self {
        self.error = error;
        self
    }

    pub(crate) fn with_iterations(mut self, iterations: usize) -> Self {
        self.iterations = iterations;
        self
    }

    pub(crate) fn with_evaluations(mut self, evaluations: usize) -> Self {
        self.evaluations = evaluations;
        self
    }
}