Compute Library
 21.05
CLTensorHandle.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2019 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_GRAPH_CLTENSORHANDLE_H
25 #define ARM_COMPUTE_GRAPH_CLTENSORHANDLE_H
26 
28 
30 
31 namespace arm_compute
32 {
33 namespace graph
34 {
35 namespace backends
36 {
37 /** OpenCL Tensor handle interface object **/
38 class CLTensorHandle final : public ITensorHandle
39 {
40 public:
41  /** Default Constructor
42  *
43  * @param[in] info Tensor metadata
44  */
46  /** Destructor: free the tensor's memory */
47  ~CLTensorHandle() = default;
48  /** Allow instances of this class to be move constructed */
49  CLTensorHandle(CLTensorHandle &&) = default;
50  /** Allow instances of this class to be moved */
52 
53  // Inherited overridden methods
54  void allocate() override;
55  void free() override;
56  void manage(IMemoryGroup *mg) override;
57  void map(bool blocking) override;
58  void unmap() override;
59  void release_if_unused() override;
60  arm_compute::ITensor &tensor() override;
61  const arm_compute::ITensor &tensor() const override;
62  ITensorHandle *parent_handle() override;
63  bool is_subtensor() const override;
64  Target target() const override;
65 
66 private:
67  arm_compute::CLTensor _tensor; /**< Backend Tensor */
68 };
69 } // namespace backends
70 } // namespace graph
71 } // namespace arm_compute
72 #endif /* ARM_COMPUTE_GRAPH_CLTENSORHANDLE_H */
Memory group interface.
Definition: IMemoryGroup.h:37
void unmap() override
Un-maps a backend tensor object.
arm_compute::ITensor & tensor() override
Backend tensor object accessor.
CLTensorHandle(const ITensorInfo &info)
Default Constructor.
void release_if_unused() override
Releases backend tensor if is marked as unused.
OpenCL Tensor handle interface object.
void map(bool blocking) override
Maps backend tensor object.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
CLTensorHandle & operator=(CLTensorHandle &&)=default
Allow instances of this class to be moved.
bool is_subtensor() const override
Checks if a backing tensor is a sub-tensor object or not.
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
~CLTensorHandle()=default
Destructor: free the tensor's memory.
Target target() const override
Returns target type.
Tensor handle interface object.
Definition: ITensorHandle.h:38
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
ITensorHandle * parent_handle() override
Return the parent tensor handle if is a subtensor else this.
void free() override
Allocates backend memory for the handle.
void manage(IMemoryGroup *mg) override
Set backend tensor to be managed by a memory group.
void allocate() override
Allocates backend memory for the handle.
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41