Struct rustitude_core::amplitude::Scalar

pub struct Scalar;

A Node for computing a single scalar value from an input parameter.

This struct implements Node to generate a single new parameter called value.

Parameters:

• value: The value of the scalar.

Trait Implementations

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Field> Node<F> for Scalar

fn parameters(&self) -> Vec<String>

A method which specifies the number and order of parameters used by the Node.

fn calculate( &self, parameters: &[F], _event: &Event<F>, ) -> Result<Complex<F>, RustitudeError>

A method which runs every time the amplitude is evaluated and produces a [ComplexField].

fn precalculate(&mut self, _dataset: &Dataset<F>) -> Result<(), RustitudeError>

A method that is run once and stores some precalculated values given a Dataset input.

fn into_amplitude(self, name: &str) -> Amplitude<F>

where Self: Sized + 'static,

A convenience method for turning Nodes into Amplitudes.

fn named(self, name: &str) -> Amplitude<F>

where Self: Sized + 'static,

A convenience method for turning Nodes into Amplitudes. This method has a shorter name than Node::into_amplitude, which it calls.

fn is_python_node(&self) -> bool

A flag which says if the Node was written in Python. This matters because the GIL cannot currently play nice with rayon multithreading. You will probably never need to set this, as the only object which returns True is in the py_rustitude crate which binds this crate to Python.