Limbo 3.5.4
Loading...
Searching...
No Matches
limbo::solvers::MinCoefficientScaler< T, V > Class Template Reference

Scaling scheme with minimum coefficient in an expression. More...

#include <MultiKnapsackLagRelax.h>

Inheritance diagram for limbo::solvers::MinCoefficientScaler< T, V >:
limbo::solvers::ProblemScaler< T, V >

Public Types

typedef ProblemScaler< T, V > base_type
 base type
typedef base_type::model_type model_type
 model type
typedef base_type::value_type value_type
 value type
typedef base_type::expression_type expression_type
 expression type
typedef base_type::constraint_type constraint_type
 constraint type
typedef base_type::term_type term_type
 term type
Public Types inherited from limbo::solvers::ProblemScaler< T, V >
typedef LinearModel< T, V > model_type
 model type
typedef model_type::coefficient_value_type value_type
 value type
typedef model_type::expression_type expression_type
 expression type
typedef model_type::constraint_type constraint_type
 constraint type
typedef model_type::term_type term_type
 term type

Public Member Functions

 MinCoefficientScaler (value_type factor=1)
 constructor
 ~MinCoefficientScaler ()
 destructor
value_type operator() (expression_type const &expr) const
 API to compute scaling factor for expression using L2 norm.
value_type operator() (constraint_type const &constr) const
 API to compute scaling factor for constraints using L2 norm.
Public Member Functions inherited from limbo::solvers::ProblemScaler< T, V >
 ProblemScaler ()
 constructor
virtual ~ProblemScaler ()
 destructor

Protected Attributes

value_type m_scalingFactor
 constant scaling factor

Detailed Description

template<typename T, typename V>
class limbo::solvers::MinCoefficientScaler< T, V >

Scaling scheme with minimum coefficient in an expression.

Template Parameters
Tcoefficient value type
Vvariable value type

Definition at line 1108 of file MultiKnapsackLagRelax.h.

Member Typedef Documentation

◆ base_type

template<typename T, typename V>
typedef ProblemScaler<T, V> limbo::solvers::MinCoefficientScaler< T, V >::base_type

base type

Definition at line 1112 of file MultiKnapsackLagRelax.h.

◆ constraint_type

template<typename T, typename V>
typedef base_type::constraint_type limbo::solvers::MinCoefficientScaler< T, V >::constraint_type

constraint type

Definition at line 1120 of file MultiKnapsackLagRelax.h.

◆ expression_type

template<typename T, typename V>
typedef base_type::expression_type limbo::solvers::MinCoefficientScaler< T, V >::expression_type

expression type

Definition at line 1118 of file MultiKnapsackLagRelax.h.

◆ model_type

template<typename T, typename V>
typedef base_type::model_type limbo::solvers::MinCoefficientScaler< T, V >::model_type

model type

Definition at line 1114 of file MultiKnapsackLagRelax.h.

◆ term_type

template<typename T, typename V>
typedef base_type::term_type limbo::solvers::MinCoefficientScaler< T, V >::term_type

term type

Definition at line 1122 of file MultiKnapsackLagRelax.h.

◆ value_type

template<typename T, typename V>
typedef base_type::value_type limbo::solvers::MinCoefficientScaler< T, V >::value_type

value type

Definition at line 1116 of file MultiKnapsackLagRelax.h.

Constructor & Destructor Documentation

◆ MinCoefficientScaler()

template<typename T, typename V>
limbo::solvers::MinCoefficientScaler< T, V >::MinCoefficientScaler ( value_type factor = 1)
inline

constructor

Parameters
factora constant scaling factor

Definition at line 1126 of file MultiKnapsackLagRelax.h.

◆ ~MinCoefficientScaler()

template<typename T, typename V>
limbo::solvers::MinCoefficientScaler< T, V >::~MinCoefficientScaler ( )
inline

destructor

Definition at line 1128 of file MultiKnapsackLagRelax.h.

Member Function Documentation

◆ operator()() [1/2]

template<typename T, typename V>
value_type limbo::solvers::MinCoefficientScaler< T, V >::operator() ( constraint_type const & constr) const
inlinevirtual

API to compute scaling factor for constraints using L2 norm.

Parameters
constrconstraint
Returns
scaling factor

Reimplemented from limbo::solvers::ProblemScaler< T, V >.

Definition at line 1143 of file MultiKnapsackLagRelax.h.

◆ operator()() [2/2]

template<typename T, typename V>
value_type limbo::solvers::MinCoefficientScaler< T, V >::operator() ( expression_type const & expr) const
inlinevirtual

API to compute scaling factor for expression using L2 norm.

Parameters
exprexpression
Returns
scaling factor

Reimplemented from limbo::solvers::ProblemScaler< T, V >.

Definition at line 1133 of file MultiKnapsackLagRelax.h.

Member Data Documentation

◆ m_scalingFactor

template<typename T, typename V>
value_type limbo::solvers::MinCoefficientScaler< T, V >::m_scalingFactor
protected

constant scaling factor

Definition at line 1149 of file MultiKnapsackLagRelax.h.


The documentation for this class was generated from the following file: