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_MultiVectorMutable.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_MULTI_VECTOR_MUTABLE_H
43 #define ALAP_MULTI_VECTOR_MUTABLE_H
44 
45 #include "AbstractLinAlgPack_MultiVector.hpp"
46 
47 namespace AbstractLinAlgPack {
48 
82 class MultiVectorMutable : virtual public MultiVector {
83 public:
84 
86  using MultiVector::col;
88  using MultiVector::row;
90  using MultiVector::diag;
91 
96 
99 
105  virtual multi_vec_mut_ptr_t mv_clone();
106 
108 
111 
121  virtual vec_mut_ptr_t col(index_type j) = 0;
131  virtual vec_mut_ptr_t row(index_type i) = 0;
140  virtual vec_mut_ptr_t diag(int k) = 0;
141 
143 
146 
154  virtual multi_vec_mut_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng);
155 
159  const index_type& rl, const index_type& ru
160  ,const index_type& cl, const index_type& cu
161  );
162 
164 
167 
169  mat_mut_ptr_t clone();
171  void zero_out();
173  void Mt_S( value_type alpha );
175  MatrixOp& operator=(const MatrixOp& mwo_rhs);
177  bool Mp_StM(
178  MatrixOp* mwo_lhs, value_type alpha
179  ,BLAS_Cpp::Transp trans_rhs
180  ) const;
182  bool Mp_StM(
183  value_type alpha,const MatrixOp& M_rhs, BLAS_Cpp::Transp trans_rhs
184  );
185 
187 
190 
192  multi_vec_ptr_t mv_clone() const;
194  vec_ptr_t col(index_type j) const;
196  vec_ptr_t row(index_type i) const;
198  vec_ptr_t diag(int k) const;
200  multi_vec_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng) const;
201 
203 
204 }; // end class MultiVectorMutable
205 
206 // //////////////////////////////////////////////////
207 // Inlined methods for MultiVector
208 
209 inline
212  const index_type& rl, const index_type& ru
213  ,const index_type& cl, const index_type& cu
214  )
215 {
216  return this->mv_sub_view(Range1D(rl,ru),Range1D(cl,cu));
217 }
218 
219 } // end namespace AbstractLinAlgPack
220 
221 #endif // ALAP_MULTI_VECTOR_MUTABLE_H
virtual multi_vec_mut_ptr_t mv_sub_view(const Range1D &row_rng, const Range1D &col_rng)
Returns a mutable sub-view of the multi vector.
virtual multi_vec_mut_ptr_t mv_clone()
Clone the non-const multi-vector object.
bool Mp_StM(MatrixOp *mwo_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs) const
virtual vec_mut_ptr_t diag(int k)=0
Get a mutable diagonal vector.
virtual vec_ptr_t diag(int k) const =0
Get a non-mutable diagonal vector.
Base class for all matrices that support basic matrix operations.
Interface for a collection of non-mutable vectors (multi-vector, matrix).
virtual vec_mut_ptr_t row(index_type i)=0
Get a mutable row vector.
Interface for a collection of mutable vectors (multi-vector, matrix).
virtual vec_ptr_t col(index_type j) const =0
Get a non-mutable column vector.
virtual vec_mut_ptr_t col(index_type j)=0
Get a mutable column vector.
virtual vec_ptr_t row(index_type i) const =0
Get a non-mutable row vector.
Transp