xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/SubTensor.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_SUBTENSOR_H
25 #define ARM_COMPUTE_SUBTENSOR_H
26 
27 #include "arm_compute/core/SubTensorInfo.h"
28 #include "arm_compute/runtime/Tensor.h"
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class ITensorInfo;
35 
36 /** Basic implementation of the sub-tensor interface */
37 class SubTensor : public ITensor
38 {
39 public:
40     /** Default Constructor */
41     SubTensor();
42     /** Constructor
43      *
44      * @param[in] parent        Parent tensor
45      * @param[in] tensor_shape  Shape of the subtensor
46      * @param[in] coords        Coordinates of the first subtensor element inside the parent tensor.
47      * @param[in] extend_parent (Optional) Extend parent with subtensor shape if subtensor indexes out of bounds
48      */
49     SubTensor(ITensor *parent, const TensorShape &tensor_shape, const Coordinates &coords, bool extend_parent = false);
50     /** Destructor: free the tensor's memory */
51     ~SubTensor() = default;
52     /** Restrict instances of this class to be copy constructed */
53     SubTensor(const SubTensor &) = delete;
54     /** Restrict instances of this class to be copied */
55     SubTensor &operator=(const SubTensor &) = delete;
56     /** Allow instances of this class to be move constructed */
57     SubTensor(SubTensor &&) = default;
58     /** Allow instances of this class to be moved */
59     SubTensor &operator=(SubTensor &&) = default;
60     /** Return the parent tensor of the subtensor
61      *
62      * @return Parent tensor
63      */
64     ITensor *parent();
65 
66     // Inherited methods overridden:
67     ITensorInfo *info() const override;
68     ITensorInfo *info() override;
69     uint8_t     *buffer() const override;
70 
71 private:
72     ITensor              *_parent;
73     mutable SubTensorInfo _info;
74 };
75 }
76 #endif /*ARM_COMPUTE_SUBTENSOR_H */
77