142 lines
4.5 KiB
C
142 lines
4.5 KiB
C
// Copyright (C) 2018-2025 Intel Corporation
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
|
|
/**
|
|
* @brief This is a header file for ov_tensor C API, which is a wrapper for ov::Tensor class
|
|
* Tensor API holding host memory
|
|
* @file ov_tensor.h
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "openvino/c/ov_common.h"
|
|
#include "openvino/c/ov_partial_shape.h"
|
|
#include "openvino/c/ov_shape.h"
|
|
|
|
/**
|
|
* @struct ov_tensor_t
|
|
* @ingroup ov_tensor_c_api
|
|
* @brief type define ov_tensor_t from ov_tensor
|
|
*/
|
|
typedef struct ov_tensor ov_tensor_t;
|
|
|
|
/**
|
|
* @brief Constructs Tensor using element type, shape and external host ptr.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param type Tensor element type
|
|
* @param shape Tensor shape
|
|
* @param host_ptr Pointer to pre-allocated host memory
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_create_from_host_ptr(const ov_element_type_e type,
|
|
const ov_shape_t shape,
|
|
void* host_ptr,
|
|
ov_tensor_t** tensor);
|
|
|
|
/**
|
|
* @brief Constructs Tensor using element type and shape. Allocate internal host storage using default allocator
|
|
* @ingroup ov_tensor_c_api
|
|
* @param type Tensor element type
|
|
* @param shape Tensor shape
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_create(const ov_element_type_e type, const ov_shape_t shape, ov_tensor_t** tensor);
|
|
|
|
/**
|
|
* @brief Set new shape for tensor, deallocate/allocate if new total size is bigger than previous one.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param shape Tensor shape
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_set_shape(ov_tensor_t* tensor, const ov_shape_t shape);
|
|
|
|
/**
|
|
* @brief Constructs a new tensor using a string array.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param string_array An array of strings
|
|
* @param array_size The size of the string array
|
|
* @param shape Tensor shape
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_create_from_string_array(const char** string_array,
|
|
const size_t array_size,
|
|
const ov_shape_t shape,
|
|
ov_tensor_t** tensor);
|
|
|
|
/**
|
|
* @brief Get shape for tensor.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param shape Tensor shape
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_get_shape(const ov_tensor_t* tensor, ov_shape_t* shape);
|
|
|
|
/**
|
|
* @brief Get type for tensor.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param type Tensor element type
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_get_element_type(const ov_tensor_t* tensor, ov_element_type_e* type);
|
|
|
|
/**
|
|
* @brief Set string data for tensor
|
|
* @ingroup ov_tensor_c_api
|
|
* @param string_array Array of strings
|
|
* @param array_size Size of the array
|
|
* @param tensor A point to ov_tensor_t
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_set_string_data(ov_tensor_t* tensor, const char** string_array, const size_t array_size);
|
|
|
|
/**
|
|
* @brief the total number of elements (a product of all the dims or 1 for scalar).
|
|
* @ingroup ov_tensor_c_api
|
|
* @param elements_size number of elements
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_get_size(const ov_tensor_t* tensor, size_t* elements_size);
|
|
|
|
/**
|
|
* @brief the size of the current Tensor in bytes.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param byte_size the size of the current Tensor in bytes.
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_get_byte_size(const ov_tensor_t* tensor, size_t* byte_size);
|
|
|
|
/**
|
|
* @brief Provides an access to the underlaying host memory.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param data A point to host memory.
|
|
* @param tensor A point to ov_tensor_t
|
|
* @return Status code of the operation: OK(0) for success.
|
|
*/
|
|
OPENVINO_C_API(ov_status_e)
|
|
ov_tensor_data(const ov_tensor_t* tensor, void** data);
|
|
|
|
/**
|
|
* @brief Free ov_tensor_t.
|
|
* @ingroup ov_tensor_c_api
|
|
* @param tensor A point to ov_tensor_t
|
|
*/
|
|
OPENVINO_C_API(void)
|
|
ov_tensor_free(ov_tensor_t* tensor);
|