Initializing help system before first use

PWL

A piecewise lienar constraint. More...

#include <xpress_objects.hpp>

Inheritance diagram for xpress::objects::PWL:
xpress::objects::Index

Public Member Functions
virtual auto  compareTo (PWL const &other) const -> int final
 
auto  getBreakpoints () -> std::vector< xpress::PwlBreakpoint >
  Get the breakpoints for this piecewise linear constraint.
 
virtual auto  getHashCode () const -> std::size_t final
 
auto  getIndex () const -> int override
  Get the index that this object has in the underlying model.Attention: this is a very advanced function. Use it only if you know exactly what you are doing.
Returns
The index of this object in the underlying model.
Since
44.00

 
auto  getIndexForProb (XpressProblem const *xprob) const -> int override
  Get the index stored in this object but raise an exception if the problem that created this object is not prob.
Parameters
xprob The problem for which the index is queried. If this object does not belong to prob then an execption is raised.
Returns
The low-level index for this object in prob.
Since
44.00

 
auto  getInput () -> xpress::objects::Variable
  Get the input for this piecewise linear constraint.
 
auto  getName () const -> std::string override
  Get the name of this object.Queries the problem instance that owns this object and returns the name from that instance.
Returns
The name of this object.
Since
44.00

 
auto  getProblem () const -> xpress::objects::XpressProblem *override
  Get the problem to which this element belongs.
Returns
The problem to which this element belongs. This will be nullptr if the element was deleted.
Since
44.00

 
auto  getResultant () -> xpress::objects::Variable
  Get the resultant for this piecewise linear constraint.
 
auto  setName (std::optional< std::string > newName) -> PWL &
  Set the name of this PWL.
 
auto  updateIndex (int delta) -> void override
 
 Public Member Functions inherited from xpress::objects::Index

Detailed Description

A piecewise lienar constraint.

Since
44.00

Member Function Documentation

compareTo()

auto xpress::objects::PWL::compareTo ( PWL const & other ) const -> int
inlinefinalvirtual

Since
44.00

getBreakpoints()

auto xpress::objects::PWL::getBreakpoints ( ) -> std::vector<xpress::PwlBreakpoint>
inline

Get the breakpoints for this piecewise linear constraint.

Queries the xpress::objects::XpressProblem instance to which this pwl belongs and returns the breakpoints obtained from that instance.

Returns
This pwl's breakpoints.
Since
44.00

getHashCode()

auto xpress::objects::PWL::getHashCode ( ) const -> std::size_t
inlinefinalvirtual
Since
44.00

getIndex()

auto xpress::objects::PWL::getIndex ( ) const -> int
inlineoverridevirtual

Get the index that this object has in the underlying model.Attention: this is a very advanced function. Use it only if you know exactly what you are doing.

Returns
The index of this object in the underlying model.
Since
44.00

Since
44.00

Implements xpress::objects::Index.

getIndexForProb()

auto xpress::objects::PWL::getIndexForProb ( XpressProblem const * xprob ) const -> int
inlineoverridevirtual

Get the index stored in this object but raise an exception if the problem that created this object is not prob.

Parameters
xprob The problem for which the index is queried. If this object does not belong to prob then an execption is raised.
Returns
The low-level index for this object in prob.
Since
44.00

Since
44.00

Implements xpress::objects::Index.

getInput()

auto xpress::objects::PWL::getInput ( ) -> xpress::objects::Variable
inline

Get the input for this piecewise linear constraint.

Queries the xpress::objects::XpressProblem instance to which this pwl belongs and returns the input obtained from that instance.

Returns
This pwl's input
Since
44.00

getName()

auto xpress::objects::PWL::getName ( ) const -> std::string
inlineoverridevirtual

Get the name of this object.Queries the problem instance that owns this object and returns the name from that instance.

Returns
The name of this object.
Since
44.00

Since
44.00

Implements xpress::objects::Index.

getProblem()

auto xpress::objects::PWL::getProblem ( ) const -> xpress::objects::XpressProblem *
inlineoverridevirtual

Get the problem to which this element belongs.

Returns
The problem to which this element belongs. This will be nullptr if the element was deleted.
Since
44.00

Returns
The problem to which this element belongs. This will be nullptr if the element was deleted.
Since
44.00

Implements xpress::objects::Index.

getResultant()

auto xpress::objects::PWL::getResultant ( ) -> xpress::objects::Variable
inline

Get the resultant for this piecewise linear constraint.

Queries the xpress::objects::XpressProblem instance to which this pwl belongs and returns the resultant obtained from that instance.

Returns
This pwl's resultant.
Since
44.00

setName()

auto xpress::objects::PWL::setName ( std::optional< std::string > newName ) -> PWL&
inline

Set the name of this PWL.

Sets the name of this PWL in the problem instance that owns the object.

Parameters
newName The name to be set.
Returns
Always returns this instance.
Since
44.00

updateIndex()

auto xpress::objects::PWL::updateIndex ( int delta ) -> void
inlineoverridevirtual

Since
44.00

Implements xpress::objects::Index.

The documentation for this class was generated from the following file:
  • xpress_objects.hpp
Parent Topic objects

© 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.