Struct twenty_first::shared_math::tip5::Tip5

pub struct Tip5 {}

Implementations

impl Tip5

pub const fn offset_fermat_cube_map(x: u16) -> u16

pub fn trace(sponge: &mut Tip5State) -> [[BFieldElement; 16]; 6]

Functionally equivalent to permutation. Returns the trace of applying the permutation; that is, the initial state of the sponge as well as its state after each round.

pub fn hash_10(input: &[BFieldElement; 10]) -> [BFieldElement; 5]

hash_10 Hash 10 elements, or two digests. There is no padding because the input length is fixed.

Trait Implementations

impl AlgebraicHasher for Tip5

fn sample_scalars( state: &mut Self::SpongeState, num_elements: usize ) -> Vec<XFieldElement>

Produce num_elements random XFieldElement values.

• The randomness depends on state.

Since RATE is not divisible by EXTENSION_DEGREE, produce as many XFieldElement per squeeze as possible, and spill the remaining element(s). This causes some internal fragmentation, but it greatly simplifies building [AlgebraicHasher::sample_xfield()] on Triton VM.

fn hash_pair(left: &Digest, right: &Digest) -> Digest

Hash two Digests into one.

fn hash<T: BFieldCodec>(value: &T) -> Digest

Hash a value: &T to a Digest.

fn hash_varlen(input: &[BFieldElement]) -> Digest

Hash a variable-length sequence of BFieldElement.

fn sample_indices( state: &mut Self::SpongeState, upper_bound: u32, num_indices: usize ) -> Vec<u32>

Produce num_indices random integer values in the range [0, upper_bound).

impl BFieldCodec for Tip5

fn decode(sequence: &[BFieldElement]) -> Result<Box<Self>>

fn encode(&self) -> Vec<BFieldElement>

fn static_length() -> Option<usize>

Returns the length in number of BFieldElements if it is known at compile-time. Otherwise, None.

impl Clone for Tip5

fn clone(&self) -> Tip5

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tip5

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

Formats the value using the given formatter.

impl Default for Tip5

fn default() -> Tip5

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tip5

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GetSize for Tip5

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_size(&self) -> usize

Determines the total size of the object.

impl PartialEq<Tip5> for Tip5

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Tip5

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

Serialize this value into the given Serde serializer.

impl SpongeHasher for Tip5

const RATE: usize = 10usize

type SpongeState = Tip5State

fn init() -> Self::SpongeState

Initialize a sponge state

fn absorb(sponge: &mut Self::SpongeState, input: &[BFieldElement; 10])

Absorb an array of RATE field elements into the sponge’s state, mutating it.

fn squeeze(sponge: &mut Self::SpongeState) -> [BFieldElement; 10]

Squeeze an array of RATE field elements out from the sponge’s state, mutating it.

fn absorb_repeatedly<'a, I>(sponge: &mut Self::SpongeState, input: I)where I: Iterator<Item = &'a BFieldElement>,

Chunk input into arrays of RATE elements and repeatedly SpongeHasher::absorb().

impl Eq for Tip5

impl StructuralEq for Tip5

impl StructuralPartialEq for Tip5