Compute Library
 21.08
Memory.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_MEMORY_H
25 #define ARM_COMPUTE_MEMORY_H
26 
28 
30 
31 #include <cstddef>
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 /** CPU implementation of memory object */
37 class Memory : public IMemory
38 {
39 public:
40  /** Default Constructor */
41  Memory();
42  /** Default Constructor
43  *
44  * @param[in] memory Memory to be imported
45  */
46  Memory(const std::shared_ptr<IMemoryRegion> &memory);
47  /** Default Constructor
48  *
49  * @note Ownership of the memory is not transferred to this object.
50  * Thus management (allocate/free) should be done by the client.
51  *
52  * @param[in] memory Memory to be imported
53  */
54  Memory(IMemoryRegion *memory);
55  /** Allow instances of this class to be copied */
56  Memory(const Memory &) = default;
57  /** Allow instances of this class to be copy assigned */
58  Memory &operator=(const Memory &) = default;
59  /** Allow instances of this class to be moved */
60  Memory(Memory &&) noexcept = default;
61  /** Allow instances of this class to be move assigned */
62  Memory &operator=(Memory &&) noexcept = default;
63 
64  // Inherited methods overridden:
65  IMemoryRegion *region() final;
66  IMemoryRegion *region() const final;
67  void set_region(IMemoryRegion *region) final;
68  void set_owned_region(std::unique_ptr<IMemoryRegion> region) final;
69 
70 private:
71  IMemoryRegion *_region;
72  std::shared_ptr<IMemoryRegion> _region_owned;
73 };
74 } // namespace arm_compute
75 #endif /* ARM_COMPUTE_MEMORY_H */
CPU implementation of memory object.
Definition: Memory.h:37
Memory interface.
Definition: IMemory.h:32
IMemoryRegion * region() final
Region accessor.
Definition: Memory.cpp:48
Memory region interface.
Definition: IMemoryRegion.h:33
Copyright (c) 2017-2021 Arm Limited.
void set_region(IMemoryRegion *region) final
Sets a memory region.
Definition: Memory.cpp:58
void set_owned_region(std::unique_ptr< IMemoryRegion > region) final
Sets a memory region.
Definition: Memory.cpp:64
Memory()
Default Constructor.
Definition: Memory.cpp:30
Memory & operator=(const Memory &)=default
Allow instances of this class to be copy assigned.