Struct tvm::runtime::NDArray

pub struct NDArray(_);

Implementations

impl NDArray

pub fn as_dltensor(&self) -> &DLTensor

pub fn is_view(&self) -> bool

pub fn shape(&self) -> &[i64]

Returns the shape of the NDArray.

pub fn shape_usize(&self) -> Cow<'_, [usize]>

Returns the shape of the NDArray as a &usize

On 64-bit platforms, this is zero-cost and uses the shape from the DLTensor. On other platforms, this copies into a buffer.

pub fn strides(&self) -> Option<&[i64]>

Returns the strides of the underlying NDArray.

pub fn strides_usize(&self) -> Option<Cow<'_, [usize]>>

Returns the strides of the NDArray as a &usize

On 64-bit platforms, this is zero-cost and uses the strides from the DLTensor. On other platforms, this copies into a buffer.

pub fn is_empty(&self) -> bool

Returns true if the tensor is empty

pub fn len(&self) -> usize

Returns the total number of entries of the NDArray.

pub fn size(&self) -> usize

Returns the total bytes taken up by the data. This is equal to nd.len() * nd.dtype().itemsize()

pub fn device(&self) -> Device

Returns the device which the NDArray was defined.

pub fn dtype(&self) -> DataType

Returns the type of the entries of the NDArray.

pub fn ndim(&self) -> usize

Returns the number of dimensions of the NDArray.

pub fn is_contiguous(&self) -> bool

Shows whether the underlying ndarray is contiguous in memory or not.

pub fn byte_offset(&self) -> isize

pub fn to_vec<T>(&self) -> Result<Vec<T, Global>, NDArrayError>

Flattens the NDArray to a Vec of the same type in cpu.

Example

let mut shape = [4];
let mut data = vec![1i32, 2, 3, 4];
let dev = Device::cpu(0);
let mut ndarray = NDArray::empty(&mut shape, dev, DataType::from_str("int32").unwrap());
ndarray.copy_from_buffer(&mut data);
assert_eq!(ndarray.shape(), shape);
assert_eq!(ndarray.to_vec::<i32>().unwrap(), data);

pub fn to_bytearray(&self) -> Result<ByteArray, NDArrayError>

Converts the NDArray to ByteArray.

pub fn copy_from_buffer<T>(&mut self, data: &[T]) where
    T: Num32, 

Creates an NDArray from a mutable buffer of types i32, u32 or f32 in cpu.

Example

let shape = &mut [2];
let mut data = vec![1f32, 2.0];
let dev = Device::cpu(0);
let mut ndarray = NDArray::empty(shape, dev, DataType::from_str("int32").unwrap());
ndarray.copy_from_buffer(&mut data);

Note: if something goes wrong during the copy, it will panic from TVM side. See TVMArrayCopyFromBytes in include/tvm/runtime/c_runtime_api.h.

pub fn copy_to_buffer<T>(&self, data: &mut [T])

pub fn fill_from_iter<T, I>(&mut self, iter: I) where
    T: Num32,
    I: ExactSizeIterator<Item = T>, 

pub fn copy_to_ndarray(&self, target: NDArray) -> Result<NDArray, NDArrayError>

Copies the NDArray to another target NDArray.

pub fn copy_to_device(&self, target: &Device) -> Result<NDArray, NDArrayError>

Copies the NDArray to a target device.

pub fn from_rust_ndarray<T>(
    input_nd: &ArrayBase<OwnedRepr<T>, Dim<IxDynImpl>>,
    dev: Device,
    dtype: DataType
) -> Result<NDArray, NDArrayError> where
    T: Num32 + Copy, 

Converts a Rust’s ndarray to TVM NDArray.

pub fn empty(shape: &[i64], dev: Device, dtype: DataType) -> NDArray

Allocates and creates an empty NDArray given the shape, device and dtype.

pub fn zeroed(self) -> NDArray

Trait Implementations

impl Clone for NDArray

pub fn clone(&self) -> NDArray

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NDArray

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for NDArray

type Target = NDArrayContainer

The resulting type after dereferencing.

pub fn deref(&self) -> &<NDArray as Deref>::Target

Dereferences the value.

impl<'a> From<&'a NDArray> for ArgValue<'a>

pub fn from(object_ref: &'a NDArray) -> ArgValue<'a>

Performs the conversion.

impl From<NDArray> for RetValue

pub fn from(object_ref: NDArray) -> RetValue

Performs the conversion.

impl From<NDArrayContainer> for NDArray

pub fn from(payload: NDArrayContainer) -> NDArray

Performs the conversion.

impl From<ObjectPtr<NDArrayContainer>> for NDArray

pub fn from(ptr: ObjectPtr<NDArrayContainer>) -> NDArray

Performs the conversion.

impl Hash for NDArray

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IsObjectRef for NDArray

type Object = NDArrayContainer

pub fn as_ptr(&self) -> Option<&ObjectPtr<<NDArray as IsObjectRef>::Object>>

pub fn into_ptr(self) -> Option<ObjectPtr<<NDArray as IsObjectRef>::Object>>

pub fn from_ptr(
    object_ptr: Option<ObjectPtr<<NDArray as IsObjectRef>::Object>>
) -> NDArray

fn null() -> Self

fn into_arg_value(&'a self) -> ArgValue<'a>

fn from_arg_value(arg_value: ArgValue<'a>) -> Result<Self, Error>

fn into_ret_value(self) -> RetValue

fn from_ret_value(ret_value: RetValue) -> Result<Self, Error>

fn upcast<U>(self) -> U where
    U: IsObjectRef,
    Self::Object: AsRef<<U as IsObjectRef>::Object>, 

fn downcast<U>(self) -> Result<U, Error> where
    U: IsObjectRef,
    <U as IsObjectRef>::Object: AsRef<Self::Object>, 

impl PartialEq<NDArray> for NDArray

pub fn eq(&self, other: &NDArray) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> TryFrom<ArgValue<'a>> for NDArray

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(arg_value: ArgValue<'a>) -> Result<NDArray, Error>

Performs the conversion.

impl TryFrom<RetValue> for NDArray

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(ret_val: RetValue) -> Result<NDArray, Error>

Performs the conversion.

impl Eq for NDArray