Skip to main content

NonParametricAlgorithm

Enum NonParametricAlgorithm 

Source
pub enum NonParametricAlgorithm {
    Npag(NpagConfig),
    Npod(NpodConfig),
    Npmap(NpmapConfig),
    Ncnpag(NcnpagConfig),
}
Expand description

The non-parametric algorithms supported by PMcore.

Use the constructors to select an algorithm with its default configuration:

use pmcore::prelude::*;

// Default NPAG configuration.
let algorithm = NonParametricAlgorithm::npag();

To customize an algorithm, build its configuration struct (which exposes only the setters valid for that algorithm) and pass it directly to fit_with:

use pmcore::prelude::*;

// NPAG with a tighter convergence criterion and a cycle cap.
let config = NpagConfig::new().eps(0.1).max_cycles(500);
// `problem.fit_with(config)` accepts the config directly.

Each configuration type (NpagConfig, NpodConfig, NpmapConfig) implements Algorithm by delegating to the matching enum variant, so configs can be passed to fit_with without converting them first.

Variants§

§

Npag(NpagConfig)

Non-Parametric Adaptive Grid.

§

Npod(NpodConfig)

Non-Parametric Optimal Design.

§

Npmap(NpmapConfig)

Non-parametric maximum a posteriori (posterior probability reweighting).

§

Ncnpag(NcnpagConfig)

Non-collapsing NPAG (single-pass Bayesian reweighting of fixed support points).

Implementations§

Source§

impl NonParametricAlgorithm

Source

pub fn npag() -> Self

The Non-Parametric Adaptive Grid (NPAG) algorithm with its default configuration.

Source

pub fn npod() -> Self

The Non-Parametric Optimal Design (NPOD) algorithm with its default configuration.

Source

pub fn npmap() -> Self

The non-parametric maximum a posteriori (NPMAP) algorithm with its default configuration.

Source

pub fn ncnpag() -> Self

The non-collapsing NPAG (NCNPAG) algorithm with its default configuration.

Trait Implementations§

Source§

impl<E: Equation + Send + 'static> Algorithm<E, NonParametric> for NonParametricAlgorithm

Source§

type Output = NonParametricResult<E>

The specific result struct (e.g. NonParametricResult<E>).
Source§

fn fit( self, problem: EstimationProblem<E, NonParametric>, ) -> Result<Self::Output>

Consumes the configuration and the problem, runs the optimization to completion, and returns the strictly-typed result.
Source§

impl Clone for NonParametricAlgorithm

Source§

fn clone(&self) -> NonParametricAlgorithm

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 Debug for NonParametricAlgorithm

Source§

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

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

impl Default for NonParametricAlgorithm

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<NcnpagConfig> for NonParametricAlgorithm

Source§

fn from(config: NcnpagConfig) -> Self

Converts to this type from the input type.
Source§

impl From<NpagConfig> for NonParametricAlgorithm

Source§

fn from(config: NpagConfig) -> Self

Converts to this type from the input type.
Source§

impl From<NpmapConfig> for NonParametricAlgorithm

Source§

fn from(config: NpmapConfig) -> Self

Converts to this type from the input type.
Source§

impl From<NpodConfig> for NonParametricAlgorithm

Source§

fn from(config: NpodConfig) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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
§

impl<T> Context for T
where T: Clone + Default,

§

fn vector_from_element<V>(&self, len: usize, value: <V as VectorCommon>::T) -> V
where V: Vector<C = Self>,

§

fn vector_from_vec<V>(&self, vec: Vec<<V as VectorCommon>::T>) -> V
where V: Vector<C = Self>,

§

fn vector_zeros<V>(&self, len: usize) -> V
where V: Vector<C = Self>,

§

fn dense_mat_zeros<V>( &self, rows: usize, cols: usize, ) -> <V as DefaultDenseMatrix>::M
where V: Vector<C = Self> + DefaultDenseMatrix,

§

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

§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = 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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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

§

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

§

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

§

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

§

impl<T> SendAlias for T

§

impl<T> SyncAlias for T