Skip to main content

InputSignatureEntry

Struct InputSignatureEntry 

Source
pub struct InputSignatureEntry { /* private fields */ }
Expand description

Value-free metadata signature for a tensor input.

§Examples

use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::Placement;

let entry = InputSignatureEntry::new(
    DType::F64,
    [2_usize].into_iter().collect(),
    Placement::default(),
    LayoutClass::new("tenferro.layout.strided")?,
    [1_isize].into_iter().collect(),
    Some(3),
)?;
assert_eq!(entry.dtype(), DType::F64);

Implementations§

Source§

impl InputSignatureEntry

Source

pub fn new( dtype: DType, shape: ShapeVec, placement: Placement, layout_class: LayoutClass, strides: StrideVec, alignment_log2: Option<u8>, ) -> Result<Self, InputSignatureError>

Build one value-free input signature entry.

§Examples
use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::Placement;

let entry = InputSignatureEntry::new(
    DType::I32,
    [4_usize].into_iter().collect(),
    Placement::default(),
    LayoutClass::new("tenferro.layout.compact")?,
    [1_isize].into_iter().collect(),
    None,
)?;
assert_eq!(entry.shape(), &[4]);
§Errors

Returns InputSignatureError::ShapeStrideRankMismatch when shape and stride ranks differ, or InputSignatureError::InvalidAlignmentClass when alignment_log2 is outside the finite usize alignment lattice.

Source

pub fn dtype(&self) -> DType

Return the dtype component.

§Examples
use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::Placement;

let entry = InputSignatureEntry::new(
    DType::Bool,
    [1_usize].into_iter().collect(),
    Placement::default(),
    LayoutClass::new("tenferro.layout.strided")?,
    [1_isize].into_iter().collect(),
    None,
)?;
assert_eq!(entry.dtype(), DType::Bool);
Source

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

Return the shape component.

§Examples
use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::Placement;

let entry = InputSignatureEntry::new(
    DType::F64,
    [2_usize, 3].into_iter().collect(),
    Placement::default(),
    LayoutClass::new("tenferro.layout.strided")?,
    [1_isize, 2].into_iter().collect(),
    None,
)?;
assert_eq!(entry.shape(), &[2, 3]);
Source

pub fn placement(&self) -> &Placement

Return the placement metadata component.

§Examples
use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::{MemoryKind, Placement};

let entry = InputSignatureEntry::new(
    DType::F64,
    [1_usize].into_iter().collect(),
    Placement::default(),
    LayoutClass::new("tenferro.layout.strided")?,
    [1_isize].into_iter().collect(),
    None,
)?;
assert_eq!(entry.placement().memory_kind, MemoryKind::UnpinnedHost);
Source

pub fn layout_class(&self) -> &LayoutClass

Return the layout class component.

§Examples
use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::Placement;

let layout = LayoutClass::new("tenferro.layout.strided")?;
let entry = InputSignatureEntry::new(
    DType::F64,
    [1_usize].into_iter().collect(),
    Placement::default(),
    layout.clone(),
    [1_isize].into_iter().collect(),
    None,
)?;
assert_eq!(entry.layout_class(), &layout);
Source

pub fn strides(&self) -> &[isize]

Return the stride metadata component.

§Examples
use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::Placement;

let entry = InputSignatureEntry::new(
    DType::F64,
    [2_usize].into_iter().collect(),
    Placement::default(),
    LayoutClass::new("tenferro.layout.strided")?,
    [2_isize].into_iter().collect(),
    None,
)?;
assert_eq!(entry.strides(), &[2]);
Source

pub fn alignment_log2(&self) -> Option<u8>

Return the known alignment class, if available.

§Examples
use tenferro_runtime::{DType, InputSignatureEntry, LayoutClass};
use tenferro_tensor::Placement;

let entry = InputSignatureEntry::new(
    DType::F64,
    [1_usize].into_iter().collect(),
    Placement::default(),
    LayoutClass::new("tenferro.layout.strided")?,
    [1_isize].into_iter().collect(),
    Some(3),
)?;
assert_eq!(entry.alignment_log2(), Some(3));

Trait Implementations§

Source§

impl Clone for InputSignatureEntry

Source§

fn clone(&self) -> InputSignatureEntry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InputSignatureEntry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for InputSignatureEntry

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for InputSignatureEntry

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for InputSignatureEntry

Source§

impl StructuralPartialEq for InputSignatureEntry

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,

§

impl<T> MaybeSync for T
where T: Sync,