Skip to main content

DiffOp

Struct DiffOp 

Source
pub struct DiffOp<F> { /* private fields */ }
Available on crate feature diffop only.
Expand description

A linear differential operator L = Σ C_α D^α.

Each term is a (coefficient, multi-index) pair. The operator can be evaluated exactly via DiffOp::eval using JetPlan, or used to build a SparseSamplingDistribution for stochastic estimation.

§Examples

use echidna::diffop::DiffOp;

// Laplacian in 3 variables: ∂²/∂x₀² + ∂²/∂x₁² + ∂²/∂x₂²
let lap = DiffOp::laplacian(3);

// Biharmonic: ∂⁴/∂x₀⁴ + ∂⁴/∂x₁⁴ + ∂⁴/∂x₂⁴
let bih = DiffOp::biharmonic(3);

Implementations§

Source§

impl<F: Float> DiffOp<F>

Source

pub fn new(num_vars: usize, terms: Vec<(F, MultiIndex)>) -> Self

Create a differential operator from explicit (coefficient, multi-index) pairs.

§Panics

Panics if terms is empty or any multi-index has wrong num_vars.

Source

pub fn from_orders(num_vars: usize, terms: &[(F, &[u8])]) -> Self

Create a differential operator from raw order slices.

Each entry is (coefficient, orders_slice).

Source

pub fn laplacian(n: usize) -> Self

Laplacian: Σ_j ∂²/∂x_j².

Source

pub fn biharmonic(n: usize) -> Self

Biharmonic operator: Δ² = (Σ_j ∂²/∂x_j²)².

Expands to Σ_j ∂⁴/∂x_j⁴ + 2 Σ_{j<k} ∂⁴/(∂x_j² ∂x_k²).

For n=1, equivalent to diagonal(1, 4). For n≥2, includes cross terms. Evaluation via [eval] uses exact jet arithmetic. Stochastic estimation via stde_sparse requires importance sampling (full deterministic sampling is biased when coefficients are non-uniform).

Source

pub fn diagonal(n: usize, k: u8) -> Self

k-th order diagonal: Σ_j ∂^k/∂x_j^k.

Source

pub fn terms(&self) -> &[(F, MultiIndex)]

The terms of the operator.

Source

pub fn num_vars(&self) -> usize

Number of variables.

Source

pub fn order(&self) -> usize

Maximum total order across all terms.

Source

pub fn is_diagonal(&self) -> bool

True if every term has exactly one active variable (no mixed partials).

Source

pub fn split_by_order(&self) -> Vec<DiffOp<F>>

Split an inhomogeneous operator into groups of the same total order.

Returns a vector of DiffOp, each containing terms with the same total order, sorted by increasing order.

Source§

impl<F: Float + TaylorArenaLocal> DiffOp<F>

Source

pub fn eval(&self, tape: &BytecodeTape<F>, x: &[F]) -> (F, F)

Exact evaluation: compute Lu(x) via JetPlan.

Returns (value, operator_value).

Source

pub fn sparse_distribution(&self) -> SparseSamplingDistribution<F>

Build a SparseSamplingDistribution for stochastic estimation.

Requires all terms to have the same total order k (homogeneous operator). Use split_by_order to decompose inhomogeneous operators first.

§Panics

Panics if the operator is not homogeneous (mixed total orders).

Trait Implementations§

Source§

impl<F: Clone> Clone for DiffOp<F>

Source§

fn clone(&self) -> DiffOp<F>

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<F: Debug> Debug for DiffOp<F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for DiffOp<F>

§

impl<F> RefUnwindSafe for DiffOp<F>
where F: RefUnwindSafe,

§

impl<F> Send for DiffOp<F>
where F: Send,

§

impl<F> Sync for DiffOp<F>
where F: Sync,

§

impl<F> Unpin for DiffOp<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for DiffOp<F>

§

impl<F> UnwindSafe for DiffOp<F>
where F: 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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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 = 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 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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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