AbstractLinAlgPack_VectorMutableSubView.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 VECTOR_WITH_OP_MUTABLE_SUB_VIEW_H
#define VECTOR_WITH_OP_MUTABLE_SUB_VIEW_H

#include "AbstractLinAlgPack_VectorMutable.hpp"
#include "AbstractLinAlgPack_VectorSubView.hpp"

namespace AbstractLinAlgPack {

class VectorMutableSubView
  : virtual public VectorMutable
  , virtual public VectorSubView
{
public:

  VectorMutableSubView();

  VectorMutableSubView( const vec_mut_ptr_t& full_vec, const Range1D& rng );

  void initialize( const vec_mut_ptr_t& vec, const Range1D& rng );

  void set_uninitialized();

  const vec_mut_ptr_t& full_vec() const;


  vec_ptr_t sub_view( const Range1D& rng ) const;


  
  void set_ele( index_type i, value_type val );
  vec_mut_ptr_t sub_view( const Range1D& rng );
  void get_sub_vector( const Range1D& rng, RTOpPack::MutableSubVector* sub_vec );
  void commit_sub_vector( RTOpPack::MutableSubVector* sub_vec );
  void set_sub_vector( const RTOpPack::SparseSubVector& sub_vec );


private:

  vec_mut_ptr_t       full_vec_; // The full vector

  // Not defined and not to be called!
  VectorMutableSubView& operator=(const VectorMutableSubView&);

}; // end class VectorMutableSubView

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

inline
VectorMutableSubView::VectorMutableSubView()
{}

inline
const VectorMutableSubView::vec_mut_ptr_t&
VectorMutableSubView::full_vec() const
{
  return full_vec_;
}

} // end namespace AbstractLinAlgPack

#endif // VECTOR_WITH_OP_MUTABLE_SUB_VIEW_H