AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_MultiVectorMutable.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef ALAP_MULTI_VECTOR_MUTABLE_H
00043 #define ALAP_MULTI_VECTOR_MUTABLE_H
00044 
00045 #include "AbstractLinAlgPack_MultiVector.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00082 class MultiVectorMutable : virtual public MultiVector {
00083 public:
00084   
00086   using MultiVector::col;
00088   using MultiVector::row;
00090   using MultiVector::diag;
00091 
00093   typedef Teuchos::RCP<VectorMutable>       vec_mut_ptr_t;
00095   typedef Teuchos::RCP<MultiVectorMutable>  multi_vec_mut_ptr_t;
00096 
00099 
00105   virtual multi_vec_mut_ptr_t mv_clone();
00106 
00108 
00111 
00121   virtual vec_mut_ptr_t col(index_type j) = 0;
00131   virtual vec_mut_ptr_t row(index_type i) = 0;
00140   virtual vec_mut_ptr_t diag(int k) = 0;
00141 
00143 
00146 
00154   virtual multi_vec_mut_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng);
00155   
00158   multi_vec_mut_ptr_t mv_sub_view(
00159     const index_type& rl, const index_type& ru
00160     ,const index_type& cl, const index_type& cu
00161     );
00162 
00164 
00167 
00169   mat_mut_ptr_t clone();
00171   void zero_out();
00173   void Mt_S( value_type alpha );
00175   MatrixOp& operator=(const MatrixOp& mwo_rhs);
00177   bool Mp_StM(
00178     MatrixOp* mwo_lhs, value_type alpha
00179     ,BLAS_Cpp::Transp trans_rhs
00180     ) const;
00182   bool Mp_StM(
00183     value_type alpha,const MatrixOp& M_rhs, BLAS_Cpp::Transp trans_rhs
00184     );
00185 
00187 
00190 
00192   multi_vec_ptr_t mv_clone() const;
00194   vec_ptr_t col(index_type j) const;
00196   vec_ptr_t row(index_type i) const;
00198   vec_ptr_t diag(int k) const;
00200   multi_vec_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng) const;
00201 
00203 
00204 }; // end class MultiVectorMutable
00205 
00206 // //////////////////////////////////////////////////
00207 // Inlined methods for MultiVector
00208 
00209 inline
00210 MultiVectorMutable::multi_vec_mut_ptr_t
00211 MultiVectorMutable::mv_sub_view(
00212   const index_type& rl, const index_type& ru
00213   ,const index_type& cl, const index_type& cu
00214   )
00215 {
00216   return this->mv_sub_view(Range1D(rl,ru),Range1D(cl,cu));
00217 }
00218 
00219 } // end namespace AbstractLinAlgPack
00220 
00221 #endif // ALAP_MULTI_VECTOR_MUTABLE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends