Zip.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 ZIP_H_
#define ZIP_H_

#include <istream>
#include <string>

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

namespace skelcl {

class Source;
template <typename> class Out;

template<typename> class Zip;


template<typename Tleft,
         typename Tright,
         typename Tout>
class Zip<Tout(Tleft, Tright)> : public detail::Skeleton {
public:
  Zip<Tout(Tleft, Tright)>(const Source& source,
                           const std::string& funcName
                                              = std::string("func"));

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

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

  const std::string& source() const;
 
  const std::string& func() const;

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

  template <template <typename> class C>
  void prepareInput(const C<Tleft>& left,
                    const C<Tright>& right);

  template <template <typename> class C>
  void prepareOutput(C<Tout>& output,
                     const C<Tleft>& left,
                     const C<Tright>& right);
  
  detail::Program createAndBuildProgram(const std::string& source,
                                        const std::string& funcName) const;

  const std::string     _source;
  const std::string     _funcName;
  const detail::Program _program;
};

template<typename Tleft,
         typename Tright>
class Zip<void(Tleft, Tright)> : public detail::Skeleton {
public:
  Zip<void(Tleft, Tright)>(const Source& source,
                           const std::string& funcName
                                              = std::string("func"));

  template <template <typename> class C,
            typename... Args>
  void operator()(const C<Tleft>& left,
                  const C<Tright>& right,
                  Args&&... args);

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

  template <template <typename> class C>
  void prepareInput(const C<Tleft>& left,
                    const C<Tright>& right);

  detail::Program createAndBuildProgram(const std::string& source,
                                        const std::string& funcName) const;

  const detail::Program _program;
};

// TODO: when template aliases are available:
// template<typename T>
// using Zip = Zip<T(T, T)>;

} // namespace skelcl

#include "detail/ZipDef.h"

#endif // ZIP_H_