Compute Library
 21.05
ITensorPack.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-2021 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_ITENSORPACK_H
25 #define ARM_COMPUTE_ITENSORPACK_H
26 
27 #include <cstddef>
28 #include <cstdint>
29 #include <map>
30 
31 namespace arm_compute
32 {
33 // Forward declaration
34 class ITensor;
35 
36 /** Tensor packing service */
38 {
39 private:
40  struct PackElement
41  {
42  PackElement() = default;
43  PackElement(ITensor *tensor)
44  : tensor(tensor), ctensor(nullptr)
45  {
46  }
47  PackElement(const ITensor *ctensor)
48  : tensor(nullptr), ctensor(ctensor)
49  {
50  }
51 
52  ITensor *tensor{ nullptr };
53  const ITensor *ctensor{ nullptr };
54  };
55 
56 public:
57  /** Default Constructor */
58  ITensorPack() = default;
59  /** Add tensor to the pack
60  *
61  * @param[in] id ID/type of the tensor to add
62  * @param[in] tensor Tensor to add
63  */
64  void add_tensor(int id, ITensor *tensor);
65 
66  /** Add const tensor to the pack
67  *
68  * @param[in] id ID/type of the tensor to add
69  * @param[in] tensor Tensor to add
70  */
71  void add_tensor(int id, const ITensor *tensor);
72 
73  /** Add const tensor to the pack
74  *
75  * @param[in] id ID/type of the tensor to add
76  * @param[in] tensor Tensor to add
77  */
78  void add_const_tensor(int id, const ITensor *tensor);
79  /** Get tensor of a given id from the pac
80  *
81  * @param[in] id ID of tensor to extract
82  *
83  * @return The pointer to the tensor if exist and is non-const else nullptr
84  */
85  ITensor *get_tensor(int id);
86  /** Get constant tensor of a given id
87  *
88  * @param[in] id ID of tensor to extract
89  *
90  * @return The pointer to the tensor if exist and is const else nullptr
91  */
92  const ITensor *get_const_tensor(int id) const;
93  /** Pack size accessor
94  *
95  * @return Number of tensors registered to the pack
96  */
97  size_t size() const;
98  /** Checks if pack is empty
99  *
100  * @return True if empty else false
101  */
102  bool empty() const;
103 
104 private:
105  std::map<unsigned int, PackElement> _pack{}; /**< Container with the packed tensors */
106 };
107 } // namespace arm_compute
108 #endif /*ARM_COMPUTE_ITENSORPACK_H */
void add_const_tensor(int id, const ITensor *tensor)
Add const tensor to the pack.
Definition: ITensorPack.cpp:40
bool empty() const
Checks if pack is empty.
Definition: ITensorPack.cpp:66
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
const ITensor * get_const_tensor(int id) const
Get constant tensor of a given id.
Definition: ITensorPack.cpp:45
size_t size() const
Pack size accessor.
Definition: ITensorPack.cpp:61
ITensorPack()=default
Default Constructor.
ITensor * get_tensor(int id)
Get tensor of a given id from the pac.
Definition: ITensorPack.cpp:55
Tensor packing service.
Definition: ITensorPack.h:37
void add_tensor(int id, ITensor *tensor)
Add tensor to the pack.
Definition: ITensorPack.cpp:30