Struct Statistics 

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

Handle for to the solver statistics.

Implementations

impl Statistics

pub fn root(&self) -> Result<u64, ClingoError>

Get the root key of the statistics.

pub fn statistics_type(&self, key: u64) -> Result<StatisticsType, ClingoError>

Get the type of a key.

Arguments

• key - the key

pub fn array_size(&self, key: u64) -> Result<usize, ClingoError>

Get the size of an array entry.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Array.

Arguments

• key - the key

pub fn array_at(&self, key: u64, offset: usize) -> Result<u64, ClingoError>

Get the subkey at the given offset of an array entry.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Array.

Arguments

• key - the key
• offset - the offset in the array

pub fn array_push( &mut self, key: u64, stype: StatisticsType, ) -> Result<u64, ClingoError>

Create the subkey at the end of an array entry.

#Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Array

Arguments

• key - the key
• stype - the type of the new subkey

pub fn map_size(&self, key: u64) -> Result<usize, ClingoError>

Get the number of subkeys of a map entry.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Map.

Arguments

• key - the key

pub fn map_has_subkey(&self, key: u64, name: &str) -> Result<bool, ClingoError>

Test if the given map contains a specific subkey.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Map.

Arguments

• key - the key
• name - name of the subkey

Errors

• ClingoError::InternalError
• ClingoError::NulError - if name contains a nul byte

pub fn map_subkey_name( &self, key: u64, offset: usize, ) -> Result<&str, ClingoError>

Get the name associated with the offset-th subkey.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Map.

Arguments

• key - the key
• offset - the offset of the name

Errors

• ClingoError::InternalError
• ClingoError::Utf8Error

pub fn map_at(&self, key: u64, name: &str) -> Result<u64, ClingoError>

Lookup a subkey under the given name.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Map.

Note: Multiple levels can be looked up by concatenating keys with a period.

Arguments

• key - the key
• name - the name to lookup the subkey

Errors

• ClingoError::InternalError
• ClingoError::NulError - if name contains a nul byte

pub fn map_add_subkey( &mut self, key: u64, name: &str, stype: StatisticsType, ) -> Result<u64, ClingoError>

Add a subkey with the given name.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Map.

Arguments

• key - the key
• name - the name to lookup the subkey
• stype - the type of the new subkey

Errors

• ClingoError::InternalError
• ClingoError::NulError - if name contains a nul byte

Returns the index of the resulting subkey

pub fn value_get(&self, key: u64) -> Result<f64, ClingoError>

Get the value of the given entry.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Value.

Arguments

• key - the key

pub fn value_set(&mut self, key: u64, value: f64) -> bool

Set the value of the given entry.

Pre-condition

The Statistics::statistics_type() of the entry must be StatisticsType::Value.

Arguments

• key - the key
• value - the new value

Returns whether the call was successful

Trait Implementations

impl Debug for Statistics

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

Formats the value using the given formatter.

impl From<&mut Statistics> for *mut clingo_statistic

fn from(stats: &mut Statistics) -> Self

Converts to this type from the input type.

impl From<Statistics> for clingo_statistic

fn from(stats: Statistics) -> Self

Converts to this type from the input type.