vector_proxy.hpp

Go to the documentation of this file.

#ifndef VIENNACL_VECTOR_PROXY_HPP_
#define VIENNACL_VECTOR_PROXY_HPP_

/* =========================================================================
   Copyright (c) 2010-2016, Institute for Microelectronics,
                            Institute for Analysis and Scientific Computing,
                            TU Wien.
   Portions of this software are copyright by UChicago Argonne, LLC.

                            -----------------
                  ViennaCL - The Vienna Computing Library
                            -----------------

   Project Head:    Karl Rupp                   rupp@iue.tuwien.ac.at

   (A list of authors and contributors can be found in the manual)

   License:         MIT (X11), see file LICENSE in the base directory
============================================================================= */

#include "viennacl/forwards.h"
#include "viennacl/range.hpp"
#include "viennacl/slice.hpp"
#include "viennacl/vector.hpp"
#include "viennacl/tools/entry_proxy.hpp"

namespace viennacl
{

template<typename VectorType>
class vector_range : public vector_base<typename VectorType::cpu_value_type>
{
  typedef vector_range<VectorType>             self_type;
  typedef vector_base<typename VectorType::cpu_value_type> base_type;

public:
  typedef typename VectorType::value_type      value_type;
  typedef range::size_type                     size_type;
  typedef range::difference_type               difference_type;
  typedef value_type                           reference;
  typedef const value_type &                   const_reference;
  typedef typename VectorType::const_iterator  const_iterator;
  typedef typename VectorType::iterator        iterator;
  typedef typename VectorType::handle_type     handle_type;

  typedef typename VectorType::cpu_value_type    cpu_value_type;

  vector_range(VectorType const & v, range const & entry_range)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_range.size(), v.start() + v.stride() * entry_range.start(), v.stride()) {}

  vector_range(self_type const & v, range const & entry_range)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_range.size(), v.start() + v.stride() * entry_range.start(), v.stride()) {}

  vector_range(self_type const & other)
    : base_type(const_cast<handle_type &>(other.handle()),
                other.size(), other.start(), other.stride()) {}

  using base_type::operator=;

  // the following are needed for Visual Studio:
  template<typename OtherNumericT>
  base_type & operator=(viennacl::vector<OtherNumericT> const & v)                          { return base_type::operator=(static_cast<viennacl::vector_base<OtherNumericT> const &>(v)); }

  template<typename OtherNumericT>
  base_type & operator=(viennacl::vector_range<viennacl::vector<OtherNumericT> > const & v) { return base_type::operator=(static_cast<viennacl::vector_base<OtherNumericT> const &>(v)); }

  template<typename OtherNumericT>
  base_type & operator=(viennacl::vector_slice<viennacl::vector<OtherNumericT> > const & v) { return base_type::operator=(static_cast<viennacl::vector_base<OtherNumericT> const &>(v)); }
};

template<typename VectorType>
class vector_range<vector_range<VectorType> > : public vector_base<typename VectorType::cpu_value_type>
{
  typedef vector_base<typename VectorType::cpu_value_type>   base_type;

public:
  typedef typename VectorType::handle_type     handle_type;

  vector_range(VectorType const & v, range const & entry_range)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_range.size(), v.start() + v.stride() * entry_range.start(), v.stride()) {}

  vector_range(vector_range<VectorType> const & v, range const & entry_range)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_range.size(), v.start() + v.stride() * entry_range.start(), v.stride()) {}
};


template<typename VectorType, typename NumericT>
void copy(const VectorType & cpu_vector,
          vector_range<vector<NumericT> > & gpu_vector_range )
{
  assert(cpu_vector.end() - cpu_vector.begin() >= 0 && bool("Range must have nonnegative length!"));

  if (cpu_vector.end() - cpu_vector.begin() > 0)
  {
    //we require that the size of the gpu_vector is larger or equal to the cpu-size
    std::vector<NumericT> temp_buffer(static_cast<vcl_size_t>(cpu_vector.end() - cpu_vector.begin()));
    std::copy(cpu_vector.begin(), cpu_vector.end(), temp_buffer.begin());
    viennacl::backend::memory_write(gpu_vector_range.handle(), sizeof(NumericT)*gpu_vector_range.start(), sizeof(NumericT)*temp_buffer.size(), &(temp_buffer[0]));
  }
}


template<typename CPUVECTOR, typename VectorType>
void fast_copy(const CPUVECTOR & cpu_vec, vector_range<VectorType> & gpu_vec)
{
  viennacl::fast_copy(cpu_vec.begin(), cpu_vec.end(), gpu_vec.begin());
}



template<typename NumericT, typename VectorType>
void copy(vector_range<vector<NumericT> > const & gpu_vector_range,
          VectorType & cpu_vector)
{
  assert(cpu_vector.end() - cpu_vector.begin() >= 0 && bool("Range must have nonnegative length!"));

  if (cpu_vector.end() > cpu_vector.begin())
  {
    std::vector<NumericT> temp_buffer(static_cast<vcl_size_t>(cpu_vector.end() - cpu_vector.begin()));
    viennacl::backend::memory_read(gpu_vector_range.handle(), sizeof(NumericT)*gpu_vector_range.start(), sizeof(NumericT)*temp_buffer.size(), &(temp_buffer[0]));

    //now copy entries to cpu_vec:
    std::copy(temp_buffer.begin(), temp_buffer.end(), cpu_vector.begin());
  }
}


template<typename VectorType, typename CPUVECTOR>
void fast_copy(vector_range< VectorType > const & gpu_vec,
               CPUVECTOR & cpu_vec )
{
  viennacl::fast_copy(gpu_vec.begin(), gpu_vec.end(), cpu_vec.begin());
}



//
// Convenience function
//
template<typename VectorType>
vector_range<VectorType> project(VectorType const & vec, viennacl::range const & r1)
{
  return vector_range<VectorType>(vec, r1);
}

template<typename VectorType>
vector_range<VectorType> project(viennacl::vector_range<VectorType> const & vec, viennacl::range const & r1)
{
  assert(r1.size() <= vec.size() && bool("Size of range invalid!"));
  return vector_range<VectorType>(vec, r1);
}

//
//
//
//
//
//



template<typename VectorType>
class vector_slice : public vector_base<typename VectorType::cpu_value_type>
{
  typedef vector_slice<VectorType>             self_type;
  typedef vector_base<typename VectorType::cpu_value_type> base_type;

public:
  typedef typename VectorType::value_type      value_type;
  typedef slice::size_type                     size_type;
  typedef slice::difference_type               difference_type;
  typedef value_type                           reference;
  typedef const value_type &                   const_reference;
  typedef typename VectorType::const_iterator  const_iterator;
  typedef typename VectorType::iterator        iterator;
  typedef typename VectorType::handle_type     handle_type;

  typedef typename VectorType::cpu_value_type  cpu_value_type;

  vector_slice(VectorType const & v, slice const & entry_slice)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_slice.size(), v.start() + v.stride() * entry_slice.start(), v.stride() * entry_slice.stride()) {}

  vector_slice(self_type const & v, slice const & entry_slice)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_slice.size(), v.start() + v.stride() * entry_slice.start(), v.stride() * entry_slice.stride()) {}

  vector_slice(self_type const & other)
    : base_type(const_cast<handle_type &>(other.handle()),
                other.size(), other.start(), other.stride()) {}

  using base_type::operator=;

  // the following are needed for Visual Studio:
  template<typename OtherNumericT>
  base_type & operator=(viennacl::vector<OtherNumericT> const & v)                          { return base_type::operator=(static_cast<viennacl::vector_base<OtherNumericT> const &>(v)); }

  template<typename OtherNumericT>
  base_type & operator=(viennacl::vector_range<viennacl::vector<OtherNumericT> > const & v) { return base_type::operator=(static_cast<viennacl::vector_base<OtherNumericT> const &>(v)); }

  template<typename OtherNumericT>
  base_type & operator=(viennacl::vector_slice<viennacl::vector<OtherNumericT> > const & v) { return base_type::operator=(static_cast<viennacl::vector_base<OtherNumericT> const &>(v)); }
};


template<typename VectorType>
class vector_slice<vector_slice<VectorType> > : public vector_base<typename VectorType::cpu_value_type>
{
  typedef vector_base<typename VectorType::cpu_value_type>   base_type;

public:
  typedef typename VectorType::handle_type     handle_type;

  vector_slice(VectorType const & v, slice const & entry_slice)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_slice.size(), v.start() + v.stride() * entry_slice.start(), entry_slice.stride() * v.stride()) {}

  vector_slice(vector_slice<VectorType> const & v, slice const & entry_slice)
    : base_type(const_cast<handle_type &>(v.handle()),
                entry_slice.size(), v.start() + v.stride() * entry_slice.start(), entry_slice.stride() * v.stride()) {}
};


template<typename VectorType, typename NumericT>
void copy(const VectorType & cpu_vector,
          vector_slice<vector<NumericT> > & gpu_vector_slice )
{
  if (cpu_vector.size() > 0)
  {
    std::vector<NumericT> temp_buffer(gpu_vector_slice.stride() * gpu_vector_slice.size());

    viennacl::backend::memory_read(gpu_vector_slice.handle(), sizeof(NumericT)*gpu_vector_slice.start(), sizeof(NumericT)*temp_buffer.size(), &(temp_buffer[0]));

    for (vcl_size_t i=0; i<cpu_vector.size(); ++i)
      temp_buffer[i * gpu_vector_slice.stride()] = cpu_vector[i];

    viennacl::backend::memory_write(gpu_vector_slice.handle(), sizeof(NumericT)*gpu_vector_slice.start(), sizeof(NumericT)*temp_buffer.size(), &(temp_buffer[0]));
  }
}





template<typename VectorType, typename NumericT>
void copy(vector_slice<vector<NumericT> > const & gpu_vector_slice,
          VectorType & cpu_vector)
{
  assert(gpu_vector_slice.end() - gpu_vector_slice.begin() >= 0 && bool("Range must have nonnegative length!"));

  if (gpu_vector_slice.end() - gpu_vector_slice.begin() > 0)
  {
    std::vector<NumericT> temp_buffer(gpu_vector_slice.stride() * gpu_vector_slice.size());
    viennacl::backend::memory_read(gpu_vector_slice.handle(), sizeof(NumericT)*gpu_vector_slice.start(), sizeof(NumericT)*temp_buffer.size(), &(temp_buffer[0]));

    for (vcl_size_t i=0; i<cpu_vector.size(); ++i)
      cpu_vector[i] = temp_buffer[i * gpu_vector_slice.stride()];
  }
}





//
// Convenience functions
//
template<typename VectorType>
vector_slice<VectorType> project(VectorType const & vec, viennacl::slice const & s1)
{
  assert(s1.size() <= vec.size() && bool("Size of slice larger than vector size!"));
  return vector_slice<VectorType>(vec, s1);
}

template<typename VectorType>
vector_slice<VectorType> project(viennacl::vector_slice<VectorType> const & vec, viennacl::slice const & s1)
{
  assert(s1.size() <= vec.size() && bool("Size of slice larger than vector proxy!"));
  return vector_slice<VectorType>(vec, s1);
}

// interaction with range and vector_range:

template<typename VectorType>
vector_slice<VectorType> project(viennacl::vector_slice<VectorType> const & vec, viennacl::range const & r1)
{
  assert(r1.size() <= vec.size() && bool("Size of slice larger than vector proxy!"));
  return vector_slice<VectorType>(vec, viennacl::slice(r1.start(), 1, r1.size()));
}

template<typename VectorType>
vector_slice<VectorType> project(viennacl::vector_range<VectorType> const & vec, viennacl::slice const & s1)
{
  assert(s1.size() <= vec.size() && bool("Size of slice larger than vector proxy!"));
  return vector_slice<VectorType>(vec, s1);
}


}

#endif