MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_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 REDUCED_SPACE_SQP_PACK_TYPES_H
00043 #define REDUCED_SPACE_SQP_PACK_TYPES_H
00044 
00045 #include "ConstrainedOptPack_Types.hpp"
00046 #include "IterationPack_Types.hpp"
00047 #include "Teuchos_RCP.hpp"
00048 #include "Teuchos_VerbosityLevel.hpp"
00049 
00050 namespace MoochoPack {
00051 
00052 using Teuchos::RCP;
00053 
00054 // using types from ConstrainedOptPack
00055 #include "ConstrainedOptPack_PublicTypes.ud"
00056 
00057 // using types from IterationPack
00058 #include "IterationPack_PublicTypes.ud"
00059 
00061 enum EJournalOutputLevel {
00062   PRINT_NOTHING = 0
00063   ,PRINT_BASIC_ALGORITHM_INFO = 1
00064   ,PRINT_ALGORITHM_STEPS = 2
00065   ,PRINT_ACTIVE_SET = 3
00066   ,PRINT_VECTORS = 4
00067   ,PRINT_ITERATION_QUANTITIES = 5
00068 };
00069 
00071 inline Teuchos::EVerbosityLevel convertToVerbLevel( const EJournalOutputLevel output_level )
00072 {
00073   switch(output_level) {
00074     case PRINT_NOTHING:
00075     case PRINT_BASIC_ALGORITHM_INFO:
00076       return Teuchos::VERB_NONE;
00077     case PRINT_ACTIVE_SET:
00078     case PRINT_ALGORITHM_STEPS:
00079       return Teuchos::VERB_LOW;
00080     case PRINT_VECTORS:
00081       return Teuchos::VERB_HIGH;
00082     case PRINT_ITERATION_QUANTITIES:
00083       return Teuchos::VERB_EXTREME;
00084     default:
00085       TEUCHOS_TEST_FOR_EXCEPT(true); // Should never get here!
00086   }
00087   return Teuchos::VERB_NONE; // Should never be called!
00088 }
00089 
00090 // public interface classes
00091 
00092 class NLPAlgoState;
00093 class NLPSolverClientInterface;
00094 class NLPAlgoClientInterface;
00095 class NLPAlgoConfig;
00096 
00097 //
00098 
00099 class NLPAlgo;
00100 
00101 } // end namespace MoochoPack 
00102 
00103 #endif // REDUCED_SPACE_SQP_PACK_TYPES_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends