Page principale | Liste des namespaces | Hiérarchie des classes | Liste par ordre alphabétique | Liste des composants | Liste des fichiers | Membres des namespaces | Composants | Déclarations

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

Classe representant les Contraintes. Plus de détails...

#include <Constraint.h>

Diagramme de collaboration de Modelib::Constraint:

Collaboration graph
[Légende]
Liste de tous les membres

Membres publics

 Constraint ()
 Constraint (Model &_m, VarId _id)
 Constraint (const Model &_m, VarId _id)
 Constraint (const Constraint &_c)
Constraint operator= (const Constraint &_c)
VarId GetId () const
ModelGetModel () const
bool Relax (float lagrangianValue=-Infinity)
LagrangianParam GetLagrangianParam () const
void Rename (const std::string &name)
void AddExpr (const Expr &)
Expr GetExpr (bool secondMember=false) const
Expr GetRelaxedExpr (bool secondMember=false) const
void SetSecondMember (float)
float GetSecondMember () const
float GetValue () const
 ~Constraint ()

Attributs Privés

Modelmodel
VarId id

Description détaillée

Classe representant les Contraintes.

Cette classe sert d'une part a la gestion de contraintes particuliaires et a la relaxation lagrangienne Elle permet entre autres l'ajout d'une expression ou la modification du second membre pour la contrainte ciblée

Définition à la ligne 50 du fichier Constraint.h.


Documentation des contructeurs et destructeurs

Modelib::Constraint::Constraint  )  [inline]
 

Contructeur par defaut

Définition à la ligne 57 du fichier Constraint.h.

Références id, et model.

Modelib::Constraint::Constraint Model _m,
VarId  _id
 

Constructeur de l'utilisateur

Paramètres:
m une référence sur un Model
id l'identifiant de contrainte

Définition à la ligne 43 du fichier Constraint.cpp.

Références model, et Modelib::VarId.

Modelib::Constraint::Constraint const Model _m,
VarId  _id
 

Constructeur de l'utilisateur avec un model constant

Paramètres:
m une référence constante sur un Model
id l'identifiant de contrainte

Définition à la ligne 53 du fichier Constraint.cpp.

Références model, et Modelib::VarId.

Modelib::Constraint::Constraint const Constraint _c  )  [inline]
 

Constructeur de copie

Définition à la ligne 63 du fichier Constraint.h.

Références id, et model.

Modelib::Constraint::~Constraint  )  [inline]
 

Définition à la ligne 104 du fichier Constraint.h.


Documentation des méthodes

void Modelib::Constraint::AddExpr const Expr expr  ) 
 

Permet d'ajouter une Expr au premier membre de la contrainte ne permet pas de modifier le second membre

Paramètres:
name le nouveau de la contrainte

Définition à la ligne 104 du fichier Constraint.cpp.

Références Modelib::Model::AddToConstraint(), et model.

Voici le graphique d'appel pour cette fonction:

Expr Modelib::Constraint::GetExpr bool  secondMember = false  )  const
 

Permet de récuperer une Expr de la contrainte

Définition à la ligne 117 du fichier Constraint.cpp.

Références Modelib::Expr::GetConstant(), Modelib::Model::GetRelaxedConstraintExpr(), et model.

Voici le graphique d'appel pour cette fonction:

VarId Modelib::Constraint::GetId  )  const [inline]
 

Geter de l'identifiant de contrainte

Renvoie:
L'identifiant de contrainte sous le format VarId.

Définition à la ligne 79 du fichier Constraint.h.

Références Modelib::VarId.

Référencé par Modelib::LagrangianParam::LagrangianParam(), et Modelib::operator==().

LagrangianParam Modelib::Constraint::GetLagrangianParam  )  const
 

Permet de récupérer le multiplicateur lagrangien associé à la contrainte

Renvoie:
une instance de LagrangianParam representant ce multiplicateur

Définition à la ligne 82 du fichier Constraint.cpp.

Références model.

Model* Modelib::Constraint::GetModel  )  const [inline]
 

Geter du modèle

Renvoie:
Un pointeur sur le Model où est définie la contrainte.

Définition à la ligne 84 du fichier Constraint.h.

Références model.

Référencé par Modelib::operator==().

Expr Modelib::Constraint::GetRelaxedExpr bool  secondMember = false  )  const
 

Permet de récuperer une Expr relaxée de la contrainte

Définition à la ligne 135 du fichier Constraint.cpp.

Références Modelib::Expr::GetConstant(), Modelib::Model::GetRelaxedConstraintExpr(), et model.

Voici le graphique d'appel pour cette fonction:

float Modelib::Constraint::GetSecondMember  )  const
 

Permet de récuperer le second membrer d'une contrainte

Définition à la ligne 153 du fichier Constraint.cpp.

Références Modelib::Model::GetSecondMember(), et model.

Voici le graphique d'appel pour cette fonction:

float Modelib::Constraint::GetValue  )  const
 

Constraint Modelib::Constraint::operator= const Constraint _c  )  [inline]
 

Définition à la ligne 69 du fichier Constraint.h.

Références id, et model.

bool Modelib::Constraint::Relax float  lagrangianValue = -Infinity  ) 
 

Relaxe une contrainte avec un multiplicateur lagrangien ayant une valeur de départ de lagrangianValue si lagrangianValue == -Infinity, le multiplicateur n'est pas définit

Paramètres:
float la valeur initiale du multiplicateur de Lagrange

Définition à la ligne 65 du fichier Constraint.cpp.

Références model, et Modelib::Model::RelaxConstraint().

Voici le graphique d'appel pour cette fonction:

void Modelib::Constraint::Rename const std::string &  name  ) 
 

Permet de renommer une contrainte

Paramètres:
name le nouveau de la contrainte

Définition à la ligne 90 du fichier Constraint.cpp.

Références model, et Modelib::Model::RenameConstraint().

Voici le graphique d'appel pour cette fonction:

void Modelib::Constraint::SetSecondMember float  value  ) 
 

Permet de redéfinir le second membrer d'une contrainte

Définition à la ligne 167 du fichier Constraint.cpp.

Références model, et Modelib::Model::SetSecondMember().

Voici le graphique d'appel pour cette fonction:


Documentation des données imbriquées

VarId Modelib::Constraint::id [private]
 

Définition à la ligne 53 du fichier Constraint.h.

Référencé par Constraint(), et operator=().

Model* Modelib::Constraint::model [private]
 

Définition à la ligne 52 du fichier Constraint.h.

Référencé par AddExpr(), Constraint(), GetExpr(), GetLagrangianParam(), GetModel(), GetRelaxedExpr(), GetSecondMember(), operator=(), Relax(), Rename(), et SetSecondMember().


La documentation associée à cette classe a été générée à partir des fichiers suivants :
Généré le Sun Oct 2 18:52:58 2005 pour Modelib par doxygen 1.3.6