PWLDefinition
A piecewise linear function constraint. More...
#include <xpress_objects.hpp>
Public Member Functions |
|
| PWLDefinition (xpress::objects::Variable input, xpress::objects::Variable resultant, xpress::SizedArray< double const > const &xval, xpress::SizedArray< double const > const &yval, std::optional< std::string > name) | |
| Create a piecewise linear function constraint. |
|
| auto | setName (std::optional< std::string > newName) -> PWLDefinition & |
| Set the name of the constraint. |
|
| Public Member Functions inherited from xpress::objects::ConstraintDefinition< PWL > | |
| virtual auto | getName () const -> std::optional< std::string > |
| Get the name of this constraint. |
|
| virtual auto | setConstraintName (std::optional< std::string > newName) -> ConstraintDefinition< PWL > &final |
| Set the name of this constraint. |
|
Detailed Description
A piecewise linear function constraint.
An instance of this class requires variable resultant to be the value of the piecewise linear function defined by xval and yval evaluated for variable input. Instances of this class describe a constraint that has not yet been added but can be added using XpressProblem.addConstraint() or XpressProblem.addPWL(). Users should usually not have to deal with this class explicitly.
- Since
- 44.00
Constructor & Destructor Documentation
PWLDefinition()
|
inline |
Create a piecewise linear function constraint.
- Parameters
-
input Input variable. resultant Result variable. xval x coordinates of breakpoints. yval x coordinates of breakpoints. name Name of constraint. Can be std::nullopt.
- Since
- 44.00
Member Function Documentation
setName()
|
inline |
Set the name of the constraint.
This is the same as ConstraintDefinition#setConstraintName(std::optional<std::string>) but with a different return type.
- Parameters
-
newName New name.
- Returns
- Always returns this instance.
- Since
- 44.00
The documentation for this class was generated from the following file:
- xpress_objects.hpp
© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.