Modelib: Référence de la classe Modelib::SolverAPI

Page principale | Liste des namespaces | Hiérarchie des classes | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de namespace | Membres de classe | Membres de fichier

# Référence de la classe Modelib::SolverAPI

`#include <SolverAPI.h>`

Graphe de collaboration de Modelib::SolverAPI:

[légende]
Liste de tous les membres

## Fonctions membres publiques
| SolverAPI (const SolverName=GLPK)
| ~SolverAPI ()
void | Init (const std::string &, const std::string &_path="")
| Initialisation du chemin du solver et du nom du fichier temporaire.
void | Init (const SolverName, const std::string &, const std::string &_path="")
| Initialisation du chemin du solver et du nom du fichier temporaire et du solveur.
void | SetAPI (const SolverName)
| Attribuer une nouvelle API.
SolverName | GetAPI () const
| Retourne le nom du solveur actuel, ou une erreur si il y en a pas.
const char * | GetfLP () const
| Retourne le nom du fichier LP utilisé.
void | SetfLP (const std::string &flp)
| Attribue le nom du fichier LP utilisé.
std::list< float > & | OutNumVarValues ()
std::list< std::string > & | GetNumVarNames ()
std::list< float > & | OutConstraintValues ()
std::list< std::string > & | GetConstraintNames ()
std::string & | GetObjectiveNames ()
float | GetObjectiveValue ()
bool | AddOption (const std::string &opt)
void | RemoveOption (const std::string &opt="zzERall")
float | Solve ()
void | Infos (std::string &op, std::string &info)
bool | IsSolved () const
bool | IsOptimal () const
void | Options (const std::string &opt)
void | RemoveOptions ()
void | SetMIP (bool isMIP)
std::list< std::string > & | GetNumVarNoms ()
std::list< std::string > & | GetConstraintNoms ()
## Fonctions membres protégées
void | AllocSolver (const SolverName)
| Créer une instance d'un solveur.
## Attributs privés
SolverName | apiSolver
| Le type de solveurs.
std::string | path
| Le chemin du soleur.
std::string | fileLP
| Le nom du fichier temporaire.
Solver * | solver
| Le solveur courant, celui qui est utilisée.
Solution | solution
| Conteneur des solutions, permet de garder une ancienne solution complète.

## Description détaillée

Classe qui réalise une pseudo-interface entre le 'Model' et les différents solveurs disponibles

Cette classe contient toutes les informations relatives au modèle courant. Elle ne contient pas les informations qui sont propres aux différents solveurs.

Définition à la ligne 61 du fichier SolverAPI.h.

## Documentation des contructeurs et destructeur

Modelib::SolverAPI::SolverAPI | ( | const SolverName | api = `GLPK` | ) |

  | Constructeur de notre interface Paramètres:
  | api | Le nom du solveur a utiliser (cf enumérateur SolverName)
Définition à la ligne 76 du fichier SolverAPI.cpp. Références AllocSolver(), et fileLP. Voici le graphe d'appel pour cette fonction:

Modelib::SolverAPI::~SolverAPI | ( |  | ) |

| Destructeur Définition à la ligne 91 du fichier SolverAPI.cpp. Références solver.

## Documentation des fonctions membres

bool Modelib::SolverAPI::AddOption | ( | const std::string & | opt | ) | `[inline]`

| Définition à la ligne 119 du fichier SolverAPI.h. Références Modelib::Solver::AddOption(), et solver. Voici le graphe d'appel pour cette fonction:

void Modelib::SolverAPI::AllocSolver | ( | const SolverName | api | ) | `[protected]`

| Créer une instance d'un solveur. Créer une instance d'un solveur Définition à la ligne 51 du fichier SolverAPI.cpp. Références Modelib::CPLEX, Modelib::GLPK, Modelib::GLPSOL, et solver. Référencé par SetAPI(), et SolverAPI().

SolverName Modelib::SolverAPI::GetAPI | ( |  | ) | const`[inline]`

| Retourne le nom du solveur actuel, ou une erreur si il y en a pas. Définition à la ligne 88 du fichier SolverAPI.h. Références apiSolver, Modelib::NONE, et solver.

