IterationPack: General framework for building iterative algorithms Version of the Day
IterationPack_Types.hpp
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 GENERAL_ITERATION_PACK_TYPES_H
00043 #define GENERAL_ITERATION_PACK_TYPES_H
00044 
00045 #include "Teuchos_TypeNameTraits.hpp"
00046 
00047 namespace MemMngPack {}
00048 
00049 namespace IterationPack {
00050 
00051 using Teuchos::typeName;
00052 using Teuchos::TypeNameTraits;
00053 
00055 enum EAssocStepType {
00056   PRE_STEP   = 0
00057   ,POST_STEP = 1
00058 };
00060 enum EDoStepType {
00061   DO_MAIN_STEP  = 0
00062   ,DO_PRE_STEP  = 1
00063   ,DO_POST_STEP = 2
00064 };
00066 enum EAlgoReturn {
00067   TERMINATE_TRUE
00068   ,TERMINATE_FALSE
00069   ,MAX_ITER_EXCEEDED
00070   ,MAX_RUN_TIME_EXCEEDED
00071   ,INTERRUPTED_TERMINATE_TRUE
00072   ,INTERRUPTED_TERMINATE_FALSE
00073 };
00075 class InvalidTypeCastException : public std::logic_error
00076 {public: InvalidTypeCastException(const std::string& what_arg) : std::logic_error(what_arg) {}};
00077 
00078 class IterQuantity;
00079 template<class T> class IterQuantityAccess;
00080 template<class T> class IterQuantityAccessContiguous;
00081 template<class T_Base, class T_Derived> class IterQuantityAccessDerivedToBase;
00082 class Algorithm;
00083 class AlgorithmStep;
00084 class AlgorithmState;
00085 class AlgorithmTracker;
00086 class AlgorithmTrackerComposite;
00087 template<class T> class CastIQMember;
00088 
00089 } // end namespace IterationPack
00090 
00091 #endif  // GENERAL_ITERATION_PACK_TYPES_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends