Modelib: Constraint class Reference

Page principale | Hiérarchie des classes | Liste des composants | Liste des fichiers | Composants

# Référence de la classe Constraint

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

`#include <Constraint.h>`

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
Model * | GetModel () 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

## 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

## Documentation des contructeurs et destructeurs

Constraint::Constraint | ( |  | ) | `[inline]`

| Contructeur par defaut

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

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

Constraint::Constraint | ( | const Constraint & | _c | ) | `[inline]`

| Constructeur de copie

## Documentation des méthodes

void 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

Expr Constraint::GetExpr | ( | bool | secondMember = false | ) | const

| Permet de récuperer une Expr de la contrainte

VarId Constraint::GetId | ( |  | ) | const`[inline]`

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

LagrangianParam Constraint::GetLagrangianParam | ( |  | ) | const

| Permet de récupérer le multiplicateur lagrangien associé à la contrainte Renvoie: une instance de LagrangianParam representant ce multiplicateur

Model* Constraint::GetModel | ( |  | ) | const`[inline]`

| Geter du modèle Renvoie: Un pointeur sur le Model où est définie la contrainte.

Expr Constraint::GetRelaxedExpr | ( | bool | secondMember = false | ) | const

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

float Constraint::GetSecondMember | ( |  | ) | const

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

bool 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

void Constraint::Rename | ( | const std::string & | name | ) |

  | Permet de renommer une contrainte Paramètres:
  name | le nouveau de la contrainte

void Constraint::SetSecondMember | ( | float | value | ) |

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

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

- Constraint.h
- Constraint.cpp