AbstractLinAlgPack_VectorSubView.hpp

Go to the documentation of this file.

// @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_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