Skip to main content

PronyKernel

Struct PronyKernel 

Source
pub struct PronyKernel<S: Scalar> {
    pub amplitudes: Vec<S>,
    pub rates: Vec<S>,
}
Expand description

Prony series (Sum of Exponentials) kernel.

K(τ) = Σᵢ aᵢ * exp(-bᵢ * τ)

This is the most efficient kernel type for numerical integration because it can be computed recursively without storing full history.

Fields§

§amplitudes: Vec<S>

Amplitudes aᵢ

§rates: Vec<S>

Decay rates bᵢ

Implementations§

Source§

impl<S: Scalar> PronyKernel<S>

Source

pub fn new(amplitudes: Vec<S>, rates: Vec<S>) -> Self

Create a new Prony series kernel.

§Arguments
  • amplitudes - Amplitudes aᵢ
  • rates - Decay rates bᵢ (must be positive)
Source

pub fn single(a: S, b: S) -> Self

Create a single exponential kernel.

Source

pub fn two_term(a1: S, b1: S, a2: S, b2: S) -> Self

Create a two-term Prony series (generalized Maxwell model).

Source

pub fn num_terms(&self) -> usize

Number of terms in the series.

Trait Implementations§

Source§

impl<S: Clone + Scalar> Clone for PronyKernel<S>

Source§

fn clone(&self) -> PronyKernel<S>

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<S: Debug + Scalar> Debug for PronyKernel<S>

Source§

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

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

impl<S: Scalar> Kernel<S> for PronyKernel<S>

Source§

fn evaluate(&self, tau: S) -> S

Evaluate the kernel at time lag τ.
Source§

fn as_prony(&self) -> Option<(Vec<S>, Vec<S>)>

Check if the kernel is a sum of exponentials (Prony series). Read more

Auto Trait Implementations§

§

impl<S> Freeze for PronyKernel<S>

§

impl<S> RefUnwindSafe for PronyKernel<S>
where S: RefUnwindSafe,

§

impl<S> Send for PronyKernel<S>

§

impl<S> Sync for PronyKernel<S>

§

impl<S> Unpin for PronyKernel<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for PronyKernel<S>

§

impl<S> UnwindSafe for PronyKernel<S>
where S: 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> 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.