Struct RoundVM

Source

pub struct RoundVM { /* private fields */ }

Expand description

A Round correspond to a local computation in a device. Create the context, evaluate the aggregate program and share the exports to the neighborhood.

context - The context of the current round.
status - The status of the current round.
export_stack - The stack of exports of the current round.

Implementations§

Source §

impl RoundVM

Source

pub fn new(context: Context) -> Self

Create a new RoundVM

§Arguments

context - The context of the current round.

§Returns

A RoundVM instance.

Source

pub fn export_data(&mut self) -> &mut Export

Get the first export of the stack.

§Returns

The first export of the stack, of type &mut Export.

Source

pub fn self_id(&self) -> &i32

§Returns

The id of the device, of type i32.

Source

pub fn register_root<A: 'static + Clone>(&mut self, v: A)

Register the given value for the root path.

§Arguments

v - The value to register.

§Generic Parameters

A - The type of value. It must implement the Copy trait and have a 'static lifetime.

Source

pub fn neighbor(&self) -> &Option<i32>

If the computation is folding on a neighbor, return the id of the neighbor

§Returns

An &Option<i32> containing the id of the neighbor, if present

Source

pub fn index(&self) -> i32

§Returns

The index of the current computation.

Source

pub fn previous_round_val<A: 'static + Clone + FromStr>(&self) -> Result<A>

Obtain the value of the previous round for the current device and the current path.

§Generic Parameters

A - The type of value. It must implement the Clone trait and have a 'static lifetime.

§Returns

An Option containing the value of the current path for the current device, if present.

Source

pub fn neighbor_val<A: 'static + Clone + FromStr>(&self) -> Result<A>

Obtain the value of the current path for the current neighbor

§Generic Parameters

A - The type of value. It must implement the Clone trait and have a 'static lifetime.

§Returns

A Result containing the value of the current path for the current neighbor, if present.

Source

pub fn local_sense<A: 'static>(&self, sensor_id: &SensorId) -> Option<&A>

Obtain the local value of a given sensor.

§Arguments

- sensor_id - The id of the sensor.

§Generic Parameters

A - The type of value returned by the sensor. It must have a 'static lifetime.

§Returns

An Option containing the local value of the given sensor, if present.

Source

pub fn nbr_sense<A: 'static>(&self, sensor_id: &SensorId) -> Option<&A>

Obtain the value of a given sensor for the current neighbor.

§Arguments

sensor_id - The id of the sensor.

§Generic Parameters

A - The type of value returned by the sensor. It must have a 'static lifetime.

§Returns

An Option containing the value of the given sensor for the current neighbor, if present.

Source

pub fn locally<A: Clone + 'static + FromStr, F>(&mut self, expr: F) -> A
where F: Fn(&mut RoundVM) -> A,

Evaluates the given expression locally and return the result.

§Arguments

expr The expression to evaluate, which takes a RoundVM as argument and returns a tuple of RoundVM and A.

§Generic Parameters

A - The type of value returned by the expression.
F - The type of the closure, which must be a mutable closure that takes a RoundVM as argument and returns a tuple of RoundVM and A.

§Returns

The result of the closure expr.

Source

pub fn folded_eval<A: Clone + 'static, F>( &mut self, expr: F, id: i32, ) -> Option<A>
where F: Fn(&mut RoundVM) -> A,

Perform a folded evaluation of the given expression in the given neighbor and return the result.

§Arguments

expr - The expression to evaluate, which takes a RoundVM as argument and returns a tuple of RoundVM and A.
id - The id of the neighbor. It is of type i32.

§Generic Parameters

A - The type of value returned by the expression.
F - The type of the expression, which must be a closure that takes a RoundVM as argument and returns a tuple of RoundVM and A.

§Returns

An Option containing the result of the expression.

Source

pub fn nest<A: Clone + 'static + FromStr, F>( &mut self, slot: Slot, write: bool, inc: bool, expr: F, ) -> A
where F: Fn(&mut RoundVM) -> A,

Evaluate the given expression while also writing on the Export stack.

§Arguments

slot - The slot to write in the current Path.
write - A boolean indicating whether to write the result of the expression on the Export stack.
inc - A boolean indicating whether to increment the index of the current [VMStatus].
expr - The expression to evaluate, which takes a RoundVM as argument and returns a tuple of RoundVM and A.

§Generic Parameters

A - The type of value returned by the expression.
F - The type of the expression, which must be a closure that takes a RoundVM as argument and returns a tuple of RoundVM and A.

§Returns

A tuple of RoundVM and A.

Source

pub fn aligned_neighbours<A: 'static + FromStr + Clone>(&self) -> Vec<i32>

Get a vector of aligned neighbor identifiers.

§Returns

A vector of aligned neighbor identifiers.

Source

pub fn isolate<A, F>(&mut self, expr: F) -> A
where F: Fn(&mut RoundVM) -> A,

Isolate the current device and evaluate the given expression

§Arguments

expr - The closure to execute, which takes a RoundVM as argument and returns a tuple of RoundVM and A.

§Generic Parameters

A - The type of value returned by the closure.
F - The type of the closure, which must be a mutable closure takes a RoundVM as argument and returns a tuple of RoundVM and A.