base_vector.hpp

Go to the documentation of this file.

#ifndef PARALUTION_BASE_VECTOR_HPP_
#define PARALUTION_BASE_VECTOR_HPP_

#include "backend_manager.hpp"

namespace paralution {

// Forward declarations
template <typename ValueType>
class HostVector;

template <typename ValueType>
class AcceleratorVector;

template <typename ValueType>
class GPUAcceleratorVector;

template <typename ValueType>
class OCLAcceleratorVector;

template <typename ValueType>
class MICAcceleratorVector;

template <typename ValueType>
class BaseVector {

public:

  BaseVector();
  virtual ~BaseVector();

  virtual void info(void) const = 0;

  int get_size(void) const;

  void set_backend(const Paralution_Backend_Descriptor local_backend);

  virtual bool Check(void) const;

  virtual void Allocate(const int n) = 0;

  virtual void SetDataPtr(ValueType **ptr, const int size) = 0;
  virtual void LeaveDataPtr(ValueType **ptr) = 0;

  virtual void Assemble(const int *i, const ValueType *v,
                        int size, const int n);

  virtual void Clear(void) = 0;
  virtual void Zeros(void) = 0;
  virtual void Ones(void) = 0;
  virtual void SetValues(const ValueType val) = 0;

  virtual void Permute(const BaseVector<int> &permutation) = 0;
  virtual void PermuteBackward(const BaseVector<int> &permutation) = 0;

  virtual void CopyFrom(const BaseVector<ValueType> &vec) = 0;
  virtual void CopyFromAsync(const BaseVector<ValueType> &vec);
  virtual void CopyFromFloat(const BaseVector<float> &vec);
  virtual void CopyFromDouble(const BaseVector<double> &vec);
  virtual void CopyTo(BaseVector<ValueType> *vec) const = 0;
  virtual void CopyToAsync(BaseVector<ValueType> *vec) const;
  virtual void CopyFrom(const BaseVector<ValueType> &src,
                        const int src_offset,
                        const int dst_offset,
                        const int size) = 0;

  virtual void CopyFromPermute(const BaseVector<ValueType> &src,
                               const BaseVector<int> &permutation) = 0;
  virtual void CopyFromPermuteBackward(const BaseVector<ValueType> &src,
                                       const BaseVector<int> &permutation) = 0;

  virtual void CopyFromData(const ValueType *data);
  virtual void CopyToData(ValueType *data) const;

  virtual bool Restriction(const BaseVector<ValueType> &vec_fine, const BaseVector<int> &map);

  virtual bool Prolongation(const BaseVector<ValueType> &vec_coarse, const BaseVector<int> &map);

  virtual void AddScale(const BaseVector<ValueType> &x, const ValueType alpha) = 0;
  virtual void ScaleAdd(const ValueType alpha, const BaseVector<ValueType> &x) = 0;
  virtual void ScaleAddScale(const ValueType alpha, const BaseVector<ValueType> &x, 
                             const ValueType beta) = 0;

  virtual void ScaleAddScale(const ValueType alpha, const BaseVector<ValueType> &x, 
                             const ValueType beta,
                             const int src_offset,
                             const int dst_offset,
                             const int size) = 0;

  virtual void ScaleAdd2(const ValueType alpha, const BaseVector<ValueType> &x,
                         const ValueType beta, const BaseVector<ValueType> &y,
                         const ValueType gamma) = 0;
  virtual void Scale(const ValueType alpha) = 0;
  virtual void PartialSum(const BaseVector<ValueType> &x) = 0;
  virtual ValueType Dot(const BaseVector<ValueType> &x) const = 0;
  virtual ValueType DotNonConj(const BaseVector<ValueType> &x) const = 0;
  virtual ValueType Norm(void) const = 0;
  virtual ValueType Reduce(void) const = 0;
  virtual ValueType Asum(void) const = 0;
  virtual int Amax(ValueType &value) const = 0;
  virtual void PointWiseMult(const BaseVector<ValueType> &x) = 0;
  virtual void PointWiseMult(const BaseVector<ValueType> &x, const BaseVector<ValueType> &y) = 0;
  virtual void Power(const double power) = 0;

protected:

  int size_;

  Paralution_Backend_Descriptor local_backend_;

};

template <typename ValueType>
class AcceleratorVector : public BaseVector<ValueType> {

public:

  AcceleratorVector();
  virtual ~AcceleratorVector();

  virtual void CopyFromHost(const HostVector<ValueType> &src) = 0;
  virtual void CopyToHost(HostVector<ValueType> *dst) const = 0;

  virtual void CopyFromHostAsync(const HostVector<ValueType> &src);
  virtual void CopyToHostAsync(HostVector<ValueType> *dst) const;

};


}

#endif // PARALUTION_BASE_VECTOR_HPP_