Struct aces::CEStructure

pub struct CEStructure { /* fields omitted */ }

A single c-e structure.

Internally, instances of this type own structural information (the cause and effect polynomials), semantic properties (node capacities for the carrier), the intermediate content representation from which a c-e structure originated (optionally), and some auxiliary recomputable data. Other properties are available indirectly: CEStructure instance owns a ContextHandle which resolves to a shared Context object.

Methods

impl CEStructure

pub fn new(ctx: &ContextHandle) -> Self

Creates an empty c-e structure in a Context given by a ContextHandle.

pub fn set_encoding(&mut self, encoding: Encoding)

pub fn add_causes<'a, I>(
    &mut self,
    node_id: NodeID,
    poly_ids: I
) -> Result<(), AcesError> where
    I: IntoIterator + 'a,
    I::Item: IntoIterator<Item = &'a NodeID>, 

Constructs new Polynomial from a sequence of sequences of NodeIDs and adds it to causes of a node of this CEStructure.

This method is incremental: new polynomial is added to old polynomial that is already attached to the node_id as node's causes (there is always some polynomial attached, if not explicitly, then implicitly, as the default θ).

pub fn add_effects<'a, I>(
    &mut self,
    node_id: NodeID,
    poly_ids: I
) -> Result<(), AcesError> where
    I: IntoIterator + 'a,
    I::Item: IntoIterator<Item = &'a NodeID>, 

Constructs new Polynomial from a sequence of sequences of NodeIDs and adds it to effects of a node of this CEStructure.

This method is incremental: new polynomial is added to old polynomial that is already attached to the node_id as node's effects (there is always some polynomial attached, if not explicitly, then implicitly, as the default θ).

pub fn from_content(
    ctx: &ContextHandle,
    content: Box<dyn Content>
) -> Result<Self, Box<dyn Error>>

pub fn from_str<S: AsRef<str>>(
    ctx: &ContextHandle,
    script: S
) -> Result<Self, Box<dyn Error>>

Creates a new c-e structure from a textual description and in a Context given by a ContextHandle.

pub fn from_file<P: AsRef<Path>>(
    ctx: &ContextHandle,
    path: P
) -> Result<Self, Box<dyn Error>>

Creates a new c-e structure from a script file to be found along the path and in a Context given by a ContextHandle.

pub fn get_context(&self) -> &ContextHandle

pub fn get_name(&self) -> Option<&str>

pub fn is_coherent(&self) -> bool

Returns link coherence status indicating whether this object represents a proper c-e structure.

C-e structure is coherent iff it has no thin links, where a link is thin iff it occurs either in causes or in effects, but not in both. Internally, there is a thin links counter associated with each CEStructure object. This counter is updated whenever a polynomial is added to the structure.

pub fn get_port_link_formula(&self) -> Result<Formula, Box<dyn Error>>

pub fn get_fork_join_formula(&self) -> Result<Formula, Box<dyn Error>>

pub fn solve(&mut self, minimal_mode: bool) -> Result<(), Box<dyn Error>>

pub fn get_firing_components(&self) -> Option<&[FiringComponent]>

Trait Implementations

impl Debug for CEStructure

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

Formats the value using the given formatter.