Struct gkquad::IntegrationResult

pub struct IntegrationResult { /* fields omitted */ }

Store the estimation of integral and estimated absolute error (delta) of calculation.

Methods

impl IntegrationResult

pub fn new(estimate: f64, delta: f64, error: Option<RuntimeError>) -> Self

Create IntegrationResult object

pub fn estimate(&self) -> Result<f64, RuntimeError>

Get the estimation of integral.

Returns Err if integration error has occured.

pub fn delta(&self) -> Result<f64, RuntimeError>

Get the estimated absolute error of integral.

Returns Err if integration error has occured.

pub fn estimate_delta(&self) -> Result<(f64, f64), RuntimeError>

Get the estimation of integral and absolute error.

Returns Err if integration error has occured.

Examples

use gkquad::single::integral;
use core::f64::NEG_INFINITY;

let result = integral(|x: f64| x.exp(), NEG_INFINITY..0.0);
let (estimate, delta) = result.estimate_delta().unwrap();

pub unsafe fn estimate_unchecked(&self) -> f64

Get the estimation of integral even if integration error occured.

Safety

If integration error occured during computation, integration function will return the current estimation of integral anyway. In this case the estimation does not achieve the given tolerance.

You should use this function only if you don't care about the estimation error.

pub unsafe fn delta_unchecked(&self) -> f64

Get the estimated absolute error even if integration error has occured.

Safety

If integration error occured during computation, integration function will return the current estimation of integral anyway. In this case the estimation does not achieve the given tolerance, and the error estimation (delta) may not be reliable.

pub unsafe fn estimate_delta_unchecked(&self) -> (f64, f64)

Get the estimation of integral and absolute error even if integration error has occured.

Safety

See Safety secion of estimate_unchecked method and delta_unchecked method.

pub fn has_err(&self) -> bool

Return true if integration error has occured.

pub fn err(&self) -> Option<RuntimeError>

Get integration error.

Return None if any integration error has not occured.

Trait Implementations

impl Clone for IntegrationResult

fn clone(&self) -> IntegrationResult

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IntegrationResult

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.