Struct neptune::poseidon::Poseidon[−][src]

pub struct Poseidon<'a, E, A = U2> where
    E: ScalarEngine,
    A: Arity<E::Fr>,  {
    pub elements: GenericArray<E::Fr, A::ConstantsSize>,
    // some fields omitted
}
Expand description

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

Fields

elements: GenericArray<E::Fr, A::ConstantsSize>

the elements to permute

Implementations

impl<'a, E, A> Poseidon<'a, E, A> where
    E: ScalarEngine,
    A: Arity<E::Fr>, [src]

pub fn new(constants: &'a PoseidonConstants<E, A>) -> Self[src]

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

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

Replace the elements with the provided optional items.

Panics

Panics if the provided slice is bigger than the arity.

pub fn reset(&mut self)[src]

Restore the initial state

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

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

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

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

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

Trait Implementations

impl<'a, E: Clone, A: Clone> Clone for Poseidon<'a, E, A> where
    E: ScalarEngine,
    A: Arity<E::Fr>,
    E::Fr: Clone,
    A::ConstantsSize: Clone, [src]

fn clone(&self) -> Poseidon<'a, E, A>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'a, E: Debug, A: Debug> Debug for Poseidon<'a, E, A> where
    E: ScalarEngine,
    A: Arity<E::Fr>,
    E::Fr: Debug,
    A::ConstantsSize: Debug, [src]

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

Formats the value using the given formatter. Read more

impl<'a, E: PartialEq, A: PartialEq> PartialEq<Poseidon<'a, E, A>> for Poseidon<'a, E, A> where
    E: ScalarEngine,
    A: Arity<E::Fr>,
    E::Fr: PartialEq,
    A::ConstantsSize: PartialEq, [src]

fn eq(&self, other: &Poseidon<'a, E, A>) -> bool[src]

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

fn ne(&self, other: &Poseidon<'a, E, A>) -> bool[src]

This method tests for !=.

impl<'a, E, A> StructuralPartialEq for Poseidon<'a, E, A> where
    E: ScalarEngine,
    A: Arity<E::Fr>, [src]

Auto Trait Implementations

impl<'a, E, A> RefUnwindSafe for Poseidon<'a, E, A> where
    A: RefUnwindSafe,
    E: RefUnwindSafe,
    <<A as Arity<<E as ScalarEngine>::Fr>>::ConstantsSize as ArrayLength<<E as ScalarEngine>::Fr>>::ArrayType: RefUnwindSafe,
    <E as ScalarEngine>::Fr: RefUnwindSafe, 

impl<'a, E, A> Send for Poseidon<'a, E, A> where
    A: Sync,
    E: Send, 

impl<'a, E, A> Sync for Poseidon<'a, E, A> where
    A: Sync,
    E: Sync, 

impl<'a, E, A> Unpin for Poseidon<'a, E, A> where
    E: Unpin,
    <<A as Arity<<E as ScalarEngine>::Fr>>::ConstantsSize as ArrayLength<<E as ScalarEngine>::Fr>>::ArrayType: Unpin, 

impl<'a, E, A> UnwindSafe for Poseidon<'a, E, A> where
    A: RefUnwindSafe,
    E: UnwindSafe,
    <<A as Arity<<E as ScalarEngine>::Fr>>::ConstantsSize as ArrayLength<<E as ScalarEngine>::Fr>>::ArrayType: UnwindSafe,
    <E as ScalarEngine>::Fr: RefUnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V