Initializing help system before first use

LinCoef

A linear coefficient. More...

#include <xpress_objects.hpp>

Public Member Functions
  LinCoef ()
  Create a coefficient initialized to defaults.
 
  LinCoef (LinCoef const &other)
  Create a coefficient by copying another.
 
  LinCoef (Variable variable, double coefficient)
  Create a coefficient.
 
auto  getCoefficient () const -> double
  The coefficient in this linear coefficient [get].
 
auto  getVariable () const -> Variable
  The variable in this linear coefficient [get].
 

Detailed Description

A linear coefficient.

A linear coefficient is a variable/value pair that gives the factor for a variable in a linear expression.

Since
44.00

Constructor & Destructor Documentation

LinCoef() [1/3]

xpress::objects::LinCoef::LinCoef ( Variable variable,
double coefficient )
inline

Create a coefficient.

Parameters
variable Variable in the coefficient.
coefficient Value multiplying the variable in the coefficient.
Since
44.00

LinCoef() [2/3]

xpress::objects::LinCoef::LinCoef ( LinCoef const & other )
inline

Create a coefficient by copying another.

Parameters
other The coefficient to copy.
Since
44.00

LinCoef() [3/3]

xpress::objects::LinCoef::LinCoef ( )
inline

Create a coefficient initialized to defaults.

The coefficient will reference XpressProblem::NULL_VARIABLE and will have a coefficient of zero.

Since
44.00

Member Function Documentation

getCoefficient()

auto xpress::objects::LinCoef::getCoefficient ( ) const -> double
inline

The coefficient in this linear coefficient [get].

Since
44.00

getVariable()

auto xpress::objects::LinCoef::getVariable ( ) const -> Variable
inline

The variable in this linear coefficient [get].

Since
44.00
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.