Initial Commit

.svn/pristine/e4/e49af447412e1e2730837db0e7cd0147fd8dd916.svn-base

@@ -0,0 +1,91 @@
+//---------------------------------------------------------------------------//
+// Copyright (c) 2013-2014 Kyle Lutz <kyle.r.lutz@gmail.com>
+//
+// Distributed under the Boost Software License, Version 1.0
+// See accompanying file LICENSE_1_0.txt or copy at
+// http://www.boost.org/LICENSE_1_0.txt
+//
+// See http://boostorg.github.com/compute for more information.
+//---------------------------------------------------------------------------//
+
+#ifndef BOOST_COMPUTE_MEMORY_LOCAL_BUFFER_HPP
+#define BOOST_COMPUTE_MEMORY_LOCAL_BUFFER_HPP
+
+#include <boost/compute/cl.hpp>
+#include <boost/compute/kernel.hpp>
+
+namespace boost {
+namespace compute {
+
+/// \class local_buffer
+/// \brief Represents a local memory buffer on the device.
+///
+/// The local_buffer class represents a block of local memory on a compute
+/// device.
+///
+/// This class is most commonly used to set local memory arguments for compute
+/// kernels:
+/// \code
+/// // set argument to a local buffer with storage for 32 float's
+/// kernel.set_arg(0, local_buffer<float>(32));
+/// \endcode
+///
+/// \see buffer, kernel
+template<class T>
+class local_buffer
+{
+public:
+    /// Creates a local buffer object for \p size elements.
+    local_buffer(const size_t size)
+        : m_size(size)
+    {
+    }
+
+    /// Creates a local buffer object as a copy of \p other.
+    local_buffer(const local_buffer &other)
+        : m_size(other.m_size)
+    {
+    }
+
+    /// Copies \p other to \c *this.
+    local_buffer& operator=(const local_buffer &other)
+    {
+        if(this != &other){
+            m_size = other.m_size;
+        }
+
+        return *this;
+    }
+
+    /// Destroys the local memory object.
+    ~local_buffer()
+    {
+    }
+
+    /// Returns the number of elements in the local buffer.
+    size_t size() const
+    {
+        return m_size;
+    }
+
+private:
+    size_t m_size;
+};
+
+namespace detail {
+
+// set_kernel_arg specialization for local_buffer<T>
+template<class T>
+struct set_kernel_arg<local_buffer<T> >
+{
+    void operator()(kernel &kernel_, size_t index, const local_buffer<T> &buffer)
+    {
+        kernel_.set_arg(index, buffer.size() * sizeof(T), 0);
+    }
+};
+
+} // end detail namespace
+} // end compute namespace
+} // end boost namespace
+
+#endif // BOOST_COMPUTE_MEMORY_SVM_PTR_HPP