xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/ITensorAccessor.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2019,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_GRAPH_ITENSOR_ACCESSOR_H
25 #define ARM_COMPUTE_GRAPH_ITENSOR_ACCESSOR_H
26 
27 #include "arm_compute/core/ITensor.h"
28 
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 namespace graph
34 {
35 /** Tensor accessor interface */
36 class ITensorAccessor
37 {
38 public:
39     /** Default virtual destructor */
40     virtual ~ITensorAccessor() = default;
41     /** Interface to be implemented to access a given tensor
42      *
43      * @param[in] tensor Tensor to be accessed
44      *
45      * @return True if access is successful else false
46      */
47     virtual bool access_tensor(ITensor &tensor) = 0;
48     /** Returns true if the tensor data is being accessed
49      *
50      * @return True if the tensor data is being accessed by the accessor. False otherwise
51      */
access_tensor_data()52     virtual bool access_tensor_data()
53     {
54         return true;
55     }
56 };
57 
58 using ITensorAccessorUPtr = std::unique_ptr<ITensorAccessor>;
59 } // namespace graph
60 } // namespace arm_compute
61 #endif /* ARM_COMPUTE_GRAPH_SUB_STREAM_H */