std::list<std::string>& Modelib::SolverAPI::GetConstraintNames | ( |  | ) | `[inline]`

| Définition à la ligne 111 du fichier SolverAPI.h. Références Modelib::Solution::contraintesNOM, et solution.

std::list<std::string>& Modelib::SolverAPI::GetConstraintNoms | ( |  | ) | `[inline]`

| Définition à la ligne 144 du fichier SolverAPI.h. Références Modelib::Solution::contraintesNOM, et solution. Référencé par Modelib::Model::Solve().

const char* Modelib::SolverAPI::GetfLP | ( |  | ) | const`[inline]`

| Retourne le nom du fichier LP utilisé. Définition à la ligne 95 du fichier SolverAPI.h. Références fileLP. Référencé par Modelib::Model::Solve().

std::list<std::string>& Modelib::SolverAPI::GetNumVarNames | ( |  | ) | `[inline]`

| Définition à la ligne 109 du fichier SolverAPI.h. Références solution, et Modelib::Solution::variablesNOM.

std::list<std::string>& Modelib::SolverAPI::GetNumVarNoms | ( |  | ) | `[inline]`

| Définition à la ligne 142 du fichier SolverAPI.h. Références solution, et Modelib::Solution::variablesNOM. Référencé par Modelib::Model::Solve().

std::string& Modelib::SolverAPI::GetObjectiveNames | ( |  | ) | `[inline]`

| Définition à la ligne 112 du fichier SolverAPI.h. Références Modelib::Solution::objective, et solution.

float Modelib::SolverAPI::GetObjectiveValue | ( |  | ) | `[inline]`

| Définition à la ligne 113 du fichier SolverAPI.h. Références Modelib::Solution::objective, et solution.

void Modelib::SolverAPI::Infos | ( | std::string & | op,
|  | std::string & | info
| ) | `[inline]`

| Définition à la ligne 123 du fichier SolverAPI.h. Références Modelib::Solver::Infos(), et solver. Référencé par Modelib::Model::SolveInfos(). Voici le graphe d'appel pour cette fonction:

void Modelib::SolverAPI::Init | ( | const SolverName | api,
|  | const std::string & | tempFile,
|  | const std::string & | _path = `""`
| ) |

  | Initialisation du chemin du solver et du nom du fichier temporaire et du solveur. Initialisation du chemin du solver et du nom du fichier temporaire et du solveur Paramètres:
  | api | Le solveur à utiliser
  | tempFile | Le nom du fichier temporaire
  | _path | Le chemin du solveur, la commande sera "execute _path + exeSolver"
Définition à la ligne 117 du fichier SolverAPI.cpp. Références fileLP, path, et SetAPI(). Voici le graphe d'appel pour cette fonction:

void Modelib::SolverAPI::Init | ( | const std::string & | tempFile,
|  | const std::string & | _path = `""`
| ) |

  | Initialisation du chemin du solver et du nom du fichier temporaire. Initialisation du chemin du solver et du nom du fichier temporaire Paramètres:
  | tempFile | Le nom du fichier temporaire
  | _path | Le chemin du solveur, la commande sera "execute _path + exeSolver"
Définition à la ligne 102 du fichier SolverAPI.cpp. Références fileLP, path, et solver. Référencé par Modelib::Model::InitSolver().

bool Modelib::SolverAPI::IsOptimal | ( |  | ) | const`[inline]`

| Définition à la ligne 129 du fichier SolverAPI.h. Références Modelib::Solver::Optimal(), et solver. Référencé par Modelib::Model::Solve(). Voici le graphe d'appel pour cette fonction:

bool Modelib::SolverAPI::IsSolved | ( |  | ) | const`[inline]`

| Définition à la ligne 128 du fichier SolverAPI.h. Références Modelib::Solver::Solved(), et solver. Référencé par Modelib::Model::Solve(). Voici le graphe d'appel pour cette fonction:

void Modelib::SolverAPI::Options | ( | const std::string & | opt | ) | `[inline]`

| Définition à la ligne 136 du fichier SolverAPI.h. Références Modelib::Solver::AddOption(), et solver. Référencé par Modelib::Model::PushOptions(). Voici le graphe d'appel pour cette fonction:

std::list<float>& Modelib::SolverAPI::OutConstraintValues | ( |  | ) | `[inline]`

| Définition à la ligne 110 du fichier SolverAPI.h. Références Modelib::Solution::contraintesVAL, et solution. Référencé par Modelib::Model::Solve().

std::list<float>& Modelib::SolverAPI::OutNumVarValues | ( |  | ) | `[inline]`

| Définition à la ligne 108 du fichier SolverAPI.h. Références solution, et Modelib::Solution::variablesVAL. Référencé par Modelib::Model::Solve().

void Modelib::SolverAPI::RemoveOption | ( | const std::string & | opt = `"zzERall"` | ) | `[inline]`

| Définition à la ligne 120 du fichier SolverAPI.h. Références Modelib::Solver::RemoveOption(), et solver. Voici le graphe d'appel pour cette fonction:

void Modelib::SolverAPI::RemoveOptions | ( |  | ) | `[inline]`

| Définition à la ligne 137 du fichier SolverAPI.h. Références Modelib::Solver::RemoveOption(), et solver. Référencé par Modelib::Model::RemoveOptions(). Voici le graphe d'appel pour cette fonction:

void Modelib::SolverAPI::SetAPI | ( | const SolverName | api | ) |

| Attribuer une nouvelle API. Attribuer une nouvelle API Définition à la ligne 127 du fichier SolverAPI.cpp. Références AllocSolver(), apiSolver, Modelib::Solution::Clear(), solution, et solver. Référencé par Init(), et Modelib::Model::SetAPI(). Voici le graphe d'appel pour cette fonction:

void Modelib::SolverAPI::SetfLP | ( | const std::string & | flp | ) | `[inline]`

| Attribue le nom du fichier LP utilisé. Définition à la ligne 99 du fichier SolverAPI.h. Références fileLP.

void Modelib::SolverAPI::SetMIP | ( | bool | isMIP | ) | `[inline]`

| Définition à la ligne 139 du fichier SolverAPI.h. Références Modelib::Solver::SetMIP(), et solver. Référencé par Modelib::Model::Solve(). Voici le graphe d'appel pour cette fonction:

float Modelib::SolverAPI::Solve | ( |  | ) | `[inline]`

| Définition à la ligne 121 du fichier SolverAPI.h. Références fileLP, solution, Modelib::Solver::Solve(), et solver. Référencé par Modelib::Model::Solve(). Voici le graphe d'appel pour cette fonction:

## Documentation des données membres

SolverName Modelib::SolverAPI::apiSolver`[private]`

| Le type de solveurs. Définition à la ligne 63 du fichier SolverAPI.h. Référencé par GetAPI(), et SetAPI().

std::string Modelib::SolverAPI::fileLP`[private]`

| Le nom du fichier temporaire. Définition à la ligne 65 du fichier SolverAPI.h. Référencé par GetfLP(), Init(), SetfLP(), Solve(), et SolverAPI().

std::string Modelib::SolverAPI::path`[private]`

| Le chemin du soleur. Définition à la ligne 64 du fichier SolverAPI.h. Référencé par Init().

Solution Modelib::SolverAPI::solution`[private]`

| Conteneur des solutions, permet de garder une ancienne solution complète. Définition à la ligne 68 du fichier SolverAPI.h. Référencé par GetConstraintNames(), GetConstraintNoms(), GetNumVarNames(), GetNumVarNoms(), GetObjectiveNames(), GetObjectiveValue(), OutConstraintValues(), OutNumVarValues(), SetAPI(), et Solve().

Solver* Modelib::SolverAPI::solver`[private]`

| Le solveur courant, celui qui est utilisée. Définition à la ligne 66 du fichier SolverAPI.h. Référencé par AddOption(), AllocSolver(), GetAPI(), Infos(), Init(), IsOptimal(), IsSolved(), Options(), RemoveOption(), RemoveOptions(), SetAPI(), SetMIP(), Solve(), et ~SolverAPI().

La documentation de cette classe a été générée à partir des fichiers suivants:

- SolverAPI.h
- SolverAPI.cpp