MoochoPack_ReducedHessianSerialization_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 REDUCED_HESSIAN_SERIALIZATION_STEP_HPP
#define REDUCED_HESSIAN_SERIALIZATION_STEP_HPP

#include "MoochoPack_ReducedHessianSecantUpdate_Strategy.hpp"
#include "MoochoPack_quasi_newton_stats.hpp"
#include "IterationPack_AlgorithmStep.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace MoochoPack {

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

  STANDARD_MEMBER_COMPOSITION_MEMBERS( std::string, reduced_hessian_input_file_name );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( std::string, reduced_hessian_output_file_name );

  ReducedHessianSerialization_Step(
    const std::string    &reduced_hessian_input_file_name   = "reduced_hessian.in"
    ,const std::string   &reduced_hessian_output_file_name  = "reduced_hessian.out"
    );
  
  bool do_step(
    Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
    ,poss_type assoc_step_poss
    );
  void finalize_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;
  
};  // end class ReducedHessianSerialization_Step

} // end namespace MoochoPack 

#endif  // REDUCED_HESSIAN_SERIALIZATION_STEP_HPP