Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2016, 2017 ARM Limited. |
| 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
| 24 | #ifndef __ARM_COMPUTE_CLDISTRIBUTION1D_H__ |
| 25 | #define __ARM_COMPUTE_CLDISTRIBUTION1D_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/ICLDistribution1D.h" |
| 28 | #include "arm_compute/core/CL/OpenCL.h" |
| 29 | |
| 30 | #include <cstddef> |
| 31 | #include <cstdint> |
| 32 | |
| 33 | namespace arm_compute |
| 34 | { |
| 35 | /** CLDistribution1D object class */ |
| 36 | class CLDistribution1D : public ICLDistribution1D |
| 37 | { |
| 38 | public: |
| 39 | /** Constructor: Creates a 1D CLDistribution of a consecutive interval [offset, offset + range - 1] |
| 40 | * defined by a start offset and valid range, divided equally into num_bins parts. |
| 41 | * |
| 42 | * @param[in] num_bins The number of bins the distribution is divided in. |
| 43 | * @param[in] offset The start of the values to use. |
| 44 | * @param[in] range The total number of the consecutive values of the distribution interval. |
| 45 | */ |
| 46 | CLDistribution1D(size_t num_bins, int32_t offset, uint32_t range); |
| 47 | /** Prevent instances of this class from being copied (As this class contains pointers). */ |
| 48 | CLDistribution1D(const CLDistribution1D &) = delete; |
| 49 | /** Prevent instances of this class from being copied (As this class contains pointers). */ |
| 50 | CLDistribution1D &operator=(const CLDistribution1D &) = delete; |
| 51 | /** Enqueue a map operation of the allocated buffer. |
| 52 | * |
| 53 | * @param[in] blocking If true, then the mapping will be ready to use by the time |
| 54 | * this method returns, else it is the caller's responsibility |
| 55 | * to flush the queue and wait for the mapping operation to have completed. |
| 56 | */ |
| 57 | void map(bool blocking = true); |
| 58 | using ICLDistribution1D::map; |
| 59 | /** Enqueue an unmap operation of the allocated and mapped buffer. |
| 60 | * |
| 61 | * @note This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before |
| 62 | * the memory is accessed by the device. |
| 63 | */ |
| 64 | void unmap(); |
| 65 | using ICLDistribution1D::unmap; |
| 66 | |
| 67 | // Inherited methods overridden: |
| 68 | cl::Buffer &cl_buffer() override; |
| 69 | |
| 70 | protected: |
| 71 | // Inherited methods overridden: |
| 72 | uint32_t *do_map(cl::CommandQueue &q, bool blocking) override; |
| 73 | void do_unmap(cl::CommandQueue &q) override; |
| 74 | |
| 75 | private: |
| 76 | cl::Buffer _mem; |
| 77 | }; |
| 78 | } |
| 79 | #endif /* __ARM_COMPUTE_CLDISTRIBUTION1D_H__ */ |