Struct SharedBatchSizes

pub struct SharedBatchSizes { /* private fields */ }

Slice of a reference-counted batch sizes vector.

The value of the ith index of the batch sizes vector is the number of sequences with length at least i + 1. It is the number of index-i steps that appear in the packed tensor.

Implementations

impl SharedBatchSizes

pub fn from_batch_sizes<I: IntoIterator<Item = usize>>( batch_sizes: I, ) -> Result<Self, PackingError>

Construct from an iterator of monotonic decreasing batch sizes.

Returns an error if any batch size is greater than the previous batch size.

pub fn from_sorted_sequence_lengths<I: IntoIterator<Item = usize>>( lengths: I, ) -> Result<Self, PackingError>

Construct from an iterator of monotonic decreasing sequence lengths.

Returns an error if any length is greater than the previous length.

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

View batch sizes as a slice

pub fn tensor(&self) -> Tensor

Batch size as an i64 [Tensor]. The underlying data is cached and shared between calls.

pub fn len(&self) -> usize

The total number of elements across all sequences represented by this structure.

pub fn is_empty(&self) -> bool

Whether the total number of elements across all sequences is zero.

pub const fn trim(self, n: usize) -> Self

Batch sizes resulting from removing n values from each sequence.

Trait Implementations

impl AsRef<[i64]> for SharedBatchSizes

fn as_ref(&self) -> &[i64]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SharedBatchSizes

fn clone(&self) -> SharedBatchSizes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedBatchSizes

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SharedBatchSizes

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: AsRef<[i64]>> PartialEq<T> for SharedBatchSizes

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SharedBatchSizes

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SharedBatchSizes