Skip to main content

Poseidon1

Struct Poseidon1 

Source
pub struct Poseidon1<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> { /* private fields */ }
Expand description

The optimized Poseidon1 permutation.

Holds the pre-computed full and partial round layers and applies them in sequence: initial full rounds, then partial rounds, then terminal full rounds.

Implementations§

Source§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where F: PrimeField, FullRoundPerm: FullRoundLayerConstructor<F, WIDTH>, PartialRoundPerm: PartialRoundLayerConstructor<F, WIDTH>,

Source

pub fn new(raw: &Poseidon1Constants<F, WIDTH>) -> Self

Create a new optimized Poseidon1 from raw constants.

Internally computes the sparse matrix decomposition and the optimized round constants. This is the typical entry point.

Source

pub fn new_from_rng( half_num_full_rounds: usize, num_partial_rounds: usize, mds: &impl Permutation<[F; WIDTH]>, rng: &mut impl Rng, ) -> Self

Create a new Poseidon1 with random round constants and a given MDS permutation.

Builds the dense MDS matrix by applying the permutation to unit vectors, generates random round constants, and computes the sparse matrix decomposition.

Primarily useful for testing.

Trait Implementations§

Source§

impl<F: Clone, FullRoundPerm: Clone, PartialRoundPerm: Clone, const WIDTH: usize, const D: u64> Clone for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>

Source§

fn clone(&self) -> Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug, FullRoundPerm: Debug, PartialRoundPerm: Debug, const WIDTH: usize, const D: u64> Debug for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>

Source§

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

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

impl<F, A, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> Permutation<[A; WIDTH]> for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where F: PrimeField + InjectiveMonomial<D>, A: Algebra<F> + Sync + InjectiveMonomial<D>, FullRoundPerm: FullRoundLayer<A, WIDTH, D>, PartialRoundPerm: PartialRoundLayer<A, WIDTH, D>,

Source§

fn permute_mut(&self, state: &mut [A; WIDTH])

Source§

fn permute(&self, input: T) -> T

Source§

impl<F, A, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> CryptographicPermutation<[A; WIDTH]> for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where F: PrimeField + InjectiveMonomial<D>, A: Algebra<F> + Sync + InjectiveMonomial<D>, FullRoundPerm: FullRoundLayer<A, WIDTH, D>, PartialRoundPerm: PartialRoundLayer<A, WIDTH, D>,

Auto Trait Implementations§

§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> Freeze for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where FullRoundPerm: Freeze, PartialRoundPerm: Freeze,

§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> RefUnwindSafe for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where FullRoundPerm: RefUnwindSafe, PartialRoundPerm: RefUnwindSafe, F: RefUnwindSafe,

§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> Send for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where FullRoundPerm: Send, PartialRoundPerm: Send, F: Send,

§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> Sync for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where FullRoundPerm: Sync, PartialRoundPerm: Sync, F: Sync,

§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> Unpin for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where FullRoundPerm: Unpin, PartialRoundPerm: Unpin, F: Unpin,

§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> UnsafeUnpin for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where FullRoundPerm: UnsafeUnpin, PartialRoundPerm: UnsafeUnpin,

§

impl<F, FullRoundPerm, PartialRoundPerm, const WIDTH: usize, const D: u64> UnwindSafe for Poseidon1<F, FullRoundPerm, PartialRoundPerm, WIDTH, D>
where FullRoundPerm: UnwindSafe, PartialRoundPerm: UnwindSafe, F: 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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