MoochoPack_UpdateBarrierParameter_Step.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 UPDATE_BARRIER_PARAMETER_STEP_H
#define UPDATE_BARRIER_PARAMETER_STEP_H

#include "MoochoPack_Types.hpp"
#include "IterationPack_AlgorithmStep.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

#include "OptionsFromStreamPack_SetOptionsFromStreamNode.hpp"
#include "OptionsFromStreamPack_SetOptionsToTargetBase.hpp"

namespace MoochoPack {

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


    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, init_barrier_parameter );

    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, tau_mu );

    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, theta_mu );

    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, tau_epsilon );

    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, theta_epsilon );

    STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, e_tol_max );

    UpdateBarrierParameter_Step(
      const value_type init_barrier_parameter = 0.1,
      const value_type tau_mu = 0.2,
      const value_type theta_mu = 1.5,
      const value_type tau_epsilon = 10,
      const value_type theta_epsilon = 1.1,
      const value_type e_tol_max = 1000
      );

    bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
           , poss_type assoc_step_poss);
    
    
    void print_step( const IterationPack::Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
             , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;

  private:
    value_type Calculate_e_tol(value_type mu);

  }; // end class UpdateBarrierParameter_Step


class UpdateBarrierParameter_StepSetOptions
  : public OptionsFromStreamPack::SetOptionsFromStreamNode,
    public OptionsFromStreamPack::SetOptionsToTargetBase< UpdateBarrierParameter_Step >
  {
  public:
    UpdateBarrierParameter_StepSetOptions(
      UpdateBarrierParameter_Step* target = 0,
      const char opt_grp_name[] = "UpdateBarrierParameter" );

  protected:

    void setOption( int option_num, const std::string& option_value );
  
  };  // end class UpdateBarrierParameter_StepSetOptions

} // end namespace MoochoPack

#endif // #if !defined UPDATE_BARRIER_PARAMETER_STEP_H