Clingo::ConstStats Class Reference

Class modeling an immutable view on a statistics entry. More...

#include <stats.hh>

Inheritance diagram for Clingo::ConstStats:

Public Member Functions
	ConstStats (clingo_stats_t const *stats, uint64_t key)
	Construct a statistics entry from a pointer to the C API and a key.
auto	type () const -> StatsType
	Get the type of the statistics entry.
auto	array () const -> ConstStatsArray
	Get a view on the array of statistics entries if the entry is an array.
auto	at (size_t index) const -> ConstStats
	Get a statistics entry at the given index if the entry is an array.
auto	operator[] (size_t index) const -> ConstStats
	Get a statistics entry at the given index if the entry is an array.
auto	map () const -> ConstStatsMap
	Get a view on the map of statistics entries if the entry is a map.
auto	get (std::string_view name) const -> ConstStats
	Get a statistics entry with the given name if the entry is a map.
auto	operator[] (std::string_view name) const -> ConstStats
	Get a statistics entry with the given name if the entry is a map.
auto	value () const -> double
	Get the value of the statistics entry if it is a value.
auto	operator* () const -> double
	Get the value of the statistics entry if it is a value.
auto	to_string () const -> std::string
	Get a string representation of the statistics entry.

Friends
class	Stats
auto	c_cast (ConstStats const &stats) -> clingo_stats_t const *
	Cast to the underlying C API type.

Detailed Description

Class modeling an immutable view on a statistics entry.

Member Function Documentation

operator*()

auto Clingo::ConstStats::operator* ( ) const -> double

inline

Get the value of the statistics entry if it is a value.

Returns

the value of the statistics entry

operator[]() [1/2]

auto Clingo::ConstStats::operator[] ( size_t  index ) const -> ConstStats

inline

Get a statistics entry at the given index if the entry is an array.

Parameters

index

the index of the statistics entry to get

Returns

a statistics entry at the given index

operator[]() [2/2]

auto Clingo::ConstStats::operator[] ( std::string_view  name ) const -> ConstStats

inline

Get a statistics entry with the given name if the entry is a map.

Parameters

name	the name of the statistics entry to get

Returns

a statistics entry with the given name

to_string()

auto Clingo::ConstStats::to_string ( ) const -> std::string

inline

Get a string representation of the statistics entry.

The represention is YAML-like and can be used for debugging purposes.

Returns

a string representation of the statistics entry

type()

auto Clingo::ConstStats::type ( ) const -> StatsType

inline

Get the type of the statistics entry.

Returns

the type of the statistics entry

value()

auto Clingo::ConstStats::value ( ) const -> double

inline

Get the value of the statistics entry if it is a value.

Returns

the value of the statistics entry

Friends And Related Symbol Documentation

c_cast

auto c_cast ( ConstStats const &  stats ) -> clingo_stats_t const *

friend

Cast to the underlying C API type.

Parameters

stats

the statistics entry to cast

Returns

the underlying C API type

---

The documentation for this class was generated from the following file:

• clingo/stats.hh