MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_EvalNewPointTailoredApproach_Step.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 EVAL_NEW_POINT_TAILORED_APPROACH_STEP_H
00043 #define EVAL_NEW_POINT_TAILORED_APPROACH_STEP_H
00044 
00045 #include "MoochoPack_Types.hpp"
00046 #include "IterationPack_AlgorithmStep.hpp"
00047 #include "ConstrainedOptPack_VariableBoundsTester.hpp"
00048 #include "NLPInterfacePack_NLPDirectTester.hpp"
00049 #include "Teuchos_StandardCompositionMacros.hpp"
00050 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00051 
00052 namespace MoochoPack {
00053 
00060 class EvalNewPointTailoredApproach_Step
00061   : public IterationPack::AlgorithmStep // doxygen needs full path
00062 {
00063 public:
00064 
00068   enum EFDDerivTesting { FD_DEFAULT, FD_TEST, FD_NO_TEST };
00070 
00073 
00075   typedef Teuchos::RCP<const MatrixOp> D_ptr_t;
00077   STANDARD_COMPOSITION_MEMBERS( NLPDirectTester, deriv_tester );
00079   STANDARD_COMPOSITION_MEMBERS( VariableBoundsTester, bounds_tester );
00084   STANDARD_MEMBER_COMPOSITION_MEMBERS( EFDDerivTesting, fd_deriv_testing );
00085 
00087   EvalNewPointTailoredApproach_Step(
00088       const deriv_tester_ptr_t&   deriv_tester
00089     , const bounds_tester_ptr_t&  bounds_tester
00090     , EFDDerivTesting       fd_deriv_testing = FD_DEFAULT
00091     );
00092 
00094 
00098   bool do_step(Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00099     , poss_type assoc_step_poss);
00101   void print_step( const Algorithm& algo, poss_type step_poss, IterationPack::EDoStepType type
00102     , poss_type assoc_step_poss, std::ostream& out, const std::string& leading_str ) const;
00104 
00107 
00112   virtual void uninitialize_Y_Uy(
00113     MatrixOp         *Y
00114     ,MatrixOp        *Uy
00115     ) = 0;
00116 
00130   virtual void calc_py_Y_Uy(
00131     const NLPDirect       &nlp
00132     ,const D_ptr_t        &D
00133     ,VectorMutable        *py
00134     ,MatrixOp             *Y
00135     ,MatrixOp             *Uy
00136     ,EJournalOutputLevel  olevel
00137     ,std::ostream         &out
00138     ) = 0;
00139 
00146   virtual void recalc_py(
00147     const MatrixOp          &D
00148     ,VectorMutable          *py
00149     ,EJournalOutputLevel    olevel
00150     ,std::ostream           &out
00151     ) = 0;
00152   
00155   virtual void print_calc_py_Y_Uy(
00156     std::ostream& out, const std::string& leading_str
00157     ) const = 0;
00158 
00160 
00161 private:
00162 
00163   // Not defined and not to be called
00164   EvalNewPointTailoredApproach_Step();
00165 
00166 };  // end class EvalNewPointTailoredApproach_Step
00167 
00168 } // end namespace MoochoPack 
00169 
00170 #endif  // EVAL_NEW_POINT_TAILORED_APPROACH_STEP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines