MOOCHO (Single Doxygen Collection) Version of the Day
AbstractLinAlgPack_VectorMutable.hpp
Go to the documentation of this file.
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_VECTOR_MUTABLE_HPP
00043 #define ALAP_VECTOR_MUTABLE_HPP
00044 
00045 #include "AbstractLinAlgPack_Vector.hpp"
00046 
00047 namespace AbstractLinAlgPack {
00048 
00072 class VectorMutable : virtual public Vector
00073 {
00074 public:
00075 
00077   using Vector::get_sub_vector;
00079   using Vector::free_sub_vector;
00080 
00083 
00089   virtual VectorMutable& operator=(value_type alpha);
00090 
00096   virtual VectorMutable& operator=(const Vector& v);
00097 
00100   virtual VectorMutable& operator=(const VectorMutable& v);
00101 
00118   virtual void set_ele( index_type i, value_type val );
00119 
00151   virtual vec_mut_ptr_t sub_view( const Range1D& rng );
00152 
00155   vec_mut_ptr_t sub_view( const index_type& l, const index_type& u );
00156 
00161   virtual void zero();
00162 
00168   virtual void axpy( value_type alpha, const Vector& x );
00169 
00215   virtual void get_sub_vector( const Range1D& rng, RTOpPack::MutableSubVector* sub_vec );
00216 
00231   virtual void commit_sub_vector( RTOpPack::MutableSubVector* sub_vec );
00232 
00250   virtual void set_sub_vector( const RTOpPack::SparseSubVector& sub_vec );
00251 
00262   virtual void Vp_StMtV(
00263     value_type                       alpha
00264     ,const GenPermMatrixSlice        &P
00265     ,BLAS_Cpp::Transp                P_trans
00266     ,const Vector                    &x
00267     ,value_type                      beta
00268     );
00269 
00271 
00274 
00282   vec_ptr_t sub_view( const Range1D& rng ) const;
00283 
00285 
00286 }; // end class VectorMutable
00287 
00288 inline
00290 void Vp_StMtV(
00291   VectorMutable                    *y 
00292   ,value_type                      alpha
00293   ,const GenPermMatrixSlice        &P
00294   ,BLAS_Cpp::Transp                P_trans
00295   ,const Vector                    &x
00296   ,value_type                      beta = 1.0
00297   )
00298 {
00299   y->Vp_StMtV(alpha,P,P_trans,x,beta);
00300 }
00301 
00302 // ////////////////////////////////////////////////
00303 // Inline members
00304 
00305 inline
00306 VectorMutable::vec_mut_ptr_t
00307 VectorMutable::sub_view( const index_type& l, const index_type& u )
00308 {
00309   return this->sub_view(Range1D(l,u));
00310 }
00311 
00312 } // end namespace AbstractLinAlgPack
00313 
00314 #endif  // ALAP_VECTOR_MUTABLE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines