Struct VecComputation

pub struct VecComputation<T, C = T, Marker = IndividualVariable>
where
    T: Send + Sync + 'static,
    C: Send + Sync + 'static,
    VecComputationFArgsSelector<C, Marker>: VecComputationFArgsSelectorTrait,
{ /* private fields */ }

A computation with a dynamic set of variables. Variables can be treated as single variable or as a group of variables.

let v1 = Variable::<u32>::new(1);
let v2 = Variable::<u32>::new(2);
let v3 = Variable::<u32>::new(3);

// Create a new computation `c1` with `v1` and `v2` as initial set of variables.
let mut c1 = VecComputation::<u32>::new(|v| v.into_iter().fold(0, |a, b| a + b), (&v1, &v2));
println!("{} == 3", *c1.read_result());

// Add `v3` to the set of varibles.
c1.push(&v3);
println!("{} == 6", *c1.read_result());

// Remove `v2` to the set of varibles.
c1.remove(&v2);
println!("{} == 4", *c1.read_result());

// Change the value of `v1`
v1.set(4);
println!("{} == 7", *c1.read_result());

Example of a VecComputation with grouped variables:

let v1: Variable<i32> = 0.into();
let v2: Variable<u32> = 1.into();
let v3: Variable<i32> = 2.into();

// Create a vec computation where the vector is made of a tuple of reference to i32 and u32 variables.
let mut c1 = VecComputation::<i32, (i32, u32, i32), markers::GroupedVariables>::new(
    |v: Vec<(&i32, &u32, &i32)>| v.into_iter().fold(0, |a, (b, c, d)| a + b + *c as i32 + d),
    (&(&v1, &v2, &v3),),
);

Implementations

impl<T, C, Marker> VecComputation<T, C, Marker>

where T: Send + Sync + 'static, C: Send + Sync + 'static, Marker: 'static, VecComputationFArgsSelector<C, Marker>: VecComputationFArgsSelectorTrait,

pub fn new<TVars>( formula: impl for<'a> Fn(Vec<<VecComputationFArgsSelector<C, Marker> as VecComputationFArgsSelectorTrait>::FArgs<'a>>) -> T + 'static + Send + Sync, tvars: TVars, ) -> Self

where TVars: ComputationVecBuilder<C, Marker>,

Create a new computation with the given formula and an initial vector of variables.

pub fn read_result<'a>(&'a self) -> impl Deref<Target = T> + 'a

Get the result of the computation. Re-compute it if outdated.

pub fn push<CII>(&mut self, var: &CII)

where CII: ComputationInputInterface<Type = C>, <CII as ComputationInputInterface>::InputReaderType: VecInputReader<C, Marker>,

Push a new variable to the computation variable

pub fn remove(&mut self, var: &impl ComputationInputInterface)

Remove a variable from the computation variable

impl<T, C> VecComputation<T, C>

where T: Default + Add<Output = T> + Sync + Send, C: Into<T> + Clone + Sync + Send,

pub fn sum<TVars>(tvars: TVars) -> Self

where TVars: ComputationVecBuilder<C, IndividualVariable>,

Create a VecComputation that computes the sum of the variables.

impl<T, C> VecComputation<T, C>

where T: Default + for<'a> Add<&'a T, Output = T> + Sync + Send, for<'a> &'a C: Into<&'a T>, C: Sync + Send,

pub fn sum_ref<TVars>(tvars: TVars) -> Self

where TVars: ComputationVecBuilder<C, IndividualVariable>,

Create a VecComputation that computes the sum of the variables.

impl<T, C> VecComputation<T, C>

where T: Default + Add<Output = T> + TryFrom<usize> + Div<Output = T> + Sync + Send, C: Into<T> + Clone + Sync + Send, <T as TryFrom<usize>>::Error: Debug,

pub fn average<TVars>(tvars: TVars) -> Self

where TVars: ComputationVecBuilder<C, IndividualVariable>,

Create a VecComputation that computes the average of the variables.

Trait Implementations

impl<T, C, Marker: Debug> Debug for VecComputation<T, C, Marker>

where T: Send + Sync + 'static + Debug, C: Send + Sync + 'static + Debug, VecComputationFArgsSelector<C, Marker>: VecComputationFArgsSelectorTrait,

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

Formats the value using the given formatter.

impl<T, C, Marker> PartialEq<T> for VecComputation<T, C, Marker>

where T: PartialEq + Send + Sync, C: Send + Sync + 'static, Marker: Send + Sync + 'static, VecComputationFArgsSelector<C, Marker>: VecComputationFArgsSelectorTrait,

fn eq(&self, other: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, C, Marker> PartialEq for VecComputation<T, C, Marker>

where T: PartialEq + Send + Sync, C: Send + Sync + 'static, Marker: Send + Sync + 'static, VecComputationFArgsSelector<C, Marker>: VecComputationFArgsSelectorTrait,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, C, Marker> PartialOrd<T> for VecComputation<T, C, Marker>

where T: PartialOrd + Send + Sync, C: Send + Sync + 'static, Marker: Send + Sync + 'static, VecComputationFArgsSelector<C, Marker>: VecComputationFArgsSelectorTrait,

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, C, Marker> PartialOrd for VecComputation<T, C, Marker>

where T: PartialOrd + Send + Sync, C: Send + Sync + 'static, Marker: Send + Sync + 'static, VecComputationFArgsSelector<C, Marker>: VecComputationFArgsSelectorTrait,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.