/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/develop/rocAL/include/api/rocal_api_tensor.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/develop/rocAL/include/api/rocal_api_tensor.h Source File#

rocAL: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/develop/rocAL/include/api/rocal_api_tensor.h Source File
rocal_api_tensor.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2019 - 2025 Advanced Micro Devices, Inc. All rights reserved.
3 
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10 
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13 
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 THE SOFTWARE.
21 */
22 
23 #ifndef MIVISIONX_ROCAL_API_TENSOR_H
24 #define MIVISIONX_ROCAL_API_TENSOR_H
25 #include "rocal_api_types.h"
26 
38 class rocalTensor {
39  public:
40  virtual ~rocalTensor() = default;
41  virtual void* buffer() = 0;
42  virtual unsigned copy_data(void* user_buffer, RocalOutputMemType external_mem_type = ROCAL_MEMCPY_HOST) = 0;
43  virtual unsigned copy_data(void* user_buffer, uint x_offset, uint y_offset, uint max_cols, uint max_rows) = 0; // Copy only the ROI to the user_buffer [The padded region is not copied]
44  virtual unsigned num_of_dims() = 0;
45  virtual unsigned batch_size() = 0;
46  virtual std::vector<size_t> dims() = 0;
47  virtual std::vector<size_t> strides() = 0;
48  virtual RocalTensorLayout layout() = 0;
49  virtual RocalTensorBackend backend() = 0;
50  virtual RocalTensorOutputType data_type() = 0;
51  virtual RocalOutputMemType mem_type() = 0;
52  virtual size_t data_size() = 0;
53  virtual RocalROICordsType roi_type() = 0;
54  virtual size_t get_roi_dims_size() = 0;
55  virtual void copy_roi(void* roi_buffer) = 0;
56  virtual std::vector<size_t> shape() = 0;
57  virtual void set_dims(std::vector<size_t> dims) = 0;
58  virtual void set_mem_handle(void* buffer) = 0;
59  virtual void set_tensor_layout(RocalTensorLayout layout) = 0;
60  virtual uint64_t data_type_size() = 0;
61 };
62 
66 class rocalTensorList {
67  public:
68  virtual ~rocalTensorList() = default;
69  virtual uint64_t size() = 0;
70  virtual rocalTensor* at(size_t index) = 0;
71  // isDenseTensor
72 };
73 
77 class rocalListOfTensorList {
78  public:
79  virtual ~rocalListOfTensorList() = default;
80  virtual uint64_t size() = 0;
81  virtual rocalTensorList* at(size_t index) = 0;
82 };
83 
87 struct RocalNSROutput {
88  rocalTensor* anchor;
89  rocalTensor* shape;
90 };
91 
92 typedef rocalTensor* RocalTensor;
93 typedef rocalTensorList* RocalTensorList;
94 typedef rocalListOfTensorList* RocalMetaData;
95 
96 #endif // MIVISIONX_ROCAL_API_TENSOR_H
rocalListOfTensorList
class representing a list of rocal tensor list
Definition: rocal_api_tensor.h:77
rocalTensorList
class representing rocal tensor list
Definition: rocal_api_tensor.h:66
rocalTensor
class representing rocal tensor
Definition: rocal_api_tensor.h:38
RocalTensorLayout
RocalTensorLayout
rocAL Tensor Layout enum
Definition: rocal_api_types.h:208
RocalTensorOutputType
RocalTensorOutputType
rocAL Tensor Output Type enum
Definition: rocal_api_types.h:246
RocalTensorBackend
RocalTensorBackend
Tensor Backend.
Definition: rocal_api_types.h:372
RocalROICordsType
RocalROICordsType
Tensor ROI type.
Definition: rocal_api_types.h:384
rocal_api_types.h
The AMD rocAL Library - Types.
RocalOutputMemType
RocalOutputMemType
Definition: rocal_api_types.h:297
ROCAL_MEMCPY_HOST
@ ROCAL_MEMCPY_HOST
AMD ROCAL_MEMCPY_HOST.
Definition: rocal_api_types.h:300
RocalNSROutput
RocalNSROutput contains the anchor and shape tensor for NonSilentRegionDetection.
Definition: rocal_api_tensor.h:87