MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_VectorSpaceSubSpace.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 VECTOR_SPACE_SUB_SPACE_H
00043 #define VECTOR_SPACE_SUB_SPACE_H
00044 
00045 #include "AbstractLinAlgPack_VectorSpace.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00060 class VectorSpaceSubSpace : public virtual VectorSpace {
00061 public:
00062 
00067   VectorSpaceSubSpace();
00068 
00071   VectorSpaceSubSpace( const space_ptr_t& full_space, const Range1D& rng );
00072 
00090   void initialize( const space_ptr_t& full_space, const Range1D& rng );
00091 
00099   void set_uninitialized();
00100 
00102   const space_ptr_t& full_space() const;
00103 
00105   const Range1D& rng() const;
00106 
00108   void validate_range( const Range1D& rng ) const;
00109 
00112 
00114   bool is_compatible(const VectorSpace& ) const;
00116   bool is_in_core() const;
00118   index_type dim() const;
00120   vec_mut_ptr_t create_member() const;
00122   space_ptr_t clone() const;
00124   space_ptr_t sub_space(const Range1D& rng) const;
00125 
00127 
00128 private:
00129 
00130   space_ptr_t     full_space_;   
00131   Range1D         rng_;          
00132 
00133 }; // end class VectorSpaceSubSpace
00134 
00135 // //////////////////////////////
00136 // Inline members
00137 
00138 inline
00139 VectorSpaceSubSpace::VectorSpaceSubSpace()
00140   : rng_(Range1D::Invalid)
00141 {}
00142 
00143 inline
00144 const VectorSpace::space_ptr_t& VectorSpaceSubSpace::full_space() const
00145 {
00146   return full_space_;
00147 }
00148 
00149 inline
00150 const Range1D& VectorSpaceSubSpace::rng() const
00151 {
00152   return rng_;
00153 }
00154 
00155 #ifndef TEUCHOS_DEBUG
00156 inline
00157 void VectorSpaceSubSpace::validate_range(const Range1D&) const
00158 {}
00159 #endif
00160 
00161 } // end namespace AbstractLinAlgPack
00162 
00163 #endif // VECTOR_SPACE_SUB_SPACE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines