Compute Library
 20.08
Tensor.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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_TENSOR_H
25 #define ARM_COMPUTE_TENSOR_H
26 
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class ITensorInfo;
35 class IRuntimeContext;
36 /** Basic implementation of the tensor interface */
37 class Tensor : public ITensor, public IMemoryManageable
38 {
39 public:
40  /** Constructor
41  *
42  * @param[in] ctx (Optional) Pointer to the runtime context.
43  *
44  */
45  Tensor(IRuntimeContext *ctx = nullptr);
46  /** Destructor: free the tensor's memory */
47  ~Tensor() = default;
48  /** Allow instances of this class to be move constructed */
49  Tensor(Tensor &&) = default;
50  /** Allow instances of this class to be moved */
51  Tensor &operator=(Tensor &&) = default;
52  /** Return a pointer to the tensor's allocator
53  *
54  * @return A pointer to the tensor's allocator
55  */
57 
58  // Inherited methods overridden:
59  ITensorInfo *info() const override;
60  ITensorInfo *info() override;
61  uint8_t *buffer() const override;
62  void associate_memory_group(IMemoryGroup *memory_group) override;
63 
64 private:
65  mutable TensorAllocator _allocator; /**< Instance of the basic CPU allocator.*/
66 };
67 
68 /** Image */
69 using Image = Tensor;
70 } // namespace arm_compute
71 #endif /*ARM_COMPUTE_TENSOR_H */
Memory group interface.
Definition: IMemoryGroup.h:37
Tensor(IRuntimeContext *ctx=nullptr)
Constructor.
Definition: Tensor.cpp:28
Basic implementation of a CPU memory tensor allocator.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Tensor & operator=(Tensor &&)=default
Allow instances of this class to be moved.
Interface for NEON tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2020 Arm Limited.
TensorAllocator * allocator()
Return a pointer to the tensor's allocator.
Definition: Tensor.cpp:48
ITensorInfo * info() const override
Interface to be implemented by the child class to return the tensor's metadata.
Definition: Tensor.cpp:33
~Tensor()=default
Destructor: free the tensor's memory.
void associate_memory_group(IMemoryGroup *memory_group) override
Associates a memory managable object with the memory group that manages it.
Definition: Tensor.cpp:53
Basic implementation of the tensor interface.
Definition: Tensor.h:37
Interface of an object than can be memory managed.
Definition: IMemoryGroup.h:69
uint8_t * buffer() const override
Interface to be implemented by the child class to return a pointer to CPU memory.
Definition: Tensor.cpp:43