AdditionalConstraint Class Reference

additional constraint to add to master problem More...

#include <AdditionalConstraints.h>

Inheritance diagram for AdditionalConstraint:

Public Member Functions
	AdditionalConstraint ()=default
	AdditionalConstraint default constructor.
	AdditionalConstraint (std::string sectionName_p, std::string constraintName_p, std::string sign_p, double rhs_p)
	AdditionalConstraint constructor.
virtual	~AdditionalConstraint ()=default
	AdditionalConstraint destructor.
std::string	getName () const
	AdditionalConstraint::_name getter.
double	getRHS () const
	AdditionalConstraint::_rhs getter.
std::string	getSign () const
	AdditionalConstraint::_sign getter.
void	setCoeff (const std::string &varName_p, const double varCoeff_p)
	adds a term to the constraint

Detailed Description

additional constraint to add to master problem

inherites from a map where keys are variable names and values are the variables coeffs

Constructor & Destructor Documentation

AdditionalConstraint()

AdditionalConstraint::AdditionalConstraint ( std::string sectionName_p, std::string constraintName_p, std::string sign_p, double rhs_p )

inline

AdditionalConstraint constructor.

Parameters

sectionName_p	: string value : name of the section in the ini file that declared this constraint.
constraintName_p	: string value : name of the constraint.
sign_p	: string value : sign of the constraint. One of "less_or_equal", "equal" or "greater_or_equal"
rhs_p	: double RHS of the constraint

Member Function Documentation

getName()

std::string AdditionalConstraint::getName ( ) const

inlinenodiscard

AdditionalConstraint::_name getter.

Parameters

name_p

: string value : name of the constraint

getRHS()

double AdditionalConstraint::getRHS ( ) const

inlinenodiscard

AdditionalConstraint::_rhs getter.

Parameters

rhs_p

: double value : rhs of the constraint

getSign()

std::string AdditionalConstraint::getSign ( ) const

inlinenodiscard

AdditionalConstraint::_sign getter.

Parameters

name_p

: string value : sign of the constraint (supported values "less_or_equal", "equal", "greater_or_equal")

setCoeff()

void AdditionalConstraint::setCoeff ( const std::string & varName_p, const double varCoeff_p )

inline

adds a term to the constraint

Parameters

varName_p	: string value : name of the variable concerned
varCoeff_p	: double value : coefficient of the variable concerned

---

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

• src/cpp/lpnamer/problem_modifier/include/antares-xpansion/lpnamer/problem_modifier/AdditionalConstraints.h