NLPInterfacePack_CalcFiniteDiffProd.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 CALC_FINITE_DIFF_FIRST_DERIVATIVE_PRODUCT_H
#define CALC_FINITE_DIFF_FIRST_DERIVATIVE_PRODUCT_H

#include "NLPInterfacePack_Types.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace NLPInterfacePack {

class CalcFiniteDiffProd {
public:

  enum EFDMethodOrder {
    FD_ORDER_ONE           
    ,FD_ORDER_TWO          
    ,FD_ORDER_TWO_CENTRAL  
    ,FD_ORDER_TWO_AUTO     
    ,FD_ORDER_FOUR         
    ,FD_ORDER_FOUR_CENTRAL 
    ,FD_ORDER_FOUR_AUTO    
  };
  enum EFDStepSelect {
    FD_STEP_ABSOLUTE      
    ,FD_STEP_RELATIVE     
  };
  STANDARD_MEMBER_COMPOSITION_MEMBERS( EFDMethodOrder, fd_method_order );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( EFDStepSelect, fd_step_select );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, fd_step_size );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, fd_step_size_min );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, fd_step_size_f );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, fd_step_size_c );

  CalcFiniteDiffProd(
    EFDMethodOrder              fd_method_order  = FD_ORDER_FOUR_AUTO
    ,EFDStepSelect              fd_step_select   = FD_STEP_ABSOLUTE
    ,value_type                 fd_step_size     = -1.0
    ,value_type                 fd_step_size_min = -1.0
    ,value_type                 fd_step_size_f   = -1.0
    ,value_type                 fd_step_size_c   = -1.0
    );

  virtual ~CalcFiniteDiffProd() {}

  virtual bool calc_deriv_product(
    const Vector       &xo
    ,const Vector      *xl
    ,const Vector      *xu
    ,const Vector      &v
    ,const value_type  *fo
    ,const Vector      *co
    ,bool              check_nan_inf
    ,NLP               *nlp
    ,value_type        *Gf_prod
    ,VectorMutable     *Gc_prod
    ,std::ostream      *out
    ,bool              trace    = false
    ,bool              dump_all = false
    ) const;

};  // end class CalcFiniteDiffProd

} // end namespace NLPInterfacePack

#endif  // CALC_FINITE_DIFF_FIRST_DERIVATIVE_PRODUCT_H