AbstractLinAlgPack_VectorSubView.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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef ALAP_VECTOR_SUB_VIEW_H
#define ALAP_VECTOR_SUB_VIEW_H

#include "AbstractLinAlgPack_Vector.hpp"
#include "AbstractLinAlgPack_VectorApplyOpSerialBase.hpp"
#include "AbstractLinAlgPack_VectorSpaceSubSpace.hpp"

namespace AbstractLinAlgPack {

class VectorSubView
  : virtual public Vector
  , virtual protected VectorApplyOpSerialBase
{
public:

  VectorSubView();
  VectorSubView( const vec_ptr_t& full_vec, const Range1D& rng );
  void initialize( const vec_ptr_t& full_vec, const Range1D& rng );
  void set_uninitialized();
  const vec_ptr_t& full_vec() const;
  const VectorSpaceSubSpace& space_impl() const;


  const VectorSpace& space() const;
  index_type dim() const;
  void apply_op(
    const RTOpPack::RTOp& op
    ,const size_t num_vecs, const Vector* vecs[]
    ,const size_t num_targ_vecs, VectorMutable* targ_vecs[]
    ,RTOpPack::ReductTarget *reduct_obj
    ,const index_type first_ele, const index_type sub_dim, const index_type global_offset
    ) const;
  value_type get_ele(index_type i) const;
  vec_ptr_t sub_view( const Range1D& rng ) const;
  void get_sub_vector( const Range1D& rng, RTOpPack::SubVector* sub_vec ) const;
  void free_sub_vector( RTOpPack::SubVector* sub_vec ) const;


private:

  vec_ptr_t                  full_vec_;   
  VectorSpaceSubSpace        space_;      

  // Not defined and not to be called
  VectorSubView& operator=(const VectorSubView&);
  
}; // end class VectorSubView

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

inline
VectorSubView::VectorSubView()
{}

inline
const VectorSubView::vec_ptr_t&
VectorSubView::full_vec() const
{
  return full_vec_;
}

inline
const VectorSpaceSubSpace& VectorSubView::space_impl() const
{
  return space_;
}

} // end namespace AbstractLinAlgPack

#endif // ALAP_VECTOR_SUB_VIEW_H