Struct container_broadcast::broadcast::OffsetBroadcast

pub struct OffsetBroadcast<'a, T: Broadcastable<N>, const N: usize> { /* fields omitted */ }

Return type of offset_mod.

Trait Implementations

impl<'a, T: Broadcastable<N>, const N: usize> Broadcastable<N> for OffsetBroadcast<'a, T, N>

type Element = T::Element

fn bget(&self, index: [usize; N]) -> Option<T::Element>

This should return none iff the default inbounds method returns false.

fn mod_bget(&self, index: [isize; DIM]) -> Self::Element

Takes indices modulo size. Useful for periodic shifts of indices.

fn feedto(
    &self,
    receiver: &mut impl BroadcastReceiver<DIM, Element = Self::Element>
) -> Option<()>

Writes the contents of the Broadcastable to a receiver, such as an actual (multidimensional) array.

fn lazy_updim<const NEWDIM: usize>(
    &self,
    size: [usize; NEWDIM]
) -> LazyUpdim<'_, Self, DIM, NEWDIM>

Returns an object with the provided size. If NEWDIM > Self::DIM, the additional indices are ignored. All entries of size input must be either equal to the size of input, except for entries where the original size was 1.

fn reshaped<const NEWDIM: usize>(
    self,
    size: [usize; NEWDIM]
) -> ReShaped<Self, NEWDIM, DIM>

The main way to create multidimensional arrays with this crate, but can resize any broadcastable. Resized broadcastables must have the same number of elements as the old one. Preserves iteration order. Reshapes a broadcastable by linearizing and delinearizing indices.

fn mapindex<F: Fn([usize; M], [usize; M]) -> [usize; DIM], const M: usize>(
    &self,
    indexclosure: F,
    sizeclosure: impl Fn([usize; DIM]) -> [usize; M]
) -> MapIndex<'_, Self, F, DIM, M>

Provides a more flexible but less safe way to reshape a broadcastable. Useful for slicing and dicing arrays and broadcastables, taking diagonals, etc etc.

fn offset_mod(&self, offset: [isize; DIM]) -> OffsetBroadcast<'_, Self, DIM>

Returns a new broadcast which is periodically offset by offset.

fn bmap<T, F: Fn(Self::Element) -> T>(
    &self,
    foo: F
) -> BMap<'_, T, Self, F, DIM>

Elements of returned broadcastable are the output of the provided closure, applied to the input broadcastable.

fn bcloned(self) -> BCloned<Self, DIM>

For inputs whose elements are references, clones them.

fn broadcast2<'a, 'b, T: Broadcastable<N>, const N: usize>(
    &'a self,
    foo: &'b T
) -> Broadcast2<LazyUpdim<'a, Self, DIM, DIM>, LazyUpdim<'b, T, N, DIM>, DIM>

Unique operation not found in Iterators. If the dimensions of the two broadcastable, zips them. If not, will lazy_updim all inputs to the same size. As such, can also provide cartesian or tensor products depending on input. NEW CONSTRAINT IN v0.0.6: N must be smaller than DIM, CHECKED AT RUNTIME. The argument with higher Self::DIM must be first. This is partly to eliminate use of nightly features, and because the Rust type system often cannot prove equality.

fn bc_iter(&self) -> BroadcastIterator<'_, Self, DIM>

Takes a broadcastable and returns an iterator over its elements.

impl<'a, T: Clone + Broadcastable<N>, const N: usize> Clone for OffsetBroadcast<'a, T, N>

fn clone(&self) -> OffsetBroadcast<'a, T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Copy + Broadcastable<N>, const N: usize> Copy for OffsetBroadcast<'a, T, N>

impl<'b, 'a, T: Broadcastable<N>, const N: usize> IntoIterator for &'b OffsetBroadcast<'a, T, N>

type Item = T::Element

The type of the elements being iterated over.

type IntoIter = BroadcastIterator<'b, OffsetBroadcast<'a, T, N>, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Broadcastable<N>, const N: usize> TensorDimension for OffsetBroadcast<'a, T, N>

const DIM: usize

const ISSCALAR: bool

fn is_scalar(&self) -> bool

impl<'a, T: Broadcastable<N>, const N: usize> TensorSize<N> for OffsetBroadcast<'a, T, N>

fn size(&self) -> [usize; N]

fn inbounds(&self, index: [usize; DIM]) -> bool

fn eachindex(&self) -> EachIndex<DIM>

Returns an iterator over all valid indices.

const VALIDDIMS: bool

If this is false, you have an invalid implementation.