org.bytedeco.onnxruntime

Class ConstValue

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.onnxruntime.BaseConstValue

org.bytedeco.onnxruntime.ConstValue

All Implemented Interfaces:

AutoCloseable

@Name(value="Ort::detail::ConstValueImpl<Ort::detail::Unowned<const OrtValue> >")
 @Properties(inherit=onnxruntime.class)
public class ConstValue
extends BaseConstValue

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ConstValue() Default native constructor.
ConstValue(long size) Native array allocator.
ConstValue(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
long	GetCount() < Return true if OrtValue contains data and returns false if the OrtValue is a None
ConstValue	getPointer(long i)
int	GetSparseFormat() The API returns the sparse data format this OrtValue holds in a sparse tensor.
TensorTypeAndShapeInfo	GetSparseTensorIndicesTypeShapeInfo(int format)
TensorTypeAndShapeInfo	GetSparseTensorIndicesTypeShapeInfo(onnxruntime.OrtSparseIndicesFormat format) The API returns type and shape information for the specified indices.
TensorTypeAndShapeInfo	GetSparseTensorValuesTypeAndShapeInfo() The API returns type and shape information for stored non-zero values of the sparse tensor.
void	GetStringTensorContent(Pointer buffer, long buffer_length, SizeTPointer offsets, long offsets_count) The API copies all of the UTF-8 encoded string data contained within a tensor or a sparse tensor into a supplied buffer.
long	GetStringTensorDataLength() This API returns a full length of string data contained within either a tensor or a sparse Tensor.
BytePointer	GetStringTensorElement(long element_index) Returns string tensor UTF-8 encoded string element.
void	GetStringTensorElement(long buffer_length, long element_index, Pointer buffer) The API copies UTF-8 encoded bytes for the requested string element contained within a tensor or a sparse tensor into a provided buffer.
long	GetStringTensorElementLength(long element_index) The API returns a byte length of UTF-8 encoded string element contained in either a tensor or a spare tensor values.
MemoryInfoImpl	GetTensorMemoryInfo() This API returns information about the memory allocation used to hold data.
Pointer	GetTensorRawData() Returns a non-typed pointer to a tensor contained data.
TensorTypeAndShapeInfo	GetTensorTypeAndShapeInfo() The API returns type information for data contained in a tensor.
TypeInfo	GetTypeInfo() The API returns type information for data contained in a tensor.
Value	GetValue(int index, OrtAllocator allocator)
boolean	HasValue()
boolean	IsSparseTensor() Returns true if the OrtValue contains a sparse tensor
boolean	IsTensor() Returns true if Value is a tensor, false for other types like map/sequence/etc
ConstValue	position(long position)

Methods inherited from class org.bytedeco.onnxruntime.BaseConstValue

asUnownedAllocator, put

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConstValue

public ConstValue()

Default native constructor.

ConstValue

public ConstValue(long size)

Native array allocator. Access with Pointer.position(long).

ConstValue

public ConstValue(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public ConstValue position(long position)

Overrides:

position in class BaseConstValue

getPointer

public ConstValue getPointer(long i)

Overrides:

getPointer in class BaseConstValue

IsTensor

@Cast(value="bool")
public boolean IsTensor()

Returns true if Value is a tensor, false for other types like map/sequence/etc

HasValue

@Cast(value="bool")
public boolean HasValue()

GetCount

@Cast(value="size_t")
public long GetCount()

< Return true if OrtValue contains data and returns false if the OrtValue is a None

GetValue

@StdMove
public Value GetValue(int index,
                                OrtAllocator allocator)

GetStringTensorDataLength

@Cast(value="size_t")
public long GetStringTensorDataLength()

This API returns a full length of string data contained within either a tensor or a sparse Tensor. For sparse tensor it returns a full length of stored non-empty strings (values). The API is useful for allocating necessary memory and calling GetStringTensorContent().

total length of UTF-8 encoded bytes contained. No zero terminators counted.

GetStringTensorContent

public void GetStringTensorContent(Pointer buffer,
                                   @Cast(value="size_t")
                                   long buffer_length,
                                   @Cast(value="size_t*")
                                   SizeTPointer offsets,
                                   @Cast(value="size_t")
                                   long offsets_count)

The API copies all of the UTF-8 encoded string data contained within a tensor or a sparse tensor into a supplied buffer. Use GetStringTensorDataLength() to find out the length of the buffer to allocate. The user must also allocate offsets buffer with the number of entries equal to that of the contained strings. Strings are always assumed to be on CPU, no X-device copy.

user allocated buffer length in bytes of the allocated buffer a pointer to the offsets user allocated buffer count of offsets, must be equal to the number of strings contained. that can be obtained from the shape of the tensor or from GetSparseTensorValuesTypeAndShapeInfo() for sparse tensors

GetTensorRawData

@Const
public Pointer GetTensorRawData()

Returns a non-typed pointer to a tensor contained data.

const pointer to data, no copies made

GetTypeInfo

@ByVal
public TypeInfo GetTypeInfo()

The API returns type information for data contained in a tensor. For sparse tensors it returns type information for contained non-zero values. It returns dense shape for sparse tensors.

TypeInfo

GetTensorTypeAndShapeInfo

@ByVal
public TensorTypeAndShapeInfo GetTensorTypeAndShapeInfo()

The API returns type information for data contained in a tensor. For sparse tensors it returns type information for contained non-zero values. It returns dense shape for sparse tensors.

TensorTypeAndShapeInfo

GetTensorMemoryInfo

@ByVal
 @Cast(value="Ort::ConstMemoryInfo*")
public MemoryInfoImpl GetTensorMemoryInfo()

This API returns information about the memory allocation used to hold data.

Non owning instance of MemoryInfo

GetStringTensorElement

public void GetStringTensorElement(@Cast(value="size_t")
                                   long buffer_length,
                                   @Cast(value="size_t")
                                   long element_index,
                                   Pointer buffer)

The API copies UTF-8 encoded bytes for the requested string element contained within a tensor or a sparse tensor into a provided buffer. Use GetStringTensorElementLength() to obtain the length of the buffer to allocate.

GetStringTensorElement

@StdString
public BytePointer GetStringTensorElement(@Cast(value="size_t")
                                                      long element_index)

Returns string tensor UTF-8 encoded string element. Use of this API is recommended over GetStringTensorElement() that takes void* buffer pointer.

std::string

GetStringTensorElementLength

@Cast(value="size_t")
public long GetStringTensorElementLength(@Cast(value="size_t")
                                                                long element_index)

The API returns a byte length of UTF-8 encoded string element contained in either a tensor or a spare tensor values.

byte length for the specified string element

GetSparseFormat

@Cast(value="OrtSparseFormat")
public int GetSparseFormat()

The API returns the sparse data format this OrtValue holds in a sparse tensor. If the sparse tensor was not fully constructed, i.e. Use*() or Fill*() API were not used the value returned is ORT_SPARSE_UNDEFINED.

Format enum

GetSparseTensorValuesTypeAndShapeInfo

@ByVal
public TensorTypeAndShapeInfo GetSparseTensorValuesTypeAndShapeInfo()

The API returns type and shape information for stored non-zero values of the sparse tensor. Use GetSparseTensorValues() to obtain values buffer pointer.

TensorTypeAndShapeInfo values information

GetSparseTensorIndicesTypeShapeInfo

@ByVal
public TensorTypeAndShapeInfo GetSparseTensorIndicesTypeShapeInfo(onnxruntime.OrtSparseIndicesFormat format)

The API returns type and shape information for the specified indices. Each supported indices have their own enum values even if a give format has more than one kind of indices. Use GetSparseTensorIndicesData() to obtain pointer to indices buffer.

enum requested type and shape information

GetSparseTensorIndicesTypeShapeInfo

@ByVal
public TensorTypeAndShapeInfo GetSparseTensorIndicesTypeShapeInfo(@Cast(value="OrtSparseIndicesFormat")
                                                                          int format)

IsSparseTensor

@Cast(value="bool")
public boolean IsSparseTensor()

Returns true if the OrtValue contains a sparse tensor