binius_utils::array_2d

Struct Array2D

source
pub struct Array2D<T, Data: Deref<Target = [T]> = Vec<T>> { /* private fields */ }
Expand description

2D array with row-major layout.

Implementations§

source§

impl<T: Default + Clone> Array2D<T>

source

pub fn new(rows: usize, cols: usize) -> Self

Create a new 2D array of the given size initialized with default values.

source

pub fn zeroes(rows: usize, cols: usize) -> Self
where T: Zeroable,

Create a new 2D array of the given size initialized with zeroes.

source§

impl<T, Data: Deref<Target = [T]>> Array2D<T, Data>

source

pub fn rows(&self) -> usize

Returns the number of rows in the array.

source

pub fn cols(&self) -> usize

Returns the number of columns in the array.

source

pub fn get_row(&self, i: usize) -> &[T]

Returns the row at the given index.

source

pub fn iter_rows(&self) -> impl Iterator<Item = &[T]>

Returns an iterator over the rows of the array.

source

pub unsafe fn get_unchecked(&self, i: usize, j: usize) -> &T

Return the element at the given row and column without bounds checking.

§Safety

The caller must ensure that i and j are less than the number of rows and columns respectively.

source

pub fn reshape(&self, rows: usize, cols: usize) -> Option<Array2D<T, &[T]>>

View of the array in a different shape, underlying elements stay the same.

source§

impl<T, Data: DerefMut<Target = [T]>> Array2D<T, Data>

source

pub fn get_row_mut(&mut self, i: usize) -> &mut [T]

Returns the mutable row at the given index.

source

pub unsafe fn get_unchecked_mut(&mut self, i: usize, j: usize) -> &mut T

Return the mutable element at the given row and column without bounds checking.

§Safety

The caller must ensure that i and j are less than the number of rows and columns respectively.

source

pub fn reshape_mut( &mut self, rows: usize, cols: usize, ) -> Option<Array2D<T, &mut [T]>>

Mutable view of the array in a different shape, underlying elements stay the same.

source§

impl<T: Default + Clone + AddAssign, Data: Deref<Target = [T]>> Array2D<T, Data>

source

pub fn sum_rows(&self) -> Vec<T>

Returns the sum of the elements in each row.

Trait Implementations§

source§

impl<T: Debug, Data: Debug + Deref<Target = [T]>> Debug for Array2D<T, Data>

source§

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

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

impl<T, Data: Deref<Target = [T]>> Index<(usize, usize)> for Array2D<T, Data>

source§

type Output = T

The returned type after indexing.
source§

fn index(&self, (i, j): (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
source§

impl<T, Data: DerefMut<Target = [T]>> IndexMut<(usize, usize)> for Array2D<T, Data>

source§

fn index_mut(&mut self, (i, j): (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more

Auto Trait Implementations§

§

impl<T, Data> Freeze for Array2D<T, Data>
where Data: Freeze,

§

impl<T, Data> RefUnwindSafe for Array2D<T, Data>
where Data: RefUnwindSafe,

§

impl<T, Data> Send for Array2D<T, Data>
where Data: Send,

§

impl<T, Data> Sync for Array2D<T, Data>
where Data: Sync,

§

impl<T, Data> Unpin for Array2D<T, Data>
where Data: Unpin,

§

impl<T, Data> UnwindSafe for Array2D<T, Data>
where Data: UnwindSafe,

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more