Struct rustitude_core::amplitude::Model

pub struct Model {
    pub cohsums: Vec<CohSum>,
    pub amplitudes: Vec<Amplitude>,
    pub parameters: Vec<Parameter>,
}

A model contains an API to interact with a group of CohSums by managing their amplitudes and parameters. Models are typically passed to Manager-like struct.

Fields

cohsums: Vec<CohSum>

The set of coherent sums included in the Model.

amplitudes: Vec<Amplitude>

The unique amplitudes located within all CohSums.

parameters: Vec<Parameter>

The unique parameters located within all CohSums.

Implementations

impl Model

pub fn print_tree(&self)

Pretty-prints a tree diagram to show the node structure of the Model.

pub fn get_amplitude( &self, amplitude_name: &str, ) -> Result<Amplitude, RustitudeError>

Retrieves a copy of an Amplitude in the Model by name.

Errors

This will throw a RustitudeError if the amplitude name is not located within the model.

pub fn get_parameter( &self, amplitude_name: &str, parameter_name: &str, ) -> Result<Parameter, RustitudeError>

Retrieves a copy of a Parameter in the Model by name.

Errors

This will throw a RustitudeError if the parameter name is not located within the model or if the amplitude name is not located within the model (this is checked first).

pub fn print_parameters(&self)

Pretty-prints all parameters in the model

pub fn constrain( &mut self, amplitude_1: &str, parameter_1: &str, amplitude_2: &str, parameter_2: &str, ) -> Result<(), RustitudeError>

Constrains two Parameters in the Model to be equal to each other when evaluated.

Errors

This method will yield a RustitudeError if either of the parameters is not found by name.

pub fn fix( &mut self, amplitude: &str, parameter: &str, value: f64, ) -> Result<(), RustitudeError>

Fixes a Parameter in the Model to a given value.

This method technically sets the Parameter to be fixed and gives it an initial value of the given value. This method also handles groups of constrained parameters.

Errors

This method yields a RustitudeError if the parameter is not found by name.

pub fn free( &mut self, amplitude: &str, parameter: &str, ) -> Result<(), RustitudeError>

Frees a Parameter in the Model.

This method does not modify the initial value of the parameter. This method also handles groups of constrained parameters.

Errors

This method yields a RustitudeError if the parameter is not found by name.

pub fn set_bounds( &mut self, amplitude: &str, parameter: &str, bounds: (f64, f64), ) -> Result<(), RustitudeError>

Sets the bounds on a Parameter in the Model.

Errors

This method yields a RustitudeError if the parameter is not found by name.

pub fn set_initial( &mut self, amplitude: &str, parameter: &str, initial: f64, ) -> Result<(), RustitudeError>

Sets the initial value of a Parameter in the Model.

Errors

This method yields a RustitudeError if the parameter is not found by name.

pub fn get_bounds(&self) -> Vec<(f64, f64)>

Returns a list of bounds of free Parameters in the Model.

pub fn get_initial(&self) -> Vec<f64>

Returns a list of initial values of free Parameters in the Model.

pub fn get_n_free(&self) -> usize

Returns the number of free Parameters in the Model.

pub fn activate(&mut self, amplitude: &str)

Activates an Amplitude in the Model by name.

pub fn deactivate(&mut self, amplitude: &str)

Deactivates an Amplitude in the Model by name.

pub fn new(cohsums: Vec<CohSum>) -> Self

Creates a new Model from a list of CohSums.

pub fn compute( &self, parameters: &[f64], event: &Event, ) -> Result<f64, RustitudeError>

Computes the result of evaluating the terms in the model with the given Parameters for the given Event by summing the result of CohSum::compute for each CohSum contained in the Model.

Errors

This method yields a RustitudeError if any of the Amplitude::calculate steps fail.

pub fn norm_int( &self, parameters: &[f64], event: &Event, ) -> Result<f64, RustitudeError>

Computes the result of evaluating the terms in the model with the given Parameters for the given Event by summing the result of CohSum::norm_int for each CohSum contained in the Model.

Errors

This method yields a RustitudeError if any of the Amplitude::calculate steps fail.

pub fn load(&mut self, dataset: &Dataset) -> Result<(), RustitudeError>

Registers the Model with the Dataset by Amplitude::registering each Amplitude and setting the proper cache position and parameter starting index.

Errors

This method will yield a RustitudeError if any Amplitude::precalculate steps fail.

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.