AllPairs.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2011-2012 The SkelCL Team as listed in CREDITS.txt          *
 * http://skelcl.uni-muenster.de                                             *
 *                                                                           *
 * This file is part of SkelCL.                                              *
 * SkelCL is available under multiple licenses.                              *
 * The different licenses are subject to terms and condition as provided     *
 * in the files specifying the license. See "LICENSE.txt" for details        *
 *                                                                           *
 *****************************************************************************
 *                                                                           *
 * SkelCL is free software: you can redistribute it and/or modify            *
 * it under the terms of the GNU General Public License as published by      *
 * the Free Software Foundation, either version 3 of the License, or         *
 * (at your option) any later version. See "LICENSE-gpl.txt" for details.    *
 *                                                                           *
 * SkelCL 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 General Public License for more details.                              *
 *                                                                           *
 *****************************************************************************
 *                                                                           *
 * For non-commercial academic use see the license specified in the file     *
 * "LICENSE-academic.txt".                                                   *
 *                                                                           *
 *****************************************************************************
 *                                                                           *
 * If you are interested in other licensing models, including a commercial-  *
 * license, please contact the author at michel.steuwer@uni-muenster.de      *
 *                                                                           *
 *****************************************************************************/


#ifndef ALLPAIRS_H
#define ALLPAIRS_H

#include <istream>
#include <string>

#include "detail/Skeleton.h"
#include "detail/Program.h"

namespace skelcl {

template <typename> class Matrix;
template <typename> class Reduce;
template <typename> class Zip;
template <typename> class Out;

template<typename> class AllPairs;


template<typename Tleft,
         typename Tright,
         typename Tout>
class AllPairs<Tout(Tleft, Tright)> : public detail::Skeleton {
public:
  AllPairs<Tout(Tleft, Tright)>(const Reduce<Tout(Tout)>& reduce,
                                const Zip<Tout(Tleft, Tright)>& zip);

  AllPairs<Tout(Tleft, Tright)>(const std::string& source,
                                const std::string& func = std::string("func"));

  template <typename... Args>
  Matrix<Tout> operator()(const Matrix<Tleft>& left,
                          const Matrix<Tright>& right, Args&&... args);

  //
  template <typename... Args>
  Matrix<Tout>& operator()(Out< Matrix<Tout> > output,
                           const Matrix<Tleft>& left,
                           const Matrix<Tright>& right,
                           Args&&... args);

private:
  template <typename... Args>
  void execute(Matrix<Tout>& output, const Matrix<Tleft>& left,
               const Matrix<Tright>& right, Args&&... args);

  detail::Program createAndBuildProgramSpecial() const;

  detail::Program createAndBuildProgramGeneral() const;

  void prepareInput(const Matrix<Tleft>& left, const Matrix<Tright>& right);

  void prepareOutput(Matrix<Tout>& output, const Matrix<Tleft>& left,
                     const Matrix<Tright>& right);

  // used by special implementation
  std::string _srcReduce;
  std::string _srcZip;
  std::string _funcReduce;
  std::string _funcZip;
  std::string _idReduce;

  // used by general implementation
  std::string _srcUser;
  std::string _funcUser;

  // used by both implementations
  unsigned int _C;
  unsigned int _R;
  unsigned int _S;
  detail::Program _program;
};

} // namespace skelcl

#include "detail/AllPairsDef.h"

#endif // ALLPAIRS_H