MoochoPack_MeritFunc_PenaltyParamUpdate_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_PENALTY_PARAM_UPDATE_ADDED_STEP_H
#define MERIT_FUNC_PENALTY_PARAM_UPDATE_ADDED_STEP_H

#include "MoochoPack_Types.hpp"
#include "IterationPack_AlgorithmStep.hpp"

namespace MoochoPack {

class MeritFunc_PenaltyParamUpdate_AddedStep
  : public IterationPack::AlgorithmStep // doxygen needs full path
{
public:


  virtual void small_mu( value_type small_mu ) = 0;
  virtual value_type small_mu() const = 0;
  virtual void min_mu_ratio( value_type min_mu_ratio )
  {}
  virtual value_type min_mu_ratio() const
  { return 1.0; };
  virtual void mult_factor( value_type mult_factor ) = 0;
  virtual value_type mult_factor() const = 0;
  virtual void kkt_near_sol( value_type kkt_near_sol ) = 0;
  virtual value_type kkt_near_sol() const = 0;


};  // end class MeritFunc_PenaltyParamUpdate_AddedStep

} // end namespace MoochoPack 

#endif  // MERIT_FUNC_PENALTY_PARAM_UPDATE_ADDED_STEP_H