Compute Library
 22.05
IMemoryRegion.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020 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_RUNTIME_IMEMORY_REGION_H
25 #define ARM_COMPUTE_RUNTIME_IMEMORY_REGION_H
26 
27 #include <cstddef>
28 #include <memory>
29 
30 namespace arm_compute
31 {
32 /** Memory region interface */
34 {
35 public:
36  /** Default constructor
37  *
38  * @param[in] size Region size
39  */
40  explicit IMemoryRegion(size_t size)
41  : _size(size)
42  {
43  }
44  /** Virtual Destructor */
45  virtual ~IMemoryRegion() = default;
46  /** Extract a sub-region from the memory
47  *
48  * @warning Ownership is maintained by the parent memory,
49  * while a wrapped raw memory region is returned by this function.
50  * Thus parent memory should not be released before this.
51  *
52  *
53  * @param[in] offset Offset to the region
54  * @param[in] size Size of the region
55  *
56  * @return A wrapped memory sub-region with no ownership of the underlying memory
57  */
58  virtual std::unique_ptr<IMemoryRegion> extract_subregion(size_t offset, size_t size) = 0;
59  /** Returns the pointer to the allocated data.
60  *
61  * @return Pointer to the allocated data
62  */
63  virtual void *buffer() = 0;
64  /** Returns the pointer to the allocated data.
65  *
66  * @return Pointer to the allocated data
67  */
68  virtual const void *buffer() const = 0;
69  /** Memory region size accessor
70  *
71  * @return Memory region size
72  */
73  size_t size() const
74  {
75  return _size;
76  }
77  /** Sets size of region
78  *
79  * @warning This should only be used in correlation with handle
80  *
81  * @param[in] size Size to set
82  */
83  void set_size(size_t size)
84  {
85  _size = size;
86  }
87 
88 protected:
89  size_t _size;
90 };
91 } // namespace arm_compute
92 #endif /* ARM_COMPUTE_RUNTIME_IMEMORY_REGION_H */
__global uchar * offset(const Image *img, int x, int y)
Get the pointer position of a Image.
Definition: helpers.h:1083
virtual std::unique_ptr< IMemoryRegion > extract_subregion(size_t offset, size_t size)=0
Extract a sub-region from the memory.
virtual void * buffer()=0
Returns the pointer to the allocated data.
Memory region interface.
Definition: IMemoryRegion.h:33
Copyright (c) 2017-2022 Arm Limited.
IMemoryRegion(size_t size)
Default constructor.
Definition: IMemoryRegion.h:40
virtual ~IMemoryRegion()=default
Virtual Destructor.
void set_size(size_t size)
Sets size of region.
Definition: IMemoryRegion.h:83
size_t size() const
Memory region size accessor.
Definition: IMemoryRegion.h:73