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