Struct Counter

pub struct Counter {
    pub operation: Operation,
    pub dist: Option<Dist>,
    pub copy: bool,
}

A specification of how one of a Machine’s counters should be updated when transitioning to a State. Consists of an Operation to be applied to the counter with one of three values: by default, the value 1, unless a distribution is provided or the copy flag is set to true. If the copy flag is set to true, the counter will be updated with the value of the other counter prior to transitioning to the state. If a distribution is provided, the counter will be updated with a value sampled from the distribution.

Fields

operation: Operation

The operation to apply to the counter upon a state transition. If the distribution is not set and copy is false, the counter will be updated by 1.

dist: Option<Dist>

If set, sample the value to update the counter with from a distribution.

copy: bool

If set, the counter will be updated by the other counter’s value prior to transitioning to the state. Supersedes the dist field.

Implementations

impl Counter

pub fn new(operation: Operation) -> Self

Create a new counter with an operation that modifies the counter with value 1.

pub fn new_dist(operation: Operation, dist: Dist) -> Self

Create a new counter with an operation and a distribution to sample the value from.

pub fn new_copy(operation: Operation) -> Self

Create a new counter with an operation that copies the value of the other counter prior to transitioning to the state.

pub fn sample_value<R: RngCore>(&self, rng: &mut R) -> u64

Sample a value to update the counter with.

pub fn validate(&self) -> Result<(), Error>

Trait Implementations

impl Clone for Counter

fn clone(&self) -> Counter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Counter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Counter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Counter

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

Formats the value using the given formatter.

impl PartialEq for Counter

fn eq(&self, other: &Counter) -> 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 Serialize for Counter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Counter

impl StructuralPartialEq for Counter