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_MultiVectorMutableCols.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 SLAP_MULTI_VECTOR_MUTABLE_COlS_H
43 #define SLAP_MULTI_VECTOR_MUTABLE_COlS_H
44 
45 #include <vector>
46 
47 #include "AbstractLinAlgPack_Types.hpp"
48 #include "AbstractLinAlgPack_MultiVectorMutable.hpp"
49 #include "AbstractLinAlgPack_VectorSpace.hpp"
50 #include "AbstractLinAlgPack_VectorMutable.hpp"
51 
52 namespace AbstractLinAlgPack {
53 
70 {
71 public:
72 
75 
78 
83  ,Teuchos::RCP<VectorMutable> col_vecs[] = NULL
84  );
85 
118  void initialize(
119  const Teuchos::RCP<const VectorSpace> &space_cols
120  ,const Teuchos::RCP<const VectorSpace> &space_rows
121  ,Teuchos::RCP<VectorMutable> col_vecs[] = NULL
122  );
123 
125  void set_uninitialized();
126 
128 
131 
133  size_type rows() const;
135  size_type cols() const;
136 
138 
141 
143  const VectorSpace& space_cols() const;
145  const VectorSpace& space_rows() const;
147  void zero_out();
149  void Mt_S( value_type alpha );
151  MatrixOp& operator=(const MatrixOp& mwo_rhs);
153  mat_mut_ptr_t clone();
155  mat_ptr_t clone() const;
157  void Vp_StMtV(
158  VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
159  , const Vector& v_rhs2, value_type beta) const;
161  void Vp_StMtV(
162  VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
163  , const SpVectorSlice& sv_rhs2, value_type beta) const;
165  bool syrk(
166  BLAS_Cpp::Transp M_trans, value_type alpha
167  , value_type beta, MatrixSymOp* sym_lhs ) const;
168 
171  access_by_t access_by() const;
174 
178  vec_mut_ptr_t col(index_type j);
180  vec_mut_ptr_t row(index_type i);
182  vec_mut_ptr_t diag(int k);
184  multi_vec_mut_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng);
186 
187 private:
188 
189 #ifdef DOXYGEN_COMPILE
190  const VectorSpace *space_cols;
191  const VectorSpace *space_rows;
192  VectorMutable *column_vectors;
193 #else
196  std::vector< Teuchos::RCP<VectorMutable> > col_vecs_;
197 #endif
198 
199 }; // end class MultiVectorMutableCols
200 
201 } // end namespace AbstractLinAlgPack
202 
203 #endif // SLAP_MULTI_VECTOR_MUTABLE_COlS_H
Abstract interface for immutable, finite dimensional, coordinate vectors {abstract}.
bool syrk(BLAS_Cpp::Transp M_trans, value_type alpha, value_type beta, MatrixSymOp *sym_lhs) const
Default subclass for MultiVectorMutable implemented using columns of separate abstract vectors...
Interface adding operations specific for a symmetric matrix {abstract}.
vec_mut_ptr_t diag(int k)
Returns return.get() == NULL
void initialize(const Teuchos::RCP< const VectorSpace > &space_cols, const Teuchos::RCP< const VectorSpace > &space_rows, Teuchos::RCP< VectorMutable > col_vecs[]=NULL)
Initialize given the spaces for the columns and rows and possibly the column vectors.
const VectorSpace & space_cols() const
Abstract interface for objects that represent a space for mutable coordinate vectors.
const VectorSpace & space_rows() const
access_by_t access_by() const
Returns return & COL_ACCESS == true only.
Base class for all matrices that support basic matrix operations.
multi_vec_mut_ptr_t mv_sub_view(const Range1D &row_rng, const Range1D &col_rng)
Interface for a collection of mutable vectors (multi-vector, matrix).
Abstract interface for mutable coordinate vectors {abstract}.
vec_mut_ptr_t row(index_type i)
Returns return.get() == NULL
Transp
void Vp_StMtV(VectorMutable *v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1, const Vector &v_rhs2, value_type beta) const