Struct gauss_quad::GaussJacobi

source ·
pub struct GaussJacobi {
    pub nodes: Vec<f64>,
    pub weights: Vec<f64>,
}
Expand description

A Gauss-Jacobi quadrature scheme.

These rules can approximate integrals with singularities at the end points of the domain, [a, b].

Examples

// initialize the quadrature rule.
let quad = GaussJacobi::init(10, -0.5, 0.0);

// numerically integrate e^-x / sqrt(1 + x).
let integral = quad.integrate(-1.0, 1.0, |x| (-x).exp());

let dawson_function_of_sqrt_2 = 0.4525399074037225;
assert_abs_diff_eq!(integral, 2.0 * E * dawson_function_of_sqrt_2, epsilon = 1e-14);

Fields§

§nodes: Vec<f64>§weights: Vec<f64>

Implementations§

source§

impl GaussJacobi

source

pub fn init(deg: usize, alpha: f64, beta: f64) -> GaussJacobi

Initializes Gauss-Jacobi quadrature rule of the given degree by computing the nodes and weights needed for the given alpha and beta.

Panics

Panics if degree of quadrature is smaller than 2, or if alpha or beta are smaller than -1

source

pub fn nodes_and_weights( deg: usize, alpha: f64, beta: f64 ) -> (Vec<f64>, Vec<f64>)

Apply Golub-Welsch algorithm to determine Gauss-Jacobi nodes & weights see Gil, Segura, Temme - Numerical Methods for Special Functions

Panics

Panics if degree of quadrature is smaller than 2, or if alpha or beta are smaller than -1

source

pub fn integrate<F>(&self, a: f64, b: f64, integrand: F) -> f64where F: Fn(f64) -> f64,

Perform quadrature of integrand from a to b. This will integrate
(1 - x)^alpha * (1 + x)^beta * integrand
where alpha and beta were given in the call to init.

Trait Implementations§

source§

impl Clone for GaussJacobi

source§

fn clone(&self) -> GaussJacobi

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for GaussJacobi

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for GaussJacobi

source§

fn eq(&self, other: &GaussJacobi) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for GaussJacobi

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Scalar for Twhere T: 'static + Clone + PartialEq + Debug,