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_VectorMutableSubView.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 VECTOR_WITH_OP_MUTABLE_SUB_VIEW_H
43 #define VECTOR_WITH_OP_MUTABLE_SUB_VIEW_H
44 
45 #include "AbstractLinAlgPack_VectorMutable.hpp"
46 #include "AbstractLinAlgPack_VectorSubView.hpp"
47 
48 namespace AbstractLinAlgPack {
49 
64  : virtual public VectorMutable
65  , virtual public VectorSubView
66 {
67 public:
68 
74 
77  VectorMutableSubView( const vec_mut_ptr_t& full_vec, const Range1D& rng );
78 
87  void initialize( const vec_mut_ptr_t& vec, const Range1D& rng );
88 
96  void set_uninitialized();
97 
99  const vec_mut_ptr_t& full_vec() const;
100 
103 
105  vec_ptr_t sub_view( const Range1D& rng ) const;
106 
108 
111 
113  void set_ele( index_type i, value_type val );
115  vec_mut_ptr_t sub_view( const Range1D& rng );
117  void get_sub_vector( const Range1D& rng, RTOpPack::MutableSubVector* sub_vec );
119  void commit_sub_vector( RTOpPack::MutableSubVector* sub_vec );
121  void set_sub_vector( const RTOpPack::SparseSubVector& sub_vec );
122 
124 
125 private:
126 
127  vec_mut_ptr_t full_vec_; // The full vector
128 
129  // Not defined and not to be called!
130  VectorMutableSubView& operator=(const VectorMutableSubView&);
131 
132 }; // end class VectorMutableSubView
133 
134 // //////////////////////////////////
135 // Inline members
136 
137 inline
139 {}
140 
141 inline
144 {
145  return full_vec_;
146 }
147 
148 } // end namespace AbstractLinAlgPack
149 
150 #endif // VECTOR_WITH_OP_MUTABLE_SUB_VIEW_H
void set_sub_vector(const RTOpPack::SparseSubVector &sub_vec)
Concrete subclass for a default sub-view implementation for a Vector object.
Teuchos::RCP< VectorMutable > vec_mut_ptr_t
void initialize(const vec_mut_ptr_t &vec, const Range1D &rng)
Initialize.
void commit_sub_vector(RTOpPack::MutableSubVector *sub_vec)
void get_sub_vector(const Range1D &rng, RTOpPack::MutableSubVector *sub_vec)
Concrete subclass for a sub-view of a VectorMutable object.
Abstract interface for mutable coordinate vectors {abstract}.
vec_ptr_t sub_view(const Range1D &rng) const
Overridden to pick VectorSubView::sub_view().