Struct Model

pub struct Model<F: Field> {
    pub cohsums: Vec<NormSqr<F>>,
    pub amplitudes: Arc<RwLock<Vec<Amplitude<F>>>>,
    pub parameters: Vec<Parameter<F>>,
    pub contains_python_amplitudes: bool,
}

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

Fields

cohsums: Vec<NormSqr<F>>

The set of coherent sums included in the Model.

amplitudes: Arc<RwLock<Vec<Amplitude<F>>>>

The unique amplitudes located within all coherent sums.

parameters: Vec<Parameter<F>>

The unique parameters located within all coherent sums.

contains_python_amplitudes: bool

Flag which is True iff at least one Amplitude is written in Python and has a Node for which Node::is_python_node returns True.

Implementations

impl<F: Field> Model<F>

pub fn new(amps: &[Box<dyn AmpLike<F>>]) -> Self

Creates a new Model from a list of Box<AmpLike>s.

pub fn deep_clone(&self) -> Self

Creates a true clone (deep copy) of the Model where the amplitudes field is duplicated rather than having its reference count increased.

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

Computes the result of evaluating the terms in the model with the given Parameters for the given Event by summing the result of NormSqr::compute for each NormSqr contained in the Model (see the cohsum field of Model).

Errors

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

pub fn load(&mut self, dataset: &Dataset<F>) -> 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.

pub fn get_amplitude( &self, amplitude_name: &str, ) -> Result<Amplitude<F>, 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<F>, 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 free_parameters(&self) -> Vec<Parameter<F>>

Returns a Vec<Parameter<F>> containing the free parameters in the Model.

pub fn fixed_parameters(&self) -> Vec<Parameter<F>>

Returns a Vec<Parameter<F>> containing the fixed 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: F, ) -> 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: (F, F), ) -> 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: F, ) -> 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<(F, F)>

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

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

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) -> Result<(), RustitudeError>

Activates an Amplitude in the Model by name.

Errors

This function will return a RustitudeError::AmplitudeNotFoundError if the given amplitude is not present in the Model.

pub fn activate_all(&mut self)

Activates all Amplitudes in the Model.

pub fn isolate(&mut self, amplitudes: Vec<&str>) -> Result<(), RustitudeError>

Activate only the specified Amplitudes while deactivating the rest.

Errors

This function will return a RustitudeError::AmplitudeNotFoundError if a given amplitude is not present in the Model.

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

Deactivates an Amplitude in the Model by name.

Errors

This function will return a RustitudeError::AmplitudeNotFoundError if the given amplitude is not present in the Model.

pub fn deactivate_all(&mut self)

Deactivates all Amplitudes in the Model.

Trait Implementations

impl<F: Field> AsTree for Model<F>

fn _get_tree(&self, bits: &mut Vec<bool>) -> String

Prints the tree of an AsTree-implementor starting with a particular indentation structure defined by bits. A true bit will print a vertical line, while a false bit will not.

fn get_tree(&self) -> String

Returns a string representing the node and its children with tree formatting.

fn _get_indent(&self, bits: Vec<bool>) -> String

Returns a string with the proper indents for a given entry in AsTree::get_tree. A true bit will yield a vertical line, while a false bit will not.

fn _get_intermediate(&self) -> String

Returns a string with the intermediate branch symbol for a given entry in AsTree::get_tree.

fn _get_end(&self) -> String

Prints the a final branch for a given entry in AsTree::get_tree.

impl<F: Clone + Field> Clone for Model<F>

fn clone(&self) -> Model<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Field> Debug for Model<F>

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

Formats the value using the given formatter.

impl<F: Field> Display for Model<F>

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

Formats the value using the given formatter.