Struct StateMatrix

pub struct StateMatrix<T> { /* private fields */ }

The state of the permutation. Consists of 5x5 lanes.

Indexing is defined as mod 5.

See section 1.6 of the keccak specification for more details.

Implementations

impl<T> StateMatrix<T>

pub fn from_values(v: [T; 25]) -> Self

Creates a new state matrix from an array of values stored in row-major order.

pub fn from_fn<F>(f: F) -> Self

where F: FnMut((usize, usize)) -> T,

Creates a new state matrix from a function that takes a coordinate and returns a value.

pub fn try_from_fn<F, E>(f: F) -> Result<Self, E>

where F: FnMut((usize, usize)) -> Result<T, E>,

Creates a new state matrix from a function that takes a coordinate and returns a value or an error.

pub fn as_inner(&self) -> &[T; 25]

Returns the raw array of values stored in row-major order.

Trait Implementations

impl<T: Clone> Clone for StateMatrix<T>

fn clone(&self) -> StateMatrix<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + UpperHex> Debug for StateMatrix<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for StateMatrix<T>

fn default() -> StateMatrix<T>

Returns the “default value” for a type.

impl<T> Index<(usize, usize)> for StateMatrix<T>

type Output = T

The returned type after indexing.

fn index(&self, (x, y): (usize, usize)) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, usize)> for StateMatrix<T>

fn index_mut(&mut self, (x, y): (usize, usize)) -> &mut T

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

impl<T: PartialEq> PartialEq for StateMatrix<T>

fn eq(&self, other: &StateMatrix<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<T: Eq> Eq for StateMatrix<T>

impl<T> StructuralPartialEq for StateMatrix<T>