MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_VectorSpace.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 ALAP_VECTOR_SPACE_HPP
00043 #define ALAP_VECTOR_SPACE_HPP
00044 
00045 #include "AbstractLinAlgPack_InnerProduct.hpp"
00046 #include "Teuchos_AbstractFactory.hpp"
00047 
00048 namespace AbstractLinAlgPack {
00049 
00133 class VectorSpace
00134   : public Teuchos::AbstractFactory<VectorMutable>
00135 {
00136 public:
00137 
00139   class IncompatibleVectorSpaces : public std::logic_error
00140   {public: IncompatibleVectorSpaces(const std::string& what_arg) : std::logic_error(what_arg) {}};
00142   typedef Teuchos::RCP<const InnerProduct>          inner_prod_ptr_t;
00144   typedef Teuchos::RCP<const VectorSpace>           space_ptr_t;
00146   typedef Teuchos::RCP<const VectorSpaceFactory>    space_fcty_ptr_t;
00148   typedef Teuchos::RCP<VectorMutable>               vec_mut_ptr_t;
00150   typedef Teuchos::RCP<MultiVectorMutable>          multi_vec_mut_ptr_t;
00151 
00152 
00155 
00157   VectorSpace( const inner_prod_ptr_t& inner_prod = Teuchos::null );
00158 
00170   virtual void inner_prod( const inner_prod_ptr_t& inner_prod );
00171 
00178   virtual const inner_prod_ptr_t inner_prod() const;
00179 
00181 
00184 
00197   virtual space_ptr_t clone() const = 0;
00198 
00213   virtual bool is_compatible(const VectorSpace& vec_spc ) const = 0;
00214 
00217   virtual index_type dim() const = 0;
00218 
00233   virtual vec_mut_ptr_t create_member() const = 0;
00234 
00236 
00239 
00255   virtual bool is_in_core() const;
00256 
00265   virtual space_fcty_ptr_t small_vec_spc_fcty() const;
00266 
00287   virtual vec_mut_ptr_t create_member(const value_type& alpha) const;
00288 
00311   virtual multi_vec_mut_ptr_t create_members(size_type num_vecs) const;
00312 
00314 
00352   virtual space_ptr_t sub_space(const Range1D& rng) const;
00353 
00355   space_ptr_t sub_space( const index_type il, const index_type iu ) const;
00356 
00378   virtual space_ptr_t space(
00379     const GenPermMatrixSlice  &P
00380     ,BLAS_Cpp::Transp         P_trans
00381     ) const;
00382 
00384   
00387 
00389   obj_ptr_t create() const;
00390 
00392 
00393 private:
00394 #ifdef DOXYGEN_COMPILE
00395   const InnerProduct   *inner_prod;
00396 #else
00397   inner_prod_ptr_t     inner_prod_;
00398 #endif
00399 
00400 }; // end class VectorSpace
00401 
00402 // ////////////////////////////////////////////////
00403 // Inline members
00404 
00405 inline
00406 VectorSpace::space_ptr_t
00407 VectorSpace::sub_space( const index_type il, const index_type iu ) const
00408 {
00409   return this->sub_space(Range1D(il,iu));
00410 }
00411 
00412 } // end namespace AbstractLinAlgPack
00413 
00414 #endif  // ALAP_VECTOR_SPACE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines