Compute Library
 21.05
IMemory.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_IMEMORY_H
25 #define ARM_COMPUTE_IMEMORY_H
26 
28 
29 namespace arm_compute
30 {
31 /** Memory interface*/
32 class IMemory
33 {
34 public:
35  /** Virtual default destructor */
36  virtual ~IMemory() = default;
37  /** Region accessor
38  *
39  * @return Memory region
40  */
41  virtual IMemoryRegion *region() = 0;
42  /** Region accessor
43  *
44  * @return Memory region
45  */
46  virtual IMemoryRegion *region() const = 0;
47  /** Sets a memory region
48  *
49  * @warning Ownership of the memory region remains to the caller
50  *
51  * @param region Memory region
52  */
53  virtual void set_region(IMemoryRegion *region) = 0;
54  /** Sets a memory region
55  *
56  * @warning Ownership of the memory region is transfered along
57  *
58  * @param region Memory region
59  */
60  virtual void set_owned_region(std::unique_ptr<IMemoryRegion> region) = 0;
61 };
62 } // namespace arm_compute
63 #endif /* ARM_COMPUTE_IMEMORY_H */
Memory interface.
Definition: IMemory.h:32
Memory region interface.
Definition: IMemoryRegion.h:33
Copyright (c) 2017-2021 Arm Limited.
virtual void set_owned_region(std::unique_ptr< IMemoryRegion > region)=0
Sets a memory region.
virtual IMemoryRegion * region()=0
Region accessor.
virtual ~IMemory()=default
Virtual default destructor.
virtual void set_region(IMemoryRegion *region)=0
Sets a memory region.