Struct rate_common::literal::Literal

pub struct Literal {
    pub encoding: u32,
}

A literal, encoded as 32 bit unsigned integer.

Fields

encoding: u32

We use a sign-magnitude encoding (also used by AIGER and others). This allows us to directly use this as offset.

• The least significant bit is the sign (negative if it is 1).
• The remaining bits encode the variable.

Methods

impl Literal

pub fn new(value: i32) -> Literal

Create a literal from the signed representation used in DIMACS.

pub const fn from_raw(encoding: u32) -> Literal

Create a literal without conversion.

pub const TOP: Literal

Encoded as 0.

pub const BOTTOM: Literal

Encoded as 1.

pub const NEVER_READ: Literal

Sentinel value of u32::max_value() to detect errors.

pub fn decode(self) -> i32

DIMACS representation.

Examples

use rate_common::literal::Literal;
assert_eq!(Literal::new(-1).decode(), -1);

pub const fn variable(self) -> Variable

Examples

use rate_common::literal::{Literal, Variable};
assert_eq!(Literal::new(-3).variable(), Variable(3));

pub fn is_constant(self) -> bool

True if it is Literal::TOP or Literal::BOTTOM.

Examples

use rate_common::literal::Literal;
assert!(Literal::TOP.is_constant());
assert!(!Literal::new(-3).is_constant());

pub fn all(maxvar: Variable) -> impl Iterator<Item = Literal>

Produce all literals from 1 and -1 up to the given variable.

Examples

use rate_common::literal::{Literal, Variable};
assert_eq!(Literal::all(Variable(2)).collect::<Vec<_>>(),
          vec!(Literal::new(1), Literal::new(-1), Literal::new(2), Literal::new(-2)));

pub const fn is_zero(self) -> bool

Examples

use rate_common::literal::Literal;
assert!(Literal::new(0).is_zero());
assert!(!Literal::new(1).is_zero());

Trait Implementations

impl Offset for Literal

Enable as array index.

fn as_offset(&self) -> usize

impl Clone for Literal

fn clone(&self) -> Literal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Literal

impl Default for Literal

fn default() -> Literal

Returns the "default value" for a type.

impl Eq for Literal

impl Ord for Literal

fn cmp(&self, other: &Literal) -> 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<Literal> for Literal

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

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

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

This method tests for !=.

impl PartialOrd<Literal> for Literal

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

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

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

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

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

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

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

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

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

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

impl Display for Literal

Examples

use rate_common::literal::Literal;
assert_eq!(format!("{}", Literal::TOP), "+0");
assert_eq!(format!("{}", Literal::BOTTOM), "-0");
assert_eq!(format!("{}", Literal::new(11)), "11");

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

Formats the value using the given formatter.

impl Debug for Literal

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

Formats the value using the given formatter.

impl Neg for Literal

Negate a literal with operator -.

Examples

use rate_common::literal::Literal;
assert!(-Literal::TOP == Literal::BOTTOM);

type Output = Literal

The resulting type after applying the - operator.

fn neg(self) -> Literal

Performs the unary - operation.

impl Index<Literal> for Assignment

type Output = bool

The returned type after indexing.

fn index(&self, literal: Literal) -> &bool

This assumes that we don't ever pass a constant literal, however this can be changed if necessary.

impl Hash for Literal

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, 

Feeds a slice of this type into the given [Hasher].

impl Serialize for Literal

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Literal

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.