Clingo
Loading...
Searching...
No Matches
Solver Configuration

Configuration of search and enumeration algorithms. More...

Classes

class  Clingo::ConstConfig
 Class modeling an immutable configuration entry. More...
 
class  Clingo::Config
 Class modeling a mutable configuration entry. More...
 
class  Clingo::ConstConfigArray
 Class modeling an immutable array of configuration entries. More...
 
class  Clingo::ConfigArray
 Class modeling a mutable array of configuration entries. More...
 
class  Clingo::ConstConfigMap
 Class modeling an immutable map of configuration entries. More...
 
class  Clingo::ConfigMap
 Class modeling a mutable map of configuration entries. More...
 

Enumerations

enum class  Clingo::ConfigType : clingo_config_type_bitset_t { ConfigType::value = clingo_config_type_value , ConfigType::array = clingo_config_type_array , ConfigType::map = clingo_config_type_map }
 Enumeration of configuration types. More...
 

Functions

 Clingo::CLINGO_ENABLE_BITSET_ENUM (ConfigType)
 Enable bitset operations for the configuration type.
 
auto Clingo::ConstConfig::array () const -> ConstConfigArray
 Access the configuration entry as an array.
 
auto Clingo::ConstConfig::at (size_t index) const -> ConstConfig
 Get the configuration entry at the given index in the array.
 
auto Clingo::Config::array () const -> ConfigArray
 Access the configuration entry as an array.
 
auto Clingo::Config::at (size_t index) const -> Config
 Get the configuration entry at the given index in the array.
 
auto Clingo::ConstConfig::map () const -> ConstConfigMap
 Access the configuration entry as a map.
 
auto Clingo::ConstConfig::get (std::string_view name) const -> ConstConfig
 Get the configuration entry with the given name in the map.
 
auto Clingo::Config::map () const -> ConfigMap
 Access the configuration entry as a map.
 
auto Clingo::Config::get (std::string_view name) const -> Config
 Get the configuration entry with the given name in the map.
 

Detailed Description

Configuration of search and enumeration algorithms.

Entries in a configuration are organized hierarchically. Subentries are either accessed by name for map entries or by offset for array entries. Value entries have a string value that can be inspected or modified.

Enumeration Type Documentation

◆ ConfigType

Enumeration of configuration types.

Enumerator
value 

The configuration entry is a double value.

array 

The configuration entry is a array of configurations.

map 

The configuration entry is a map of configurations.

Function Documentation

◆ array() [1/2]

auto Clingo::Config::array ( ) const -> ConfigArray
inline

Access the configuration entry as an array.

Returns
the configuration entry as an array

◆ array() [2/2]

auto Clingo::ConstConfig::array ( ) const -> ConstConfigArray
inline

Access the configuration entry as an array.

Returns
the configuration entry as an array

◆ at() [1/2]

auto Clingo::Config::at ( size_t  index) const -> Config
inline

Get the configuration entry at the given index in the array.

Parameters
indexthe index of the configuration entry
Returns
the configuration entry at the given index

◆ at() [2/2]

auto Clingo::ConstConfig::at ( size_t  index) const -> ConstConfig
inline

Get the configuration entry at the given index in the array.

Parameters
indexthe index of the configuration entry
Returns
the configuration entry at the given index

◆ get() [1/2]

auto Clingo::Config::get ( std::string_view  name) const -> Config
inline

Get the configuration entry with the given name in the map.

Parameters
namethe name of the configuration entry in the map
Returns
the configuration entry with the given name

◆ get() [2/2]

auto Clingo::ConstConfig::get ( std::string_view  name) const -> ConstConfig
inline

Get the configuration entry with the given name in the map.

Parameters
namethe name of the configuration entry in the map
Returns
the configuration entry with the given name

◆ map() [1/2]

auto Clingo::Config::map ( ) const -> ConfigMap
inline

Access the configuration entry as a map.

Returns
The configuration entry as a map.

◆ map() [2/2]

auto Clingo::ConstConfig::map ( ) const -> ConstConfigMap
inline

Access the configuration entry as a map.

Returns
The configuration entry as a map.