ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization Version of the Day
ConstrainedOptPack_DecompositionSystem.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 DECOMPOSITION_SYSTEM_H
00043 #define DECOMPOSITION_SYSTEM_H
00044 
00045 #include <stdexcept>
00046 
00047 #include "ConstrainedOptPack_Types.hpp"
00048 #include "AbstractLinAlgPack_VectorSpace.hpp"
00049 
00050 namespace ConstrainedOptPack {
00051 
00089 class DecompositionSystem {
00090 public:
00091 
00094 
00096   typedef Teuchos::RCP<
00097     const Teuchos::AbstractFactory<MatrixOpNonsing> >    mat_nonsing_fcty_ptr_t;
00099   typedef Teuchos::RCP<
00100     const Teuchos::AbstractFactory<MatrixOp> >               mat_fcty_ptr_t;
00102   class SingularDecomposition : public std::logic_error
00103   {public: SingularDecomposition(const std::string& what_arg) : std::logic_error(what_arg) {}};
00105   class InvalidMatrixType : public std::logic_error
00106   {public: InvalidMatrixType(const std::string& what_arg) : std::logic_error(what_arg) {}};
00108   class TestFailed : public std::runtime_error
00109   {public: TestFailed(const std::string& what_arg) : std::runtime_error(what_arg) {}};
00111   enum EOutputLevel {
00112     PRINT_NONE          = 0,
00113     PRINT_BASIC_INFO    = 1,
00114     PRINT_MORE_INFO     = 2,
00115     PRINT_VECTORS       = 3,
00116     PRINT_EVERY_THING   = 4
00117     };
00119   enum ERunTests { RUN_TESTS, NO_TESTS };
00121   enum EMatRelations { MATRICES_INDEP_IMPS, MATRICES_ALLOW_DEP_IMPS };
00122 
00124 
00126   virtual ~DecompositionSystem() {}
00127 
00130 
00140   virtual size_type n() const;
00141 
00148   virtual size_type m() const = 0;
00149 
00159   virtual size_type r() const;
00160 
00165   virtual Range1D equ_decomp() const;
00166 
00172   virtual Range1D equ_undecomp() const;
00173 
00175 
00178 
00186   virtual const VectorSpace::space_ptr_t space_range() const = 0;
00187 
00195   virtual const VectorSpace::space_ptr_t space_null() const = 0;
00196 
00198 
00201 
00204   virtual const mat_fcty_ptr_t factory_Z() const = 0;
00205 
00208   virtual const mat_fcty_ptr_t factory_Y() const = 0;
00209 
00212   virtual const mat_nonsing_fcty_ptr_t factory_R() const = 0;
00213   
00216   virtual const mat_fcty_ptr_t factory_Uz() const = 0;
00217 
00220   virtual const mat_fcty_ptr_t factory_Uy() const = 0;
00221 
00223 
00226 
00351   virtual void update_decomp(
00352     std::ostream          *out
00353     ,EOutputLevel         olevel
00354     ,ERunTests            test_what
00355     ,const MatrixOp       &Gc
00356     ,MatrixOp             *Z
00357     ,MatrixOp             *Y
00358     ,MatrixOpNonsing      *R
00359     ,MatrixOp             *Uz
00360     ,MatrixOp             *Vy
00361     ,EMatRelations        mat_rel = MATRICES_INDEP_IMPS
00362     ) const = 0;
00363   
00367   virtual void print_update_decomp(
00368     std::ostream& out, const std::string& leading_str ) const = 0;
00369 
00371   
00372 };  // end class DecompositionSystem
00373 
00374 } // end namespace ConstrainedOptPack
00375 
00376 #endif // DECOMPOSITION_SYSTEM_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends