MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep Class Reference

Updates a set of penalty parameters for a merit function as: mu(j) = max( mu(j), |lambda_k(j)| ). More...

#include <MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.hpp>

Inheritance diagram for MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep:

[legend]List of all members.

Public Member Functions
void	set_merit_func (const Teuchos::RefCountPtr< MeritFuncNLP > &merit_func)
	<<std comp="">> members for merit_func
	MeritFunc_PenaltyParamsUpdateWithMult_AddedStep (const merit_func_ptr_t &merit_func, value_type small_mu=1e-6, value_type min_mu_ratio=1e-8, value_type mult_factor=1e-4, value_type kkt_near_sol=1e-1)
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
void	small_mu (value_type small_mu)
value_type	small_mu () const
void	min_mu_ratio (value_type min_mu_ratio)
value_type	min_mu_ratio () const
void	mult_factor (value_type mult_factor)
value_type	mult_factor () const
void	kkt_near_sol (value_type kkt_near_sol)
value_type	kkt_near_sol () const

---

Detailed Description

Updates a set of penalty parameters for a merit function as: mu(j) = max( mu(j), |lambda_k(j)| ).

This class assumes the merit function supports the interfaces MeritFuncPenaltyParams and MeritFuncNLPDirecDeriv.

Definition at line 44 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.hpp.

---

Constructor & Destructor Documentation

MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep (  const merit_func_ptr_t &  merit_func, value_type  small_mu = 1e-6, value_type  min_mu_ratio = 1e-8, value_type  mult_factor = 1e-4, value_type  kkt_near_sol = 1e-1 )

Definition at line 52 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

---

Member Function Documentation

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

<<std comp="">> members for merit_func Definition at line 50 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.hpp.

bool MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::do_step (  Algorithm &  algo, poss_type  step_poss, IterationPack::EDoStepType  type, poss_type  assoc_step_poss )

Definition at line 60 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

void MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::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 212 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

void MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::small_mu (  value_type  small_mu  )  [virtual]

Implements MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 265 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

value_type MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::small_mu (   )  const [virtual]

Implements MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 270 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

void MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::min_mu_ratio (  value_type  min_mu_ratio  )  [virtual]

Reimplemented from MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 275 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

value_type MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::min_mu_ratio (   )  const [virtual]

Reimplemented from MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 280 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

void MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::mult_factor (  value_type  mult_factor  )  [virtual]

Implements MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 285 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

value_type MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::mult_factor (   )  const [virtual]

Implements MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 290 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

void MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::kkt_near_sol (  value_type  kkt_near_sol  )  [virtual]

Implements MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 295 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

value_type MoochoPack::MeritFunc_PenaltyParamsUpdateWithMult_AddedStep::kkt_near_sol (   )  const [virtual]

Implements MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStep. Definition at line 300 of file MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp.

---

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

• MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.hpp
• MoochoPack_MeritFunc_PenaltyParamsUpdateWithMult_AddedStep.cpp

---