Struct rustitude_core::amplitude::Piecewise

pub struct Piecewise<V, F>
where
    V: Fn(&Event<F>) -> F + Send + Sync + Copy,
    F: Field,
{ /* private fields */ }

A generic struct which can be used to create any kind of piecewise function.

Implementations

impl<V, F> Piecewise<V, F>

where V: Fn(&Event<F>) -> F + Send + Sync + Copy, F: Field + Float,

pub fn new(bins: usize, range: (F, F), variable: V) -> Self

Create a new Piecewise struct from a number of bins, a range of values, and a callable which defines a variable over the Events in a Dataset.

Trait Implementations

impl<V, F> Clone for Piecewise<V, F>

where V: Fn(&Event<F>) -> F + Send + Sync + Copy + Clone, F: Field + Clone,

fn clone(&self) -> Piecewise<V, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V, F> Node<F> for Piecewise<V, F>

where V: Fn(&Event<F>) -> F + Send + Sync + Copy, F: Field,

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 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 parameters(&self) -> Vec<String>

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

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.