Enum Buffer 

pub enum Buffer {
    Booleans(Vec<bool>),
    Integers(IntBuf),
    Floats(FloatBuf),
    Complexes(ComplexBuf),
    Characters(Vec<char>),
}

Items of one element type.

Variants

Booleans(Vec<bool>)

Integers(IntBuf)

Floats(FloatBuf)

Complexes(ComplexBuf)

Characters(Vec<char>)

Implementations

impl Buffer

pub fn with_capacity(dtype: DType, capacity: usize) -> Self

An empty buffer of dtype, with room for capacity items.

pub fn view(&self) -> View<'_>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn dtype(&self) -> DType

pub fn capacity(&self) -> usize

pub fn reserve(&mut self, additional: usize)

Reserve room for additional items after the current length.

pub fn as_mut_ptr(&mut self) -> *mut u8

The address of the first item, for writing through, as an exported buffer may.

pub fn extend_from(&mut self, source: View<'_>, range: Range<usize>) -> bool

Copies range of source when it has this buffer’s dtype, and gives whether it could. Integers of another width don’t copy.

pub unsafe fn set_len(&mut self, n: usize)

Sets the length to n after a writer outside Rust, such as compiled code, filled the first n items through as_mut_ptr.

Safety

n is at most the capacity, and the first n items are initialized.

pub fn clear(&mut self)

Removes the items, keeping the allocation.

impl Buffer

pub fn nonzero(view: View<'_>) -> Vec<usize>

Flattened positions whose item differs from its type’s fill (zero, false or a space).

pub fn any_fill(view: View<'_>) -> bool

Whether any item equals its type’s fill: zero, false or a space.

pub fn same(view: View<'_>) -> bool

Whether every item has the first item’s bits, as an array of one repeated value does: 0 and ¯0 differ, and a NaN matches only a NaN with its bits. An empty view gives true.

pub fn walked(view: View<'_>, base: usize, steps: &[Steps], n: usize) -> Self

Copies the first n items of a structural walk from base, using the type’s fill for missing positions and whole-slice copies for contiguous runs. n can be shorter than the walk, as it is for a view whose mapping reaches past its own items.

pub fn ordered(self, order: Option<Vec<Steps>>) -> Self

The items in the order that order reads them, or the buffer itself without one. Kernel::fold_read gives such an order with totals that stay in their source’s order.

pub fn copied(view: View<'_>, range: Range<usize>) -> Self

A new buffer holding the items of view in range.

pub fn gathered<I: IndexValue>(view: View<'_>, indices: &[I]) -> Self

The items of view at indices, as take reads them: a negative index counts back from the end.

pub fn cast(view: View<'_>, dtype: DType) -> Result<Self, Error>

The items of view at dtype. Matching dtypes copy. Otherwise each item converts as Source reads it, and conversions to a narrower dtype follow these rules. A float converts to an integer by truncating toward zero. A value that doesn’t fit its target gives an Overflow error, as do NaN, infinities and anything but exactly 0 or 1 for Booleans. A complex number converts to a real dtype only when its imaginary part is zero, and otherwise gives a Domain error. Characters convert only to characters.

pub fn kept(view: View<'_>, dtype: DType) -> Result<Self, Error>

The items of view at dtype, where every item keeps its value. Items convert as Buffer::cast converts them, and a float that becomes a Boolean or an integer must be whole. A float rounds to a float of another width. A Domain error where an item doesn’t keep its value.

pub fn cast_mapped( view: View<'_>, mapping: &Mapping, n: usize, dtype: DType, ) -> Result<Self, Error>

Shared conversion dispatch for compact and mapped logical items. Unselected storage never participates in checked conversion.

impl Buffer

pub fn floored( view: View<'_>, dtype: DType, t: impl Tolerant, ) -> Result<Self, Error>

The items of view as integers of dtype, as BPL’s ₓ marks and Python’s astype convert them: a float takes its floor within t and saturates at the range, NaN giving 0 (crate::convert::floored); an integer wraps to the width; a Boolean gives 0 or 1. Other items and targets convert as Buffer::cast converts them.

pub fn cast_results( view: View<'_>, dtype: DType, checked: bool, ) -> Result<Self, Error>

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl IndexSource for Buffer

fn view(&self) -> View<'_>

The index values, as Booleans or integers (IndexValue).

impl PartialEq for Buffer

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

Equality operator ==.

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

Inequality operator !=.