Compute Library
 21.08
AclUtils.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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_ACL_UTILS_H_
25 #define ARM_COMPUTE_ACL_UTILS_H_
26 
27 #include "arm_compute/AclTypes.h"
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif /** __cplusplus */
32 
33 /** Get the size of the existing tensor in byte
34  *
35  * @note The size isn't based on allocated memory, but based on information in its descriptor (dimensions, data type, etc.).
36  *
37  * @param[in] tensor A tensor in interest
38  * @param[out] size The size of the tensor
39  *
40  * @return Status code
41  *
42  * - @ref AclSuccess if function was completed successfully
43  * - @ref AclInvalidArgument if a given argument is invalid
44  */
45 AclStatus AclGetTensorSize(AclTensor tensor, uint64_t *size);
46 
47 /** Get the descriptor of this tensor
48  *
49  * @param[in] tensor A tensor in interest
50  * @param[out] desc The descriptor of the tensor
51  *
52  * @return Status code
53  *
54  * - @ref AclSuccess if function was completed successfully
55  * - @ref AclInvalidArgument if a given argument is invalid
56  */
58 
59 #ifdef __cplusplus
60 }
61 #endif /* __cplusplus */
62 
63 #endif /* ARM_COMPUTE_ACL_UTILS_H_ */
AclStatus AclGetTensorDescriptor(AclTensor tensor, AclTensorDescriptor *desc)
Get the descriptor of this tensor.
Definition: AclTensor.cpp:175
AclStatus AclGetTensorSize(AclTensor tensor, uint64_t *size)
__cplusplus
Definition: AclTensor.cpp:158
AclStatus
Definition: AclTypes.h:49