Skip to main content

Rule

Struct Rule 

Source
pub struct Rule<T> { /* private fields */ }
Expand description

Quadrature rule for numerical integration.

Represents an approximation of an integral by a weighted sum over discrete points. The rule contains quadrature points x, weights w, and auxiliary arrays x_forward and x_backward for efficient computation.

Implementations§

Source§

impl<T: Copy> Rule<T>

Source

pub fn x(&self) -> &[T]

Quadrature points, in non-decreasing order

Source

pub fn w(&self) -> &[T]

Quadrature weights, one per point

Source

pub fn x_forward(&self) -> &[T]

Distance of each point from the left endpoint: x - a

Source

pub fn x_backward(&self) -> &[T]

Distance of each point from the right endpoint: b - x

Source

pub fn a(&self) -> T

Left endpoint of the integration interval

Source

pub fn b(&self) -> T

Right endpoint of the integration interval

Source§

impl<T> Rule<T>
where T: CustomNumeric,

Source

pub fn new(x: Vec<T>, w: Vec<T>, a: T, b: T) -> Result<Self, Error>

Create a new quadrature rule from points and weights.

§Arguments
  • x - Quadrature points
  • w - Quadrature weights
  • a - Left endpoint
  • b - Right endpoint

The points are not checked for order or for lying in [a, b]; Self::validate does that.

§Errors

Error::InvalidParameter if x and w have different lengths.

Source

pub fn empty() -> Self

Create a default rule with empty arrays.

Source

pub fn reseat(&self, a: T, b: T) -> Self

Reseat the rule to a new interval [a, b].

Scales and translates the quadrature points and weights to the new interval.

Source

pub fn scale(&self, factor: T) -> Self

Scale the weights by a factor.

Source

pub fn piecewise(&self, edges: &[T]) -> Result<Self, Error>

Create a piecewise rule over multiple segments.

§Arguments
  • edges - Segment boundaries: at least 2, finite and strictly increasing, with finite segment lengths and a finite sum of the ends of each segment (the midpoint of the segment is computed from it)
§Errors

Error::InvalidParameter if edges does not meet these conditions

Source

pub fn join(rules: &[Self]) -> Self

Join multiple rules into a single rule.

§Arguments
  • rules - Vector of rules to join (must be contiguous and sorted)
§Panics

Panics if rules are empty, not contiguous, or not sorted.

Source

pub fn convert<U>(&self) -> Rule<U>

Convert the rule to a different numeric type.

Source

pub fn validate(&self) -> bool

Validate the rule for consistency.

§Returns

true if the rule is valid, false otherwise.

Trait Implementations§

Source§

impl<T: Clone> Clone for Rule<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Rule<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Rule<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Rule<T>
where T: RefUnwindSafe,

§

impl<T> Send for Rule<T>
where T: Send,

§

impl<T> Sync for Rule<T>
where T: Sync,

§

impl<T> Unpin for Rule<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Rule<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Rule<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where 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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.