Struct clingo::TheoryAtoms

pub struct TheoryAtoms(_);

Container that stores theory atoms, elements, and terms of a program.

See: Control::theory_atoms()

Methods

impl TheoryAtoms

pub fn size(&self) -> Result<usize, WrapperError>

Get the total number of theory atoms.

Important traits for TheoryAtomsIterator<'a>

impl<'a> Iterator for TheoryAtomsIterator<'a> type Item = Id;

pub fn iter(&self) -> TheoryAtomsIterator

Returns an iterator over the theory atoms.

pub fn term_type(&self, Id: Id) -> Option<TheoryTermType>

Get the type of the given theory term.

Arguments

• term - id of the term

pub fn term_number(&self, Id: Id) -> Option<i32>

Get the number of the given numeric theory term.

Pre-condition

The term must be of type TermType::Number.

Arguments

• term - id of the term

pub fn term_name<'a>(&self, Id: Id) -> Result<&'a str, Error>

Get the name of the given constant or function theory term.

Pre-condition

The term must be of type TermType::Function or TermType::Symbol.

Arguments

• term id of the term

pub fn term_arguments(&self, Id: Id) -> Option<Vec<Id>>

Get the arguments of the given function theory term.

Pre-condition

The term must be of type TermType::Function.

Arguments

• term - id of the term

pub fn term_to_string(&self, Id: Id) -> Result<&str, Error>

Get the string representation of the given theory term.

Arguments

• term - id of the term

Errors

• ErrorType::Runtime if the size is too small
• ErrorType::BadAlloc

pub fn element_tuple(&self, Id: Id) -> Option<Vec<Id>>

Get the tuple (array of theory terms) of the given theory element.

Arguments

• element - id of the element

pub fn element_condition(&self, Id: Id) -> Option<Vec<Literal>>

Get the condition (array of aspif literals) of the given theory element.

Arguments

• element - id of the element

pub fn element_condition_id(&self, Id: Id) -> Option<Literal>

Get the id of the condition of the given theory element.

Note: This id can be mapped to a solver literal using PropagateInit::solver_literal(). This id is not (necessarily) an aspif literal; to get aspif literals use TheoryAtoms::element_condition().

Arguments

• element - id of the element

pub fn element_to_string(&self, Id: Id) -> Result<&str, Error>

Get the string representation of the given theory element.

Arguments

• element - id of the element

Errors

• ErrorType::Runtime if the size is too small
• ErrorType::BadAlloc

pub fn atom_term(&self, Id: Id) -> Option<Id>

Get the theory term associated with the theory atom.

Arguments

• atom id of the atom

pub fn atom_elements(&self, Id: Id) -> Option<Vec<Id>>

Get the theory elements associated with the theory atom.

Arguments

• atom - id of the atom

pub fn atom_has_guard(&self, Id: Id) -> Option<bool>

Whether the theory atom has a guard.

Arguments

• atom id of the atom

pub fn atom_guard(&self, Id: Id) -> Result<(&str, Id), Error>

Get the guard consisting of a theory operator and a theory term of the given theory atom.

Arguments

• atom - id of the atom

pub fn atom_literal(&self, Id: Id) -> Option<Literal>

Get the aspif literal associated with the given theory atom.

Arguments

• atom id of the atom

pub fn atom_to_string(&self, Id: Id) -> Result<&str, Error>

Get the string representation of the given theory atom.

Arguments

• atom - id of the element

Errors

• ErrorType::Runtime if the size is too small
• ErrorType::BadAlloc

Trait Implementations

impl Debug for TheoryAtoms

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

Formats the value using the given formatter.

impl Copy for TheoryAtoms

impl Clone for TheoryAtoms

fn clone(&self) -> TheoryAtoms

Returns a copy of the value.

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

Performs copy-assignment from source.