DLTensor

Struct DLTensor 

Source
#[repr(C)]
pub struct DLTensor { pub data: *mut c_void, pub device: DLDevice, pub ndim: i32, pub dtype: DLDataType, pub shape: *mut i64, pub strides: *mut i64, pub byte_offset: u64, }
Expand description

\brief Plain C Tensor object, does not manage memory.

Fields§

§data: *mut c_void

\brief The data pointer points to the allocated data. This will be CUDA device pointer or cl_mem handle in OpenCL. It may be opaque on some device types. This pointer is always aligned to 256 bytes as in CUDA. The byte_offset field should be used to point to the beginning of the data.

Note that as of Nov 2021, multiply libraries (CuPy, PyTorch, TensorFlow, TVM, perhaps others) do not adhere to this 256 byte aligment requirement on CPU/CUDA/ROCm, and always use byte_offset=0. This must be fixed (after which this note will be updated); at the moment it is recommended to not rely on the data pointer being correctly aligned.

For given DLTensor, the size of memory required to store the contents of data is calculated as follows:

\code{.c} static inline size_t GetDataSize(const DLTensor* t) { size_t size = 1; for (tvm_index_t i = 0; i < t->ndim; ++i) { size *= t->shape[i]; } size *= (t->dtype.bits * t->dtype.lanes + 7) / 8; return size; } \endcode

Note that if the tensor is of size zero, then the data pointer should be set to NULL.

§device: DLDevice

\brief The device of the tensor

§ndim: i32

\brief Number of dimensions

§dtype: DLDataType

\brief The data type of the pointer

§shape: *mut i64

\brief The shape of the tensor

§strides: *mut i64

\brief strides of the tensor (in number of elements, not bytes) can be NULL, indicating tensor is compact and row-majored.

§byte_offset: u64

\brief The offset in bytes to the beginning pointer to data

Trait Implementations§

Source§

impl CopyNew for DLTensor

Source§

unsafe fn copy_new(other: &DLTensor, this: Pin<&mut MaybeUninit<DLTensor>>)

Synthesized copy constructor.

Source§

impl Drop for DLTensor

Source§

fn drop(self: &mut DLTensor)

Synthesized destructor.

Source§

impl ExternType for DLTensor

Source§

type Id = (D, L, T, e, n, s, o, r)

A type-level representation of the type’s C++ namespace and type name. Read more
Source§

type Kind = Trivial

Source§

impl MakeCppStorage for DLTensor

Source§

unsafe fn allocate_uninitialized_cpp_storage() -> *mut DLTensor

Allocates heap space for this type in C++ and return a pointer to that space, but do not initialize that space (i.e. do not yet call a constructor). Read more
Source§

unsafe fn free_uninitialized_cpp_storage(arg0: *mut DLTensor)

Frees a C++ allocation which has not yet had a constructor called. Read more
Source§

impl MoveNew for DLTensor

Source§

unsafe fn move_new( other: Pin<MoveRef<'_, DLTensor>>, this: Pin<&mut MaybeUninit<DLTensor>>, )

Synthesized move constructor.

Source§

impl SharedPtrTarget for DLTensor

Source§

impl UniquePtrTarget for DLTensor

Source§

impl VectorElement for DLTensor

Source§

impl WeakPtrTarget for DLTensor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithinBoxTrivial for T
where T: ExternType<Kind = Trivial> + Unpin,

Source§

fn within_box(self) -> Pin<Box<T>>

Source§

impl<T> WithinUniquePtrTrivial for T
where T: UniquePtrTarget + ExternType<Kind = Trivial> + Unpin,