Enum Tensor 

pub enum Tensor<T>
where
    T: Num + Clone + Debug + Send + Sync,
{
    Dma(DmaTensor<T>),
    Shm(ShmTensor<T>),
    Mem(MemTensor<T>),
}

Variants

Dma(DmaTensor<T>)

Shm(ShmTensor<T>)

Mem(MemTensor<T>)

Implementations

impl<T> Tensor<T>

where T: Num + Clone + Debug + Send + Sync,

pub fn new( shape: &[usize], memory: Option<TensorMemory>, name: Option<&str>, ) -> Result<Self>

Create a new tensor with the given shape, memory type, and optional name. If no name is given, a random name will be generated. If no memory type is given, the best available memory type will be chosen based on the platform and environment variables.

On Linux platforms, the order of preference is: Dma -> Shm -> Mem. On other Unix platforms (macOS), the order is: Shm -> Mem. On non-Unix platforms, only Mem is available.

Environment Variables

• EDGEFIRST_TENSOR_FORCE_MEM: If set to a non-zero and non-false value, forces the use of regular system memory allocation (TensorMemory::Mem) regardless of platform capabilities.

Example

use edgefirst_tensor::{Error, Tensor, TensorMemory, TensorTrait};
let tensor = Tensor::<f32>::new(&[2, 3, 4], Some(TensorMemory::Mem), Some("test_tensor"))?;
assert_eq!(tensor.memory(), TensorMemory::Mem);
assert_eq!(tensor.name(), "test_tensor");

Trait Implementations

impl<T> Debug for Tensor<T>

where T: Num + Clone + Debug + Send + Sync + Debug,

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

Formats the value using the given formatter.

impl<T> TensorTrait<T> for Tensor<T>

where T: Num + Clone + Debug + Send + Sync,

fn from_fd(fd: OwnedFd, shape: &[usize], name: Option<&str>) -> Result<Self>

Create a new tensor using the given file descriptor, shape, and optional name. If no name is given, a random name will be generated.

On Linux: Inspects the file descriptor to determine the appropriate tensor type (Dma or Shm) based on the device major and minor numbers. On other Unix (macOS): Always creates SHM tensor.

fn new(shape: &[usize], name: Option<&str>) -> Result<Self>

Create a new tensor with the given shape and optional name. If no name is given, a random name will be generated.

fn clone_fd(&self) -> Result<OwnedFd>

Clone the file descriptor associated with this tensor.

fn memory(&self) -> TensorMemory

Get the memory type of this tensor.

fn name(&self) -> String

Get the name of this tensor.

fn shape(&self) -> &[usize]

Get the shape of this tensor.

fn reshape(&mut self, shape: &[usize]) -> Result<()>

Reshape this tensor to the given shape. The total number of elements must remain the same.

fn map(&self) -> Result<TensorMap<T>>

Map the tensor into memory and return a TensorMap for accessing the data.

fn len(&self) -> usize

Get the number of elements in this tensor.

fn is_empty(&self) -> bool

Check if the tensor is empty.

fn size(&self) -> usize

Get the size in bytes of this tensor.