Struct JoinID

pub struct JoinID(/* private fields */);

An identifier of a Join, a type derived from AtomID.

There is a trivial bijection between values of this type and numeric codes of DIMACS variables. This mapping simplifies the construction of SAT queries and interpretation of solutions.

Implementations

impl JoinID

pub const fn get(self) -> AtomID

Trait Implementations

impl Atomic for JoinID

fn into_node_id(this: InContext<'_, Self>) -> Option<NodeID>

fn into_sat_literal(self, negated: bool) -> Literal

fn into_node_id_docked(this: InContext<'_, Self>, _dock: Face) -> Option<NodeID>

impl Clone for JoinID

fn clone(&self) -> JoinID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JoinID

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

Formats the value using the given formatter.

impl ExclusivelyContextual for JoinID

fn format_locked(&self, ctx: &Context) -> Result<String, AcesError>

impl From<JoinID> for AtomID

fn from(id: JoinID) -> Self

Converts to this type from the input type.

impl From<NonZero<usize>> for JoinID

fn from(id: AtomID) -> Self

Converts to this type from the input type.

impl Ord for JoinID

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

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

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

impl Eq for JoinID

impl StructuralPartialEq for JoinID