AbstractLinAlgPack_VectorMutable.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef ALAP_VECTOR_MUTABLE_HPP
#define ALAP_VECTOR_MUTABLE_HPP

#include "AbstractLinAlgPack_Vector.hpp"

namespace AbstractLinAlgPack {

class VectorMutable : virtual public Vector
{
public:

  using Vector::get_sub_vector;
  using Vector::free_sub_vector;


  virtual VectorMutable& operator=(value_type alpha);

  virtual VectorMutable& operator=(const Vector& v);

  virtual VectorMutable& operator=(const VectorMutable& v);

  virtual void set_ele( index_type i, value_type val );

  virtual vec_mut_ptr_t sub_view( const Range1D& rng );

  vec_mut_ptr_t sub_view( const index_type& l, const index_type& u );

  virtual void zero();

  virtual void axpy( value_type alpha, const Vector& x );

  virtual void get_sub_vector( const Range1D& rng, RTOpPack::MutableSubVector* sub_vec );

  virtual void commit_sub_vector( RTOpPack::MutableSubVector* sub_vec );

  virtual void set_sub_vector( const RTOpPack::SparseSubVector& sub_vec );

  virtual void Vp_StMtV(
    value_type                       alpha
    ,const GenPermMatrixSlice        &P
    ,BLAS_Cpp::Transp                P_trans
    ,const Vector                    &x
    ,value_type                      beta
    );



  vec_ptr_t sub_view( const Range1D& rng ) const;


}; // end class VectorMutable

inline
void Vp_StMtV(
  VectorMutable                    *y 
  ,value_type                      alpha
  ,const GenPermMatrixSlice        &P
  ,BLAS_Cpp::Transp                P_trans
  ,const Vector                    &x
  ,value_type                      beta = 1.0
  )
{
  y->Vp_StMtV(alpha,P,P_trans,x,beta);
}

// ////////////////////////////////////////////////
// Inline members

inline
VectorMutable::vec_mut_ptr_t
VectorMutable::sub_view( const index_type& l, const index_type& u )
{
  return this->sub_view(Range1D(l,u));
}

} // end namespace AbstractLinAlgPack

#endif  // ALAP_VECTOR_MUTABLE_HPP