AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_VectorSpace.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef ALAP_VECTOR_SPACE_HPP
43 #define ALAP_VECTOR_SPACE_HPP
44 
45 #include "AbstractLinAlgPack_InnerProduct.hpp"
46 #include "Teuchos_AbstractFactory.hpp"
47 
48 namespace AbstractLinAlgPack {
49 
134  : public Teuchos::AbstractFactory<VectorMutable>
135 {
136 public:
137 
139  class IncompatibleVectorSpaces : public std::logic_error
140  {public: IncompatibleVectorSpaces(const std::string& what_arg) : std::logic_error(what_arg) {}};
151 
152 
155 
157  VectorSpace( const inner_prod_ptr_t& inner_prod = Teuchos::null );
158 
170  virtual void inner_prod( const inner_prod_ptr_t& inner_prod );
171 
178  virtual const inner_prod_ptr_t inner_prod() const;
179 
181 
184 
197  virtual space_ptr_t clone() const = 0;
198 
213  virtual bool is_compatible(const VectorSpace& vec_spc ) const = 0;
214 
217  virtual index_type dim() const = 0;
218 
233  virtual vec_mut_ptr_t create_member() const = 0;
234 
236 
239 
255  virtual bool is_in_core() const;
256 
265  virtual space_fcty_ptr_t small_vec_spc_fcty() const;
266 
287  virtual vec_mut_ptr_t create_member(const value_type& alpha) const;
288 
311  virtual multi_vec_mut_ptr_t create_members(size_type num_vecs) const;
312 
314 
352  virtual space_ptr_t sub_space(const Range1D& rng) const;
353 
355  space_ptr_t sub_space( const index_type il, const index_type iu ) const;
356 
378  virtual space_ptr_t space(
379  const GenPermMatrixSlice &P
380  ,BLAS_Cpp::Transp P_trans
381  ) const;
382 
384 
387 
389  obj_ptr_t create() const;
390 
392 
393 private:
394 #ifdef DOXYGEN_COMPILE
395  const InnerProduct *inner_prod;
396 #else
397  inner_prod_ptr_t inner_prod_;
398 #endif
399 
400 }; // end class VectorSpace
401 
402 // ////////////////////////////////////////////////
403 // Inline members
404 
405 inline
407 VectorSpace::sub_space( const index_type il, const index_type iu ) const
408 {
409  return this->sub_space(Range1D(il,iu));
410 }
411 
412 } // end namespace AbstractLinAlgPack
413 
414 #endif // ALAP_VECTOR_SPACE_HPP
virtual space_ptr_t space(const GenPermMatrixSlice &P, BLAS_Cpp::Transp P_trans) const
Create a vector space for vector to gather the elements into.
virtual bool is_in_core() const
Returns true if the vectors are in core.
virtual space_ptr_t sub_space(const Range1D &rng) const
Create a transient sub-space of the current vector space.
Teuchos::RCP< const VectorSpace > space_ptr_t
Abstract interface for objects that represent a space for mutable coordinate vectors.
obj_ptr_t create() const
Just calls this->create_member() by default!
virtual const inner_prod_ptr_t inner_prod() const
Return the smart pointer to the inner product strategy object.
Teuchos::RCP< MultiVectorMutable > multi_vec_mut_ptr_t
virtual bool is_compatible(const VectorSpace &vec_spc) const =0
Compare the compatibility of two vector spaces.
virtual index_type dim() const =0
Return the dimmension of the vector space.
Abstract interface for inner products.
Teuchos::RCP< const InnerProduct > inner_prod_ptr_t
virtual vec_mut_ptr_t create_member() const =0
Create a vector member from the vector space.
virtual multi_vec_mut_ptr_t create_members(size_type num_vecs) const
Create a set of vector members (a MultiVectorMutable) from the vector space.
VectorSpace(const inner_prod_ptr_t &inner_prod=Teuchos::null)
Calls inner_prod()
Transp
Teuchos::RCP< const VectorSpaceFactory > space_fcty_ptr_t
virtual space_fcty_ptr_t small_vec_spc_fcty() const
Return a VectorSpaceFactory object for the creation of vector spaces with a small dimension...
Concrete matrix type to represent general permutation (mapping) matrices.
virtual space_ptr_t clone() const =0
Create a clone of this vector space object.