This class represents the settings for Gurobi. More...

#include <GurobiSettings.h>

Inheritance diagram for storm::settings::modules::GurobiSettings:

Collaboration diagram for storm::settings::modules::GurobiSettings:

Public Member Functions
	GurobiSettings ()
	Creates a new set of Gurobi settings.

bool	isIntegerToleranceSet () const
	Retrieves whether the integer tolerance has been set.

double	getIntegerTolerance () const
	Retrieves the integer tolerance to be used.

bool	isNumberOfThreadsSet () const
	Retrieves whether the number of threads has been set.

uint64_t	getNumberOfThreads () const
	Retrieves the maximal number of threads Gurobi is allowed to use.

uint64_t	getMIPFocus () const
	Retrieves the selected high-level solution strategy for MILPs.

uint64_t	getNumberOfConcurrentMipThreads () const
	Retrieves the number of MIP solvers, Gurobi spawns in parallel.

solver::GurobiSolverMethod	getMethod () const
	Retrieves the solver method.

bool	isOutputSet () const
	Retrieves whether the output option was set.

bool	check () const override
	Checks whether the settings are consistent.

Public Member Functions inherited from storm::settings::modules::ModuleSettings
	ModuleSettings (std::string const &moduleName)
	Constructs a new settings object.

virtual	~ModuleSettings ()

virtual void	finalize ()
	Prepares the modules for further usage, should be called at the end of the initialization, before checks are executed.

std::unique_ptr< storm::settings::SettingMemento >	overrideOption (std::string const &name, bool requiredStatus)
	Sets the option with the given name to the required status.

std::string const &	getModuleName () const
	Retrieves the name of the module to which these settings belong.

std::vector< std::shared_ptr< Option > > const &	getOptions () const
	Retrieves the options of this module.

uint_fast64_t	getPrintLengthOfLongestOption (bool includeAdvanced) const
	Retrieves the (print) length of the longest option.

void	restoreDefaults ()
	Restores the default values for all arguments of all options.

Static Public Attributes
static const std::string	moduleName = "gurobi"

Additional Inherited Members
Protected Member Functions inherited from storm::settings::modules::ModuleSettings
Option &	getOption (std::string const &longName)
	Retrieves the option with the given long name.

Option const &	getOption (std::string const &longName) const
	Retrieves the option with the given long name.

bool	isSet (std::string const &optionName) const
	Retrieves whether the option with the given name was set.

void	set (std::string const &name)
	Sets the option with the specified name.

void	unset (std::string const &name)
	Unsets the option with the specified name.

void	addOption (std::shared_ptr< Option > const &option)
	Adds and registers the given option.

Detailed Description

This class represents the settings for Gurobi.

Definition at line 16 of file GurobiSettings.h.

Constructor & Destructor Documentation

◆ GurobiSettings()

storm::settings::modules::GurobiSettings::GurobiSettings ( )

Creates a new set of Gurobi settings.

Definition at line 23 of file GurobiSettings.cpp.

Member Function Documentation

◆ check()

bool storm::settings::modules::GurobiSettings::check ( ) const

overridevirtual

Checks whether the settings are consistent.

If they are inconsistent, an exception is thrown.

Returns: True if the settings are consistent.

Reimplemented from storm::settings::modules::ModuleSettings.

Definition at line 111 of file GurobiSettings.cpp.

◆ getIntegerTolerance()

double storm::settings::modules::GurobiSettings::getIntegerTolerance ( ) const

Retrieves the integer tolerance to be used.

Returns: The integer tolerance to be used.

Definition at line 78 of file GurobiSettings.cpp.

◆ getMethod()

solver::GurobiSolverMethod storm::settings::modules::GurobiSettings::getMethod ( ) const

Retrieves the solver method.

Returns

Definition at line 90 of file GurobiSettings.cpp.

◆ getMIPFocus()

uint64_t storm::settings::modules::GurobiSettings::getMIPFocus ( ) const

Retrieves the selected high-level solution strategy for MILPs.

Returns: The high-level solution strategy.

Definition at line 103 of file GurobiSettings.cpp.

◆ getNumberOfConcurrentMipThreads()

uint64_t storm::settings::modules::GurobiSettings::getNumberOfConcurrentMipThreads ( ) const

Retrieves the number of MIP solvers, Gurobi spawns in parallel.

Returns: The number of MIP solvers Gurobi spawns in parallel..

Definition at line 107 of file GurobiSettings.cpp.

◆ getNumberOfThreads()

uint64_t storm::settings::modules::GurobiSettings::getNumberOfThreads ( ) const

Retrieves the maximal number of threads Gurobi is allowed to use.

Returns: The maximally allowed number of threads.

Definition at line 86 of file GurobiSettings.cpp.

◆ isIntegerToleranceSet()

bool storm::settings::modules::GurobiSettings::isIntegerToleranceSet ( ) const

Retrieves whether the integer tolerance has been set.

Returns: True iff the integer tolerance has been set.

Definition at line 74 of file GurobiSettings.cpp.

◆ isNumberOfThreadsSet()

bool storm::settings::modules::GurobiSettings::isNumberOfThreadsSet ( ) const

Retrieves whether the number of threads has been set.

Returns: True iff the number of threads has been set.

Definition at line 82 of file GurobiSettings.cpp.

◆ isOutputSet()

bool storm::settings::modules::GurobiSettings::isOutputSet ( ) const

Retrieves whether the output option was set.

Returns: True iff the output option was set.

Definition at line 99 of file GurobiSettings.cpp.

Member Data Documentation

◆ moduleName

const std::string storm::settings::modules::GurobiSettings::moduleName = "gurobi"

static

Definition at line 82 of file GurobiSettings.h.

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

src/storm/settings/modules/GurobiSettings.h
src/storm/settings/modules/GurobiSettings.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members