Initializing help system before first use

Index

Base class for objects that represent an indexed item in an XpressProblem. More...

#include <xpress_objects.hpp>

Inheritance diagram for xpress::objects::Index:
xpress::objects::GeneralConstraint xpress::objects::Inequality xpress::objects::PWL xpress::objects::SOS xpress::objects::Variable

Public Member Functions
virtual auto  getIndex () const -> int=0
  Get the index that this object has in the underlying model.
 
virtual auto  getIndexForProb (XpressProblem const *xprob) const -> int=0
  Get the index stored in this object but raise an exception if the problem that created this object is not prob.
 
virtual auto  getName () const -> std::string=0
  Get the name of this object.
 
virtual auto  getProblem () const -> XpressProblem *=0
  Get the problem to which this element belongs.
 

Detailed Description

Base class for objects that represent an indexed item in an XpressProblem.

Since
44.00

Member Function Documentation

getIndex()

virtual auto xpress::objects::Index::getIndex ( ) const -> int
pure virtual

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

Implemented in xpress::objects::GeneralConstraint, xpress::objects::Inequality, xpress::objects::PWL, xpress::objects::SOS, and xpress::objects::Variable.

getIndexForProb()

virtual auto xpress::objects::Index::getIndexForProb ( XpressProblem const * xprob ) const -> int
pure virtual

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

Implemented in xpress::objects::GeneralConstraint, xpress::objects::Inequality, xpress::objects::PWL, xpress::objects::SOS, and xpress::objects::Variable.

getName()

virtual auto xpress::objects::Index::getName ( ) const -> std::string
pure virtual

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

Implemented in xpress::objects::GeneralConstraint, xpress::objects::Inequality, xpress::objects::PWL, xpress::objects::SOS, and xpress::objects::Variable.

getProblem()

virtual auto xpress::objects::Index::getProblem ( ) const -> XpressProblem *
pure virtual

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

Implemented in xpress::objects::GeneralConstraint, xpress::objects::Inequality, xpress::objects::PWL, xpress::objects::SOS, and xpress::objects::Variable.

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.