Struct Prior 

pub struct Prior { /* private fields */ }

A Gaussian prior on free parameters: a measurement of them made elsewhere, with mean m and covariance C = LLᵀ.

Implementations

impl Prior

pub fn measured(parameter: usize, mean: f64, sd: f64) -> Self

A measurement mean ± sd of the parameter at index parameter in the ParameterSet; poisson_fit refuses a mean that is not finite or an sd that is not finite and positive.

pub fn correlated( parameters: &[usize], mean: &[f64], covariance: &FlatMatrix, ) -> Result<Self, FittingError>

A joint measurement of the parameters at parameters in the ParameterSet, with mean and covariance in that order.

Errors

FittingError::LengthMismatch if mean or covariance does not match parameters; FittingError::InvalidConfig if parameters is empty or lists a parameter twice, mean is not finite, or covariance is not finite, not symmetric to 1e-12 of √(Cᵢᵢ Cⱼⱼ), or not positive definite with the condition number of its correlation matrix at most 1e10; FittingError::EvaluationFailed if the eigendecomposition of that matrix fails.

Trait Implementations

impl Clone for Prior

fn clone(&self) -> Prior

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prior

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

Formats the value using the given formatter.

impl PartialEq for Prior

fn eq(&self, other: &Prior) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Prior