Struct LikelihoodExpression 

pub struct LikelihoodExpression { /* private fields */ }

A combination of LikelihoodTerms as well as sums and products of them.

Notes

When multiple terms provide parameters with the same name, the term earliest in the expression (or argument list) defines the fixed/free status and default value.

Implementations

impl LikelihoodExpression

pub fn from_term(term: Box<dyn LikelihoodTerm>) -> LadduResult<Self>

Build a LikelihoodExpression from a single LikelihoodTerm.

pub fn zero() -> Self

Create an expression representing zero, the additive identity.

pub fn one() -> Self

Create an expression representing one, the multiplicative identity.

pub fn parameters(&self) -> ParameterMap

The parameters referenced across all terms in this expression.

pub fn n_free(&self) -> usize

Number of free parameters.

pub fn n_fixed(&self) -> usize

Number of fixed parameters.

pub fn n_parameters(&self) -> usize

Total number of parameters (free + fixed).

pub fn evaluate(&self, parameters: &[f64]) -> LadduResult<f64>

Evaluate the sum/product of all terms.

pub fn evaluate_gradient(&self, parameters: &[f64]) -> LadduResult<DVector<f64>>

Evaluate the gradient.

Trait Implementations

impl Add<&LikelihoodExpression> for &LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the + operator.

fn add(self, rhs: &LikelihoodExpression) -> Self::Output

Performs the + operation.

impl Add<&LikelihoodExpression> for LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the + operator.

fn add(self, rhs: &LikelihoodExpression) -> Self::Output

Performs the + operation.

impl Add<LikelihoodExpression> for &LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the + operator.

fn add(self, rhs: LikelihoodExpression) -> Self::Output

Performs the + operation.

impl Add for LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the + operator.

fn add(self, rhs: LikelihoodExpression) -> Self::Output

Performs the + operation.

impl Clone for LikelihoodExpression

fn clone(&self) -> LikelihoodExpression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CostFunction<MaybeThreadPool, LadduError> for LikelihoodExpression

fn evaluate( &self, parameters: &DVector<f64>, args: &MaybeThreadPool, ) -> LadduResult<f64>

The evaluation of the function at a point x with the given arguments/user data.

impl Debug for LikelihoodExpression

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

Formats the value using the given formatter.

impl Default for LikelihoodExpression

fn default() -> LikelihoodExpression

Returns the “default value” for a type.

impl Display for LikelihoodExpression

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

Formats the value using the given formatter.

impl Gradient<MaybeThreadPool, LadduError> for LikelihoodExpression

fn gradient( &self, parameters: &DVector<f64>, args: &MaybeThreadPool, ) -> LadduResult<DVector<f64>>

The evaluation of the gradient at a point x with the given arguments/user data.

fn evaluate_with_gradient( &self, x: &Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, args: &U, ) -> Result<(f64, Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>), E>

The evaluation of both the function and its gradient at a point x with the given arguments/user data.

fn hessian( &self, x: &Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, args: &U, ) -> Result<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>, E>

The evaluation of the hessian at a point x with the given arguments/user data.

fn gradient_with_hessian( &self, x: &Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, args: &U, ) -> Result<(Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>), E>

The evaluation of both the gradient and hessian at a point x with the given arguments/user data.

fn evaluate_with_gradient_and_hessian( &self, x: &Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, args: &U, ) -> Result<(f64, Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>), E>

The evaluation of the function, gradient, and hessian at a point x with the given arguments/user data.

impl LikelihoodTerm for LikelihoodExpression

fn evaluate(&self, parameters: &[f64]) -> LadduResult<f64>

Evaluate the term given some input parameters.

fn evaluate_gradient(&self, parameters: &[f64]) -> LadduResult<DVector<f64>>

Evaluate the gradient of the term given some input parameters.

fn update(&self)

A method called every step of any minimization/MCMC algorithm.

fn fix_parameter(&self, name: &str, value: f64) -> LadduResult<()>

Fix a named parameter local to this term.

fn free_parameter(&self, name: &str) -> LadduResult<()>

Mark a named parameter local to this term as free.

fn rename_parameter(&self, old: &str, new: &str) -> LadduResult<()>

Rename a single parameter local to this term.

fn rename_parameters( &self, mapping: &HashMap<String, String>, ) -> LadduResult<()>

Rename multiple parameters local to this term.

fn parameter_map(&self) -> ParameterMap

Return the parameters owned by this term in local order.

fn into_expression(self) -> LadduResult<LikelihoodExpression>

where Self: Sized + 'static,

Convenience helper to wrap a likelihood term into a LikelihoodExpression.

impl LogDensity<MaybeThreadPool, LadduError> for LikelihoodExpression

fn log_density( &self, parameters: &DVector<f64>, args: &MaybeThreadPool, ) -> LadduResult<f64>

The log of the evaluation of the density function at a point x with the given arguments/user data.

impl Mul<&LikelihoodExpression> for &LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the * operator.

fn mul(self, rhs: &LikelihoodExpression) -> Self::Output

Performs the * operation.

impl Mul<&LikelihoodExpression> for LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the * operator.

fn mul(self, rhs: &LikelihoodExpression) -> Self::Output

Performs the * operation.

impl Mul<LikelihoodExpression> for &LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the * operator.

fn mul(self, rhs: LikelihoodExpression) -> Self::Output

Performs the * operation.

impl Mul for LikelihoodExpression

type Output = LikelihoodExpression

The resulting type after applying the * operator.

fn mul(self, rhs: LikelihoodExpression) -> Self::Output

Performs the * operation.