MoochoPack::LineSearch2ndOrderCorrect_Step Class Reference

Implements second order correction. More...

#include <MoochoPack_LineSearch2ndOrderCorrect_Step.hpp>

List of all members.

Options for 2nd order correction

void eta (const value_type &eta)
 the Armijo cord fractional reduction test parameter eta
const value_typeeta () const
void newton_olevel (const ENewtonOutputLevel &newton_olevel)
 Optput level for newton iterations.
const ENewtonOutputLevelnewton_olevel () const
void constr_norm_threshold (const value_type &constr_norm_threshold)
 constr_norm_threshold.
const value_typeconstr_norm_threshold () const
void constr_incr_ratio (const value_type &constr_incr_ratio)
 constr_incr_ratio
const value_typeconstr_incr_ratio () const
void after_k_iter (const int &after_k_iter)
 after_k_iter.
const int & after_k_iter () const
void forced_constr_reduction (const EForcedConstrReduction &forced_constr_reduction)
 forced_constr_reduction.
const EForcedConstrReductionforced_constr_reduction () const
void forced_reduct_ratio (const value_type &forced_reduct_ratio)
 forced_reduct_ratio
const value_typeforced_reduct_ratio () const
void max_step_ratio (const value_type &max_step_ratio)
 max_step_ratio.
const value_typemax_step_ratio () const
void max_newton_iter (const int &max_newton_iter)
 max_netwon_iter.
const int & max_newton_iter () const
value_type eta_
ENewtonOutputLevel newton_olevel_
value_type constr_norm_threshold_
value_type constr_incr_ratio_
int after_k_iter_
EForcedConstrReduction forced_constr_reduction_
value_type forced_reduct_ratio_
value_type max_step_ratio_
int max_newton_iter_

Public Types

typedef Teuchos::RefCountPtr<
DirectLineSearch_Strategy > 
direct_ls_sqp_ptr_t
typedef Teuchos::RefCountPtr<
MeritFuncNLP > 
merit_func_ptr_t
typedef Teuchos::RefCountPtr<
FeasibilityStep_Strategy
feasibility_step_ptr_t
typedef Teuchos::RefCountPtr<
DirectLineSearch_Strategy > 
direct_ls_newton_ptr_t
enum  ENewtonOutputLevel {
  PRINT_USE_DEFAULT, PRINT_NEWTON_NOTHING = 0, PRINT_NEWTON_SUMMARY_INFO = 1, PRINT_NEWTON_STEPS = 2,
  PRINT_NEWTON_VECTORS = 3
}
  More...
enum  EForcedConstrReduction { CONSTR_LESS_X_D, CONSTR_LESS_X }
  More...

Public Member Functions

void set_direct_ls_sqp (const Teuchos::RefCountPtr< DirectLineSearch_Strategy > &direct_ls_sqp)
 <<std comp="">> members for direct_ls_sqp.
Teuchos::RefCountPtr< DirectLineSearch_Strategy > get_direct_ls_sqp () const
DirectLineSearch_Strategy & direct_ls_sqp ()
const DirectLineSearch_Strategy & direct_ls_sqp () const
void set_merit_func (const Teuchos::RefCountPtr< MeritFuncNLP > &merit_func)
 <<std comp="">> members for merit_func.
Teuchos::RefCountPtr< MeritFuncNLP > get_merit_func () const
MeritFuncNLP & merit_func ()
const MeritFuncNLP & merit_func () const
void set_feasibility_step (const Teuchos::RefCountPtr< FeasibilityStep_Strategy > &feasibility_step)
 <<std comp="">> members for feasibility_step.
Teuchos::RefCountPtr< FeasibilityStep_Strategyget_feasibility_step () const
FeasibilityStep_Strategyfeasibility_step ()
const FeasibilityStep_Strategyfeasibility_step () const
void set_direct_ls_newton (const Teuchos::RefCountPtr< DirectLineSearch_Strategy > &direct_ls_newton)
 <<std comp="">> members for direct_ls_newton.
Teuchos::RefCountPtr< DirectLineSearch_Strategy > get_direct_ls_newton () const
DirectLineSearch_Strategy & direct_ls_newton ()
const DirectLineSearch_Strategy & direct_ls_newton () const
 LineSearch2ndOrderCorrect_Step (const direct_ls_sqp_ptr_t &direct_ls_sqp=NULL, const merit_func_ptr_t &merit_func=NULL, const feasibility_step_ptr_t &feasibility_step=NULL, const direct_ls_newton_ptr_t &direct_ls_newton=0, value_type eta=1.0e-4, ENewtonOutputLevel newton_olevel=PRINT_USE_DEFAULT, value_type constr_norm_threshold=1.0, value_type constr_incr_ratio=10.0, int after_k_iter=0, EForcedConstrReduction forced_constr_reduction=CONSTR_LESS_X, value_type forced_reduct_ratio=1.0, value_type max_step_ratio=1.0, int max_newton_iter=3)
 
bool do_step (Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
 
void print_step (const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
 

Private Attributes

Teuchos::RefCountPtr< DirectLineSearch_Strategy > direct_ls_sqp_
Teuchos::RefCountPtr< MeritFuncNLP > merit_func_
Teuchos::RefCountPtr< FeasibilityStep_Strategyfeasibility_step_
Teuchos::RefCountPtr< DirectLineSearch_Strategy > direct_ls_newton_


Detailed Description

Implements second order correction.

Let the printed documentation describe these parameters.

Definition at line 46 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.


Member Typedef Documentation

typedef Teuchos::RefCountPtr< DirectLineSearch_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_sqp_ptr_t
 

Definition at line 66 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

typedef Teuchos::RefCountPtr< MeritFuncNLP > MoochoPack::LineSearch2ndOrderCorrect_Step::merit_func_ptr_t
 

Definition at line 72 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

typedef Teuchos::RefCountPtr< FeasibilityStep_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::feasibility_step_ptr_t
 

Definition at line 79 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

typedef Teuchos::RefCountPtr< DirectLineSearch_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_newton_ptr_t
 

Definition at line 86 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.


Member Enumeration Documentation

enum MoochoPack::LineSearch2ndOrderCorrect_Step::ENewtonOutputLevel
 

Enumeration values:
PRINT_USE_DEFAULT 
PRINT_NEWTON_NOTHING 
PRINT_NEWTON_SUMMARY_INFO 
PRINT_NEWTON_STEPS 
PRINT_NEWTON_VECTORS 

Definition at line 50 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

enum MoochoPack::LineSearch2ndOrderCorrect_Step::EForcedConstrReduction
 

Enumeration values:
CONSTR_LESS_X_D 
CONSTR_LESS_X 

Definition at line 59 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.


Constructor & Destructor Documentation

MoochoPack::LineSearch2ndOrderCorrect_Step::LineSearch2ndOrderCorrect_Step const direct_ls_sqp_ptr_t direct_ls_sqp = NULL,
const merit_func_ptr_t merit_func = NULL,
const feasibility_step_ptr_t feasibility_step = NULL,
const direct_ls_newton_ptr_t direct_ls_newton = 0,
value_type  eta = 1.0e-4,
ENewtonOutputLevel  newton_olevel = PRINT_USE_DEFAULT,
value_type  constr_norm_threshold = 1.0,
value_type  constr_incr_ratio = 10.0,
int  after_k_iter = 0,
EForcedConstrReduction  forced_constr_reduction = CONSTR_LESS_X,
value_type  forced_reduct_ratio = 1.0,
value_type  max_step_ratio = 1.0,
int  max_newton_iter = 3
 

Definition at line 55 of file MoochoPack_LineSearch2ndOrderCorrect_Step.cpp.


Member Function Documentation

void MoochoPack::LineSearch2ndOrderCorrect_Step::set_direct_ls_sqp const Teuchos::RefCountPtr< DirectLineSearch_Strategy > &  direct_ls_sqp  )  [inline]
 

<<std comp="">> members for direct_ls_sqp.

This is the line search strategy object for the SQP step for x_k+1 = x_k + alpha_k * d_k + alpha_k^2 * w.

Definition at line 66 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

Teuchos::RefCountPtr< DirectLineSearch_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::get_direct_ls_sqp  )  const [inline]
 

Definition at line 66 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

DirectLineSearch_Strategy& MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_sqp  )  [inline]
 

Definition at line 66 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const DirectLineSearch_Strategy& MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_sqp  )  const [inline]
 

Definition at line 66 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::set_merit_func const Teuchos::RefCountPtr< MeritFuncNLP > &  merit_func  )  [inline]
 

<<std comp="">> members for merit_func.

This is the merit function object for SQP step line search.

Definition at line 72 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

Teuchos::RefCountPtr< MeritFuncNLP > MoochoPack::LineSearch2ndOrderCorrect_Step::get_merit_func  )  const [inline]
 

Definition at line 72 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

MeritFuncNLP& MoochoPack::LineSearch2ndOrderCorrect_Step::merit_func  )  [inline]
 

Definition at line 72 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const MeritFuncNLP& MoochoPack::LineSearch2ndOrderCorrect_Step::merit_func  )  const [inline]
 

Definition at line 72 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::set_feasibility_step const Teuchos::RefCountPtr< FeasibilityStep_Strategy > &  feasibility_step  )  [inline]
 

<<std comp="">> members for feasibility_step.

This is the strategy object that is used to compute feasibility steps for the newton iterations.

Definition at line 79 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

Teuchos::RefCountPtr< FeasibilityStep_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::get_feasibility_step  )  const [inline]
 

Definition at line 79 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

FeasibilityStep_Strategy& MoochoPack::LineSearch2ndOrderCorrect_Step::feasibility_step  )  [inline]
 

Definition at line 79 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const FeasibilityStep_Strategy& MoochoPack::LineSearch2ndOrderCorrect_Step::feasibility_step  )  const [inline]
 

Definition at line 79 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::set_direct_ls_newton const Teuchos::RefCountPtr< DirectLineSearch_Strategy > &  direct_ls_newton  )  [inline]
 

<<std comp="">> members for direct_ls_newton.

This is the line search strategy object for the internal newton iterations for determining the second order correction w.

Definition at line 86 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

Teuchos::RefCountPtr< DirectLineSearch_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::get_direct_ls_newton  )  const [inline]
 

Definition at line 86 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

DirectLineSearch_Strategy& MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_newton  )  [inline]
 

Definition at line 86 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const DirectLineSearch_Strategy& MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_newton  )  const [inline]
 

Definition at line 86 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::eta const value_type eta  )  [inline]
 

the Armijo cord fractional reduction test parameter eta

Definition at line 111 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const value_type& MoochoPack::LineSearch2ndOrderCorrect_Step::eta  )  const [inline]
 

Definition at line 111 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::newton_olevel const ENewtonOutputLevel newton_olevel  )  [inline]
 

Optput level for newton iterations.

Definition at line 114 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const ENewtonOutputLevel& MoochoPack::LineSearch2ndOrderCorrect_Step::newton_olevel  )  const [inline]
 

Definition at line 114 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::constr_norm_threshold const value_type constr_norm_threshold  )  [inline]
 

constr_norm_threshold.

Definition at line 117 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const value_type& MoochoPack::LineSearch2ndOrderCorrect_Step::constr_norm_threshold  )  const [inline]
 

Definition at line 117 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::constr_incr_ratio const value_type constr_incr_ratio  )  [inline]
 

constr_incr_ratio

Definition at line 120 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const value_type& MoochoPack::LineSearch2ndOrderCorrect_Step::constr_incr_ratio  )  const [inline]
 

Definition at line 120 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::after_k_iter const int &  after_k_iter  )  [inline]
 

after_k_iter.

Definition at line 123 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const int& MoochoPack::LineSearch2ndOrderCorrect_Step::after_k_iter  )  const [inline]
 

Definition at line 123 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::forced_constr_reduction const EForcedConstrReduction forced_constr_reduction  )  [inline]
 

forced_constr_reduction.

Definition at line 126 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const EForcedConstrReduction& MoochoPack::LineSearch2ndOrderCorrect_Step::forced_constr_reduction  )  const [inline]
 

Definition at line 126 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::forced_reduct_ratio const value_type forced_reduct_ratio  )  [inline]
 

forced_reduct_ratio

Definition at line 129 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const value_type& MoochoPack::LineSearch2ndOrderCorrect_Step::forced_reduct_ratio  )  const [inline]
 

Definition at line 129 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::max_step_ratio const value_type max_step_ratio  )  [inline]
 

max_step_ratio.

Definition at line 132 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const value_type& MoochoPack::LineSearch2ndOrderCorrect_Step::max_step_ratio  )  const [inline]
 

Definition at line 132 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::max_newton_iter const int &  max_newton_iter  )  [inline]
 

max_netwon_iter.

Definition at line 135 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

const int& MoochoPack::LineSearch2ndOrderCorrect_Step::max_newton_iter  )  const [inline]
 

Definition at line 135 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

bool MoochoPack::LineSearch2ndOrderCorrect_Step::do_step Algorithm algo,
poss_type  step_poss,
IterationPack::EDoStepType  type,
poss_type  assoc_step_poss
 

Definition at line 85 of file MoochoPack_LineSearch2ndOrderCorrect_Step.cpp.

void MoochoPack::LineSearch2ndOrderCorrect_Step::print_step const Algorithm algo,
poss_type  step_poss,
IterationPack::EDoStepType  type,
poss_type  assoc_step_poss,
std::ostream &  out,
const std::string &  leading_str
const
 

Definition at line 680 of file MoochoPack_LineSearch2ndOrderCorrect_Step.cpp.


Member Data Documentation

Teuchos::RefCountPtr< DirectLineSearch_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_sqp_ [private]
 

Definition at line 66 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

Teuchos::RefCountPtr< MeritFuncNLP > MoochoPack::LineSearch2ndOrderCorrect_Step::merit_func_ [private]
 

Definition at line 72 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

Teuchos::RefCountPtr< FeasibilityStep_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::feasibility_step_ [private]
 

Definition at line 79 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

Teuchos::RefCountPtr< DirectLineSearch_Strategy > MoochoPack::LineSearch2ndOrderCorrect_Step::direct_ls_newton_ [private]
 

Definition at line 86 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

value_type MoochoPack::LineSearch2ndOrderCorrect_Step::eta_ [private]
 

Definition at line 111 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

ENewtonOutputLevel MoochoPack::LineSearch2ndOrderCorrect_Step::newton_olevel_ [private]
 

Definition at line 114 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

value_type MoochoPack::LineSearch2ndOrderCorrect_Step::constr_norm_threshold_ [private]
 

Definition at line 117 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

value_type MoochoPack::LineSearch2ndOrderCorrect_Step::constr_incr_ratio_ [private]
 

Definition at line 120 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

int MoochoPack::LineSearch2ndOrderCorrect_Step::after_k_iter_ [private]
 

Definition at line 123 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

EForcedConstrReduction MoochoPack::LineSearch2ndOrderCorrect_Step::forced_constr_reduction_ [private]
 

Definition at line 126 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

value_type MoochoPack::LineSearch2ndOrderCorrect_Step::forced_reduct_ratio_ [private]
 

Definition at line 129 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

value_type MoochoPack::LineSearch2ndOrderCorrect_Step::max_step_ratio_ [private]
 

Definition at line 132 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.

int MoochoPack::LineSearch2ndOrderCorrect_Step::max_newton_iter_ [private]
 

Definition at line 135 of file MoochoPack_LineSearch2ndOrderCorrect_Step.hpp.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:36:20 2008 for MOOCHO (Single Doxygen Collection) by doxygen 1.3.9.1