Struct Action 

pub struct Action {
    variable_to_update: Variable,
    update_expr: UpdateExpression,
}

Action on a shared variables

This struct defines action in a GeneralThresholdAutomaton, describing how executing a rule will update a shared variable.

Fields

variable_to_update: Variable

Variable to be updated

update_expr: UpdateExpression

Expression specifying the update rule

Implementations

impl Action

fn count_number_of_var_occurrences_and_validate( var: &Variable, update_expr: &IntegerExpression<Variable>, ) -> Result<u32, InvalidUpdateError>

This function counts the number of occurrences of variable var in the expression and checks that no parameters appear

If a parameter or a variable that is not var is found in the expression, an error is returned

fn parse_to_update_expr( var: &Variable, update_expr: IntegerExpression<Variable>, ) -> Result<UpdateExpression, ActionBuilderError>

Try to parse a general integer expression into an update expression

pub fn new_reset(to_update: Variable) -> Self

Create a new reset action which a reset of var_to_update.

Example

use taco_threshold_automaton::general_threshold_automaton::Action;
use taco_threshold_automaton::expressions::*;
use taco_threshold_automaton::general_threshold_automaton::builder::*;

// action resetting var1
Action::new_reset(Variable::new("var1"));

pub fn new( to_update: Variable, update_expr: IntegerExpression<Variable>, ) -> Result<Self, ActionBuilderError>

Create a new action that updates variable var_to_update with the result of update_expr

Returns an error if the update expression is malformed, e.g. if the update refers to a different variable than the one to update.

Example

use taco_threshold_automaton::general_threshold_automaton::Action;
use taco_threshold_automaton::expressions::*;
use taco_threshold_automaton::general_threshold_automaton::builder::*;

// action incrementing var1
Action::new(
    Variable::new("var1"),
    IntegerExpression::Const(1)
        + IntegerExpression::Atom(Variable::new("var1")),
).unwrap();

pub fn new_with_update(var: Variable, update: UpdateExpression) -> Self

Create a new action that updates variable var according to update

Example

use taco_threshold_automaton::general_threshold_automaton::Action;
use taco_threshold_automaton::general_threshold_automaton::UpdateExpression;
use taco_threshold_automaton::expressions::Variable;
use taco_threshold_automaton::general_threshold_automaton::builder::*;

// action incrementing var1
Action::new_with_update(
    Variable::new("var1"),
    UpdateExpression::Inc(1),
);

impl Action

pub fn update(&self) -> &UpdateExpression

Get the update expression of the action

Trait Implementations

impl ActionDefinition for Action

fn variable(&self) -> &Variable

Returns the variable to be updated by the action

fn is_unchanged(&self) -> bool

Check whether the action does not change any variables, i.e. is a noop

fn is_reset(&self) -> bool

Check whether the action is a reset action

fn is_increment(&self) -> bool

Check whether the action is an increment action

fn is_decrement(&self) -> bool

Check whether the action is a decrement action

impl Clone for Action

fn clone(&self) -> Action

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Action

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

Formats the value using the given formatter.

impl Display for Action

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

Formats the value using the given formatter.

impl Hash for Action

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Action

fn cmp(&self, other: &Action) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Action

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

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

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 PartialOrd for Action

fn partial_cmp(&self, other: &Action) -> 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 Eq for Action

impl StructuralPartialEq for Action