GradientScaling Class Reference
#include <IpGradientScaling.hpp>
Detailed Description
This class does problem scaling by setting the scaling parameters based on the maximum of the gradient at the user provided initial point.Public Member Functions | |
Constructors/Destructors | |
| GradientScaling (const SmartPtr< NLP > &nlp) | |
| Default destructor. | |
| virtual | ~GradientScaling () |
| Default destructor. | |
Static Public Member Functions | |
| static void | RegisterOptions (const SmartPtr< RegisteredOptions > &roptions) |
| Methods for IpoptType. | |
Protected Member Functions | |
| bool | InitializeImpl (const OptionsList &options, const std::string &prefix) |
| Initialize the object from the options. | |
| virtual void | DetermineScalingParametersImpl (const SmartPtr< const VectorSpace > x_space, const SmartPtr< const VectorSpace > c_space, const SmartPtr< const VectorSpace > d_space, const SmartPtr< const MatrixSpace > jac_c_space, const SmartPtr< const MatrixSpace > jac_d_space, const SmartPtr< const SymMatrixSpace > h_space, Number &df, SmartPtr< Vector > &dx, SmartPtr< Vector > &dc, SmartPtr< Vector > &dd) |
| This is the method that has to be overloaded by a particular scaling method that somehow computes the scaling vectors dx, dc, and dd. | |
Constructor & Destructor Documentation
| GradientScaling | ( | const SmartPtr< NLP > & | nlp | ) | [inline] |
Default destructor.
| virtual ~GradientScaling | ( | ) | [inline, virtual] |
Default destructor.
Member Function Documentation
| void RegisterOptions | ( | const SmartPtr< RegisteredOptions > & | roptions | ) | [static] |
Methods for IpoptType.
Register the options for this class
Referenced by Ipopt::RegisterOptions_Algorithm().
| bool InitializeImpl | ( | const OptionsList & | options, | |
| const std::string & | prefix | |||
| ) | [protected, virtual] |
Initialize the object from the options.
Reimplemented from StandardScalingBase.
References OptionsList::GetNumericValue(), and StandardScalingBase::InitializeImpl().
| void DetermineScalingParametersImpl | ( | const SmartPtr< const VectorSpace > | x_space, | |
| const SmartPtr< const VectorSpace > | c_space, | |||
| const SmartPtr< const VectorSpace > | d_space, | |||
| const SmartPtr< const MatrixSpace > | jac_c_space, | |||
| const SmartPtr< const MatrixSpace > | jac_d_space, | |||
| const SmartPtr< const SymMatrixSpace > | h_space, | |||
| Number & | df, | |||
| SmartPtr< Vector > & | dx, | |||
| SmartPtr< Vector > & | dc, | |||
| SmartPtr< Vector > & | dd | |||
| ) | [protected, virtual] |
This is the method that has to be overloaded by a particular scaling method that somehow computes the scaling vectors dx, dc, and dd.
The pointers to those vectors can be NULL, in which case no scaling for that item will be done later.
Implements StandardScalingBase.
References DBG_ASSERT, TripletHelper::FillRowCol(), TripletHelper::FillValues(), TripletHelper::GetNumberEntries(), Ipopt::GetRawPtr(), fkinkryx::i, Ipopt::IsValid(), Ipopt::J_DETAILED, Ipopt::J_INITIALIZATION, Ipopt::J_WARNING, NLPScalingObject::Jnlst(), Ipopt::Max(), Journalist::Printf(), Journalist::ProduceOutput(), TripletHelper::PutValuesInVector(), THROW_EXCEPTION, and x.
The documentation for this class was generated from the following files:
