MoochoPack_BFGSUpdate_Strategy.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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef BFGS_UPDATE_STRATEGY_H
#define BFGS_UPDATE_STRATEGY_H

#include "MoochoPack_Types.hpp"
#include "MoochoPack_QuasiNewtonStats.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace MoochoPack {

class BFGSUpdate_Strategy {
public:

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, rescale_init_identity );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, use_dampening );

  enum ESecantTesting { SECANT_TEST_DEFAULT, SECANT_TEST_ALWAYS, SECANT_NO_TEST };

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ESecantTesting, secant_testing );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, secant_warning_tol );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, secant_error_tol );

  BFGSUpdate_Strategy(
    bool               rescale_init_identity  = true
    ,bool              use_dampening          = true
    ,ESecantTesting    secant_testing         = SECANT_TEST_DEFAULT
    ,value_type        secant_warning_tol     = 1e-6
    ,value_type        secant_error_tol       = 1e-1
    );

  void perform_update(
    VectorMutable      *s_bfgs
    ,VectorMutable     *y_bfgs
    ,bool                    first_update
    ,std::ostream            &out
    ,EJournalOutputLevel     olevel
    ,bool                    check_results
    ,MatrixSymOp         *B
    ,QuasiNewtonStats        * quasi_newton_stats 
    );
  
  void print_step( std::ostream& out, const std::string& leading_str ) const;

}; // end class BFGSUpdate_Strategy

}  // end namespace MoochoPack

#endif // BFGS_UPDATE_STRATEGY_H