MoochoPack_MeritFunc_ModifiedL1LargerSteps_AddedStep.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef MERIT_FUNC_MODIFIED_L1_LARGER_STEPS_ADDED_STEP_H
#define MERIT_FUNC_MODIFIED_L1_LARGER_STEPS_ADDED_STEP_H

#include "rSQPAlgo_Step.h"
#include "ConstrainedOptPack_MeritFuncNLP.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace MoochoPack {

class MeritFunc_ModifiedL1LargerSteps_AddedStep
  : public rSQPAlgo_Step
{
public:

  STANDARD_COMPOSITION_MEMBERS(MeritFuncNLP,merit_func);

  MeritFunc_ModifiedL1LargerSteps_AddedStep(
      const merit_func_ptr_t& merit_func
    , value_type  eta
    , int     after_k_iter        = 3
    , value_type  obj_increase_threshold    = 1e-4
    , value_type  max_pos_penalty_increase  = 1.0
    , value_type  pos_to_neg_penalty_increase = 1.0
    , value_type  incr_mult_factor      = 1e-4 );

  STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type,eta);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(int,after_k_iter);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type,obj_increase_threshold);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type,max_pos_penalty_increase);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type,pos_to_neg_penalty_increase);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(value_type,incr_mult_factor);

  // ///////////////////////////////
  // Overridden from AlgorithmStep

  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:
  // not defined and not to be called.
  MeritFunc_ModifiedL1LargerSteps_AddedStep();
  MeritFunc_ModifiedL1LargerSteps_AddedStep(const MeritFunc_ModifiedL1LargerSteps_AddedStep&);
  MeritFunc_ModifiedL1LargerSteps_AddedStep& operator=(const MeritFunc_ModifiedL1LargerSteps_AddedStep&);
  
};  // end class MeritFunc_ModifiedL1LargerSteps_AddedStep

} // end namespace MoochoPack 

#endif  // MERIT_FUNC_MODIFIED_L1_LARGER_STEPS_ADDED_STEP_H