Initializing help system before first use

QuadCoef

A quadratic coefficient. More...

#include <xpress_objects.hpp>

Public Member Functions
  QuadCoef ()
  Create a coefficient with default values.
 
  QuadCoef (QPair variables, double coefficient)
  Create a coefficient.
 
  QuadCoef (QuadCoef const &other)
 
  QuadCoef (Variable var1, Variable var2, double coefficient)
  Create a coefficient.
 
auto  getCoefficient () const -> double
  The value in this quadratic coefficient [get].
 
auto  getVar1 () -> xpress::objects::Variable
  Get the first variable in this quadratic coefficient.
 
auto  getVar2 () -> xpress::objects::Variable
  Get the second variable in this quadratic coefficient.
 
auto  getVariables () const -> QPair
  The variables in this quadratic coefficient [get].
 

Detailed Description

A quadratic coefficient.

A quadratic coefficient is a (variable,variable)/value pair that gives the factor for a pair of variables in a quadratic expression.

Since
44.00

Constructor & Destructor Documentation

QuadCoef() [1/4]

xpress::objects::QuadCoef::QuadCoef ( QPair variables,
double coefficient )
inline

Create a coefficient.

Parameters
variables The variables in the coefficient.
coefficient Value multiplying the variables in the coefficient.
Since
44.00

QuadCoef() [2/4]

xpress::objects::QuadCoef::QuadCoef ( Variable var1,
Variable var2,
double coefficient )
inline

Create a coefficient.

Note that the constructor puts var1 and var2 into a canonical ordering and may thus change their order.

Parameters
var1 First variable in coefficient.
var2 Second variable in coefficient.
coefficient Value multiplying the variables in coefficient.
Since
44.00

QuadCoef() [3/4]

xpress::objects::QuadCoef::QuadCoef ( QuadCoef const & other )
inline
Since
44.00

QuadCoef() [4/4]

xpress::objects::QuadCoef::QuadCoef ( )
inline

Create a coefficient with default values.

Since
44.00

Member Function Documentation

getCoefficient()

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

The value in this quadratic coefficient [get].

Since
44.00

getVar1()

auto xpress::objects::QuadCoef::getVar1 ( ) -> xpress::objects::Variable
inline

Get the first variable in this quadratic coefficient.

Returns
The first variable in this quadratic coefficient.
Since
44.00

getVar2()

auto xpress::objects::QuadCoef::getVar2 ( ) -> xpress::objects::Variable
inline

Get the second variable in this quadratic coefficient.

Returns
The second variable in this quadratic coefficient.
Since
44.00

getVariables()

auto xpress::objects::QuadCoef::getVariables ( ) const -> QPair
inline

The variables in this quadratic 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.