Struct rate_common::literal::Variable

pub struct Variable(pub u32);

A variable, encoded as 32 bit unsigned integer.

Methods

impl Variable

pub fn new(value: u32) -> Variable

pub fn literal(self) -> Literal

Convert a variable to a positive literal.

pub fn array_size_for_variables(self) -> usize

The size of an array that can contain variables up to and including self.

pub fn array_size_for_literals(self) -> usize

The size of an array that can contain literals up to and including -self.literal().

Trait Implementations

impl Offset for Variable

Enable as array index.

fn as_offset(&self) -> usize

We simply use the variable index, so offset 0 will be generally unused.

impl Clone for Variable

fn clone(&self) -> Variable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Variable

impl Eq for Variable

impl Ord for Variable

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Variable> for Variable

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Variable> for Variable

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Display for Variable

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

Formats the value using the given formatter.

impl Debug for Variable

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

Formats the value using the given formatter.