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_VectorSpaceSerial.cpp
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 #include <assert.h>
43 
44 #include "AbstractLinAlgPack_VectorSpaceSerial.hpp"
45 #include "AbstractLinAlgPack_VectorSpaceFactorySerial.hpp"
46 #include "AbstractLinAlgPack_VectorMutableDense.hpp"
47 #include "AbstractLinAlgPack_MultiVectorMutableDense.hpp"
48 #include "AbstractLinAlgPack_VectorMutable.hpp"
49 #include "AbstractLinAlgPack_GenPermMatrixSlice.hpp"
50 #include "DenseLinAlgPack_DVectorClass.hpp"
51 #include "Teuchos_Assert.hpp"
52 
53 #ifdef TEUCHOS_DEBUG
54 #define CLASS_MEMBER_PTRS \
55 const VectorSpaceSerial *_this = this; \
56 const size_type *_dim = &dim_;
57 #else
58 #define CLASS_MEMBER_PTRS
59 #endif
60 
61 namespace AbstractLinAlgPack {
62 
64 {
65  CLASS_MEMBER_PTRS
66  initialize(dim);
67 }
68 
69 void VectorSpaceSerial::initialize( size_type dim )
70 {
71  CLASS_MEMBER_PTRS
72  dim_ = dim;
73 }
74 
75 // Overridden from VectorSpace
76 
77 bool VectorSpaceSerial::is_compatible(const VectorSpace& a_vec_space ) const
78 {
79  CLASS_MEMBER_PTRS
80  return this->dim() == a_vec_space.dim() && a_vec_space.is_in_core();
81 }
82 
84 {
85  return true;
86 }
87 
88 index_type VectorSpaceSerial::dim() const
89 {
90  CLASS_MEMBER_PTRS
91  return dim_;
92 }
93 
96 {
97  CLASS_MEMBER_PTRS
99 }
100 
103 {
104  CLASS_MEMBER_PTRS
105  namespace mmp = MemMngPack;
106  return Teuchos::rcp( new VectorSpaceSerial( dim_ ) );
107 }
108 
111 {
112  CLASS_MEMBER_PTRS
113  namespace mmp = MemMngPack;
114  return Teuchos::rcp(new VectorMutableDense(dim_));
115 }
116 
118 VectorSpaceSerial::create_members(size_type num_vecs) const
119 {
120  CLASS_MEMBER_PTRS
121  namespace mmp = MemMngPack;
122  return Teuchos::rcp(new MultiVectorMutableDense(dim_,num_vecs));
123 }
124 
127 {
128  CLASS_MEMBER_PTRS
129  namespace mmp = MemMngPack;
130  const size_type this_dim = this->dim();
131  const Range1D rng = RangePack::full_range( rng_in, 1, this_dim );
132 #ifdef TEUCHOS_DEBUG
134  rng.ubound() > this_dim, std::out_of_range
135  ,"VectorSpaceSerial::sub_view(...) : Error, "
136  "rng = ["<<rng.lbound()<<","<<rng.ubound()<<"] "
137  "is not in the range [1,this->dim()] = [1," << this_dim );
138 #endif
139  if( rng == Range1D(1,this_dim) )
140  return Teuchos::rcp( this, false );
141  return Teuchos::rcp( new VectorSpaceSerial( rng.size() ) );
142 }
143 
146  const GenPermMatrixSlice &P
147  ,BLAS_Cpp::Transp P_trans
148  ) const
149 {
150  CLASS_MEMBER_PTRS
151  return Teuchos::rcp( new VectorSpaceSerial( BLAS_Cpp::rows( P.rows(), P.cols(), P_trans ) ) );
152 }
153 
154 } // end namespace AbstractLinAlgPack
DVector "Adaptor" subclass for DenseLinAlgPack::DVectorSlice or DenseLinAlgPack::DVector objects...
MultiVectorMutable "Adapter" subclass for DenseLinAlgPack::DMatrixSlice or DenseLinAlgPack::DMatrix o...
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Index size() const
Index ubound() const
size_type rows(size_type rows, size_type cols, BLAS_Cpp::Transp _trans)
VectorSpaceSerial(size_type dim=0)
Calls this->initialize().
vec_mut_ptr_t create_member() const
Returns a VectorMutableDense object.
virtual bool is_in_core() const
Returns true if the vectors are in core.
space_fcty_ptr_t small_vec_spc_fcty() const
Returns a VectorSpaceFactorySerial object.
bool is_compatible(const VectorSpace &vec_space) const
Returns true if vec_space.dim() == this->dim().
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Abstract interface for objects that represent a space for mutable coordinate vectors.
index_type dim() const
Returns 0 if uninitialized.
multi_vec_mut_ptr_t create_members(size_type num_vecs) const
Returns a MultiVectorMutableDense object.
Abstract interface for objects that can create vector spaces of a specified dimension.
virtual index_type dim() const =0
Return the dimmension of the vector space.
Index lbound() const
void initialize(size_type dim)
Initialize given the dimension of the vector space.
Transp
space_ptr_t space(const GenPermMatrixSlice &P, BLAS_Cpp::Transp P_trans) const
Concrete matrix type to represent general permutation (mapping) matrices.