Skip to main content

Prior

pub enum Prior<const D: usize> {
    Uniform {
        bounds: [(f64, f64); D],
    },
    Gaussian {
        mean: [f64; D],
        cov_diag: [f64; D],
        truncation_sigmas: f64,
    },
    Custom {
        bounds: [(f64, f64); D],
        density: Arc<dyn Fn([f64; D]) -> f64 + Send + Sync>,
    },
}
Expand description

Probability density / sampling region over R^D.

All variants are validated by Prior::validate. The sample-space described here is the support of the prior; quadrature points are drawn inside this support and transformed if needed.

Variants§

§

Uniform

Uniform density on the axis-aligned box bounds[i] = (lo, hi).

Fields

§bounds: [(f64, f64); D]

Per-axis lower / upper bounds. Lower must be strictly less than upper.

§

Gaussian

Axis-aligned Gaussian. cov_diag[i] holds σ² along axis i. Truncated to ±k·σ in Quadrature::Sobol / Quadrature::LatinHypercube via inverse-CDF; the truncation_sigmas field controls k (default 4.0).

Fields

§mean: [f64; D]

Per-axis means.

§cov_diag: [f64; D]

Per-axis variances (must be > 0).

§truncation_sigmas: f64

Truncation in standard deviations (samples are clamped after inverse-CDF). Default 4.0 captures > 99.99 % of the mass and avoids runaway tails.

§

Custom

Arbitrary density specified pointwise. The closure must return a non-negative density. Quadrature for Custom priors is restricted to Sobol / LatinHypercube over an axis-aligned bounding box that the caller supplies (the closure is not used by quadrature; only by importance-weighting inside evaluate_area_loss).

Fields

§bounds: [(f64, f64); D]

Bounding box used by sampling-based quadratures.

§density: Arc<dyn Fn([f64; D]) -> f64 + Send + Sync>

Density evaluated at each sampled point. Must be non-negative.

Implementations§

Source§

impl<const D: usize> Prior<D>

Source

pub fn validate(&self) -> Result<(), AreaError>

Reject malformed priors before any quadrature samples are drawn.

Source

pub fn bounding_box(&self) -> [(f64, f64); D]

Axis-aligned bounding box used as the search space for [Quadrature::WorstCaseSearch] and the integration domain for tensor-product / sampled quadratures.

Trait Implementations§

Source§

impl<const D: usize> Clone for Prior<D>

Source§

fn clone(&self) -> Prior<D>

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<const D: usize> Debug for Prior<D>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const D: usize> Freeze for Prior<D>

§

impl<const D: usize> !RefUnwindSafe for Prior<D>

§

impl<const D: usize> Send for Prior<D>

§

impl<const D: usize> Sync for Prior<D>

§

impl<const D: usize> Unpin for Prior<D>

§

impl<const D: usize> UnsafeUnpin for Prior<D>

§

impl<const D: usize> !UnwindSafe for Prior<D>

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> 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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V