Limbo 3.5.4
Loading...
Searching...
No Matches
limbo::solvers::GurobiLinearApi< T, V > Class Template Reference

Gurobi API with limbo::solvers::LinearModel. More...

#include <GurobiApi.h>

Public Types

typedef LinearModel< T, V > model_type
 linear model type for the problem
typedef model_type::coefficient_value_type coefficient_value_type
typedef model_type::variable_value_type variable_value_type
typedef model_type::variable_type variable_type
typedef model_type::constraint_type constraint_type
typedef model_type::expression_type expression_type
typedef model_type::term_type term_type
typedef model_type::property_type property_type
typedef GurobiParameters parameter_type

Public Member Functions

 GurobiLinearApi (model_type *model)
 constructor
 ~GurobiLinearApi ()
 destructor
SolverProperty operator() (parameter_type *param=NULL)
 API to run the algorithm.
void errorHandler (GRBenv *env, int error) const
 error handler

Protected Member Functions

 GurobiLinearApi (GurobiLinearApi const &rhs)
 copy constructor, forbidden
GurobiLinearApioperator= (GurobiLinearApi const &rhs)
 assignment, forbidden

Protected Attributes

model_typem_model
 model for the problem
GRBmodel * m_grbModel
 model for Gurobi

Detailed Description

template<typename T, typename V>
class limbo::solvers::GurobiLinearApi< T, V >

Gurobi API with limbo::solvers::LinearModel.

Template Parameters
Tcoefficient type
Vvariable type

Definition at line 96 of file GurobiApi.h.

Member Typedef Documentation

◆ coefficient_value_type

template<typename T, typename V>
typedef model_type::coefficient_value_type limbo::solvers::GurobiLinearApi< T, V >::coefficient_value_type

Definition at line 102 of file GurobiApi.h.

◆ constraint_type

template<typename T, typename V>
typedef model_type::constraint_type limbo::solvers::GurobiLinearApi< T, V >::constraint_type

Definition at line 105 of file GurobiApi.h.

◆ expression_type

template<typename T, typename V>
typedef model_type::expression_type limbo::solvers::GurobiLinearApi< T, V >::expression_type

Definition at line 106 of file GurobiApi.h.

◆ model_type

template<typename T, typename V>
typedef LinearModel<T, V> limbo::solvers::GurobiLinearApi< T, V >::model_type

linear model type for the problem

Definition at line 100 of file GurobiApi.h.

◆ parameter_type

template<typename T, typename V>
typedef GurobiParameters limbo::solvers::GurobiLinearApi< T, V >::parameter_type

Definition at line 109 of file GurobiApi.h.

◆ property_type

template<typename T, typename V>
typedef model_type::property_type limbo::solvers::GurobiLinearApi< T, V >::property_type

Definition at line 108 of file GurobiApi.h.

◆ term_type

template<typename T, typename V>
typedef model_type::term_type limbo::solvers::GurobiLinearApi< T, V >::term_type

Definition at line 107 of file GurobiApi.h.

◆ variable_type

template<typename T, typename V>
typedef model_type::variable_type limbo::solvers::GurobiLinearApi< T, V >::variable_type

Definition at line 104 of file GurobiApi.h.

◆ variable_value_type

template<typename T, typename V>
typedef model_type::variable_value_type limbo::solvers::GurobiLinearApi< T, V >::variable_value_type

Definition at line 103 of file GurobiApi.h.

Constructor & Destructor Documentation

◆ GurobiLinearApi() [1/2]

template<typename T, typename V>
limbo::solvers::GurobiLinearApi< T, V >::GurobiLinearApi ( model_type * model)
inline

constructor

Parameters
modelpointer to the model of problem

Definition at line 114 of file GurobiApi.h.

◆ ~GurobiLinearApi()

template<typename T, typename V>
limbo::solvers::GurobiLinearApi< T, V >::~GurobiLinearApi ( )
inline

destructor

Definition at line 120 of file GurobiApi.h.

◆ GurobiLinearApi() [2/2]

template<typename T, typename V>
limbo::solvers::GurobiLinearApi< T, V >::GurobiLinearApi ( GurobiLinearApi< T, V > const & rhs)
protected

copy constructor, forbidden

Parameters
rhsright hand side

Member Function Documentation

◆ errorHandler()

template<typename T, typename V>
void limbo::solvers::GurobiLinearApi< T, V >::errorHandler ( GRBenv * env,
int error ) const

error handler

Parameters
envenvironment
errorerror type

Definition at line 268 of file GurobiApi.h.

◆ operator()()

template<typename T, typename V>
SolverProperty limbo::solvers::GurobiLinearApi< T, V >::operator() ( parameter_type * param = NULL)
inline

API to run the algorithm.

Parameters
paramset additional parameters, use default if NULL

Definition at line 126 of file GurobiApi.h.

◆ operator=()

template<typename T, typename V>
GurobiLinearApi & limbo::solvers::GurobiLinearApi< T, V >::operator= ( GurobiLinearApi< T, V > const & rhs)
protected

assignment, forbidden

Parameters
rhsright hand side

Member Data Documentation

◆ m_grbModel

template<typename T, typename V>
GRBmodel* limbo::solvers::GurobiLinearApi< T, V >::m_grbModel
protected

model for Gurobi

Definition at line 264 of file GurobiApi.h.

◆ m_model

template<typename T, typename V>
model_type* limbo::solvers::GurobiLinearApi< T, V >::m_model
protected

model for the problem

Definition at line 263 of file GurobiApi.h.


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