diff options
Diffstat (limited to 'libs/ARMComputeEx/arm_compute/core/CL/kernels/CLCastKernel.h')
-rw-r--r-- | libs/ARMComputeEx/arm_compute/core/CL/kernels/CLCastKernel.h | 59 |
1 files changed, 49 insertions, 10 deletions
diff --git a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLCastKernel.h b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLCastKernel.h index 6bd33bf8f..4c2feb903 100644 --- a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLCastKernel.h +++ b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLCastKernel.h @@ -14,6 +14,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * @file CLCastKernel.h + * @ingroup COM_AI_RUNTIME + * @brief This file defines CLCastKernel class + */ + #ifndef __ARM_COMPUTE_CLCASTKERNEL_H__ #define __ARM_COMPUTE_CLCASTKERNEL_H__ @@ -23,30 +30,62 @@ namespace arm_compute { class ICLTensor; -/** OpenCL kernel to perform a cast operation */ +/** + * @brief Class to define OpenCL kernel for cast operation + */ class CLCastKernel : public ICLKernel { public: - /** Default constructor */ + /** + * @brief Construct CLCastKernel object + */ CLCastKernel(); - /** Prevent instances of this class from being copied (As this class contains pointers) */ + + /** + * @brief Prevent instances of this class from being copied (As this class contains pointers) + */ CLCastKernel(const CLCastKernel &) = delete; - /** Prevent instances of this class from being copied (As this class contains pointers) */ + + /** + * @brief Prevent instances of this class from being copied (As this class contains pointers) + */ CLCastKernel &operator=(const CLCastKernel &) = delete; - /** Allow instances of this class to be moved */ + + /** + * @brief Construct CLCastKernel object using default move constructor + * @param[in] CLCastKernel object to move + */ CLCastKernel(CLCastKernel &&) = default; - /** Allow instances of this class to be moved */ + + /** + * @brief Allow instances of this class to be moved + * @param[in] CLCastKernel object to move + */ CLCastKernel &operator=(CLCastKernel &&) = default; - /** Default destructor */ + + /** + * @brief Destruct this CLCastKernel object + */ ~CLCastKernel() = default; - /** Initialise the kernel's input and output. - * + + /** + * @brief Initialise the kernel's input and output. * @param[in] input Input tensor. Data types supported: U8/QASYMM8/S16/S32/F16/F32. * @param[in] output Output tensor. Data types supported: U8/QASYMM8/S16/S32/F16/F32. + * @return N/A */ void configure(const ICLTensor *input, ICLTensor *output); - // Inherited methods overridden: + /** + * @brief Enqueue the OpenCL kernel to process the given window on the passed OpenCL command + * queue. + * @note The queue is *not* flushed by this method, and therefore the kernel will not have + * been executed by the time this method returns. + * @param[in] window Region on which to execute the kernel. (Must be a valid region of + * the window returned by window()). + * @param[in,out] queue Command queue on which to enqueue the kernel.@return N/A + * @return N/A + */ void run(const Window &window, cl::CommandQueue &queue) override; private: |