Struct neptune::poseidon::Poseidon

pub struct Poseidon<'a, E, Arity = U2> where
    E: ScalarEngine,
    Arity: Unsigned + Add<B1> + Add<UInt<UTerm, B1>>,
    Add1<Arity>: ArrayLength<E::Fr>,  {
    pub elements: GenericArray<E::Fr, Add1<Arity>>,
    // some fields omitted
}

The Poseidon structure will accept a number of inputs equal to the arity.

Fields

elements: GenericArray<E::Fr, Add1<Arity>>

the elements to permute

Methods

impl<'a, E, Arity> Poseidon<'a, E, Arity> where
    E: ScalarEngine,
    Arity: Unsigned + Add<B1> + Add<UInt<UTerm, B1>>,
    Add1<Arity>: ArrayLength<E::Fr>, 

pub fn new(constants: &'a PoseidonConstants<E, Arity>) -> Self

pub fn new_with_preimage(
    preimage: &[E::Fr],
    constants: &'a PoseidonConstants<E, Arity>
) -> Self

pub fn set_preimage(&mut self, preimage: &[E::Fr])

Replace the elements with the provided optional items.

Panics

Panics if the provided slice is bigger than the arity.

pub fn reset(&mut self)

Restore the initial state

pub fn input(&mut self, element: E::Fr) -> Result<usize, Error>

The returned usize represents the element position (within arity) for the input operation

pub fn hash_in_mode(&mut self, mode: HashMode) -> E::Fr

pub fn hash(&mut self) -> E::Fr

pub fn hash_correct(&mut self) -> E::Fr

The number of rounds is divided into two equal parts for the full rounds, plus the partial rounds.

The returned element is the second poseidon element, the first is the arity tag.

pub fn hash_optimized_dynamic(&mut self) -> E::Fr

pub fn hash_optimized_static(&mut self) -> E::Fr

pub fn full_round(&mut self)

pub fn full_round_dynamic(
    &mut self,
    add_current_round_keys: bool,
    absorb_next_round_keys: bool
)

pub fn partial_round(&mut self)

The partial round is the same as the full round, with the difference that we apply the S-Box only to the first bitflags poseidon leaf.

pub fn partial_round_dynamic(&mut self)

Trait Implementations

impl<'a, E: Clone, Arity: Clone> Clone for Poseidon<'a, E, Arity> where
    E: ScalarEngine,
    Arity: Unsigned + Add<B1> + Add<UInt<UTerm, B1>>,
    Add1<Arity>: ArrayLength<E::Fr>,
    E::Fr: Clone, 

fn clone(&self) -> Poseidon<'a, E, Arity>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, E: Debug, Arity: Debug> Debug for Poseidon<'a, E, Arity> where
    E: ScalarEngine,
    Arity: Unsigned + Add<B1> + Add<UInt<UTerm, B1>>,
    Add1<Arity>: ArrayLength<E::Fr>,
    E::Fr: Debug, 

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

Formats the value using the given formatter.

impl<'a, E: PartialEq, Arity: PartialEq> PartialEq<Poseidon<'a, E, Arity>> for Poseidon<'a, E, Arity> where
    E: ScalarEngine,
    Arity: Unsigned + Add<B1> + Add<UInt<UTerm, B1>>,
    Add1<Arity>: ArrayLength<E::Fr>,
    E::Fr: PartialEq, 

fn eq(&self, other: &Poseidon<'a, E, Arity>) -> bool

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

fn ne(&self, other: &Poseidon<'a, E, Arity>) -> bool

This method tests for !=.

impl<'a, E, Arity> StructuralPartialEq for Poseidon<'a, E, Arity> where
    E: ScalarEngine,
    Arity: Unsigned + Add<B1> + Add<UInt<UTerm, B1>>,
    Add1<Arity>: ArrayLength<E::Fr>,