MOOCHO (Single Doxygen Collection) Version of the Day
NLPInterfacePack_NLPDirectTester.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef NLP_FIRST_ORDER_DIRECT_TESTER_H
00043 #define NLP_FIRST_ORDER_DIRECT_TESTER_H
00044 
00045 #include <iosfwd>
00046 
00047 #include "NLPInterfacePack_Types.hpp"
00048 #include "NLPInterfacePack_CalcFiniteDiffProd.hpp"
00049 #include "Teuchos_StandardCompositionMacros.hpp"
00050 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00051 
00052 namespace NLPInterfacePack {
00053 
00167 class NLPDirectTester {
00168 public:
00169 
00171   enum ETestingMethod {
00172     FD_COMPUTE_ALL
00173     ,FD_DIRECTIONAL
00174   };
00175 
00177   STANDARD_COMPOSITION_MEMBERS( CalcFiniteDiffProd, calc_fd_prod );
00179   STANDARD_MEMBER_COMPOSITION_MEMBERS( ETestingMethod, Gf_testing_method );
00181   STANDARD_MEMBER_COMPOSITION_MEMBERS( ETestingMethod, Gc_testing_method );
00183   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, Gf_warning_tol );
00185   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, Gf_error_tol );
00187   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, Gc_warning_tol );
00189   STANDARD_MEMBER_COMPOSITION_MEMBERS( value_type, Gc_error_tol );
00191   STANDARD_MEMBER_COMPOSITION_MEMBERS( size_type, num_fd_directions );
00193   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dump_all );
00194 
00196   NLPDirectTester(
00197     const calc_fd_prod_ptr_t  &calc_fd_prod       = Teuchos::null
00198     ,ETestingMethod           Gf_testing_method   = FD_DIRECTIONAL
00199     ,ETestingMethod           Gc_testing_method   = FD_DIRECTIONAL
00200     ,value_type               Gf_warning_tol      = 1e-6
00201     ,value_type               Gf_error_tol        = 1e-1
00202     ,value_type               Gc_warning_tol      = 1e-6
00203     ,value_type               Gc_error_tol        = 1e-1
00204     ,size_type                num_fd_directions   = 1
00205     ,bool                     dump_all            = false
00206     );
00207 
00258   bool finite_diff_check(
00259     NLPDirect         *nlp
00260     ,const Vector     &xo
00261     ,const Vector     *xl
00262     ,const Vector     *xu
00263     ,const Vector     *c
00264     ,const Vector     *Gf
00265     ,const Vector     *py
00266     ,const Vector     *rGf
00267     ,const MatrixOp   *GcU
00268     ,const MatrixOp   *D
00269     ,const MatrixOp   *Uz
00270     ,bool             print_all_warnings
00271     ,std::ostream     *out
00272     ) const;
00273 
00274 };  // end class NLPDirectTester
00275 
00276 } // end namespace NLPInterfacePack
00277 
00278 #endif  // NLP_FIRST_ORDER_DIRECT_TESTER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines