Struct ascesis::Harc

pub struct Harc { /* fields omitted */ }

A common type of one-to-many and many-to-one arcs of the BF-hypergraph representation of c-e structures.

A hyperarc represents a monomial attached to a node. There are two possible interpretations of a Harc: a Join is a B-arc which represents causes and a Fork is an F-arc representing effects.

Methods

impl Harc

pub fn new_fork<I>(host_id: NodeID, suit_ids: I) -> Harc where
    I: IntoIterator<Item = NodeID>, 

Fork's constructor.

See also Harc::new_fork_unchecked().

pub fn new_join<I>(host_id: NodeID, suit_ids: I) -> Harc where
    I: IntoIterator<Item = NodeID>, 

Join's constructor.

See also Harc::new_join_unchecked().

pub fn new_fork_unchecked<I>(host_id: NodeID, suit_ids: I) -> Harc where
    I: IntoIterator<Item = NodeID>, 

A more efficient variant of Harc::new_fork().

Note: new Fork is created under the assumption that suit_ids are listed in ascending order. If the caller fails to provide an ordered suit, the library may panic in some other call (the constructor itself panics immediately in debug mode).

pub fn new_join_unchecked<I>(host_id: NodeID, suit_ids: I) -> Harc where
    I: IntoIterator<Item = NodeID>, 

A more efficient variant of Harc::new_join().

Note: new Join is created under the assumption that suit_ids are listed in ascending order. If the caller fails to provide an ordered suit, the library may panic in some other call (the constructor itself panics immediately in debug mode).

pub fn get_atom_id(&self) -> NonZeroUsize

pub fn get_fork_id(&self) -> Option<ForkID>

pub fn get_join_id(&self) -> Option<JoinID>

pub fn get_host_id(&self) -> NodeID

pub fn get_suit_ids(&self) -> &[NodeID]

Trait Implementations

impl Clone for Harc

fn clone(&self) -> Harc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Harc

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

Formats the value using the given formatter.

impl Eq for Harc

impl ExclusivelyContextual for Harc

fn format_locked(
    &self,
    ctx: &Context
) -> Result<String, Box<dyn Error + 'static>>

impl Hash for Harc

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

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 PartialEq<Harc> for Harc

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for Harc