Struct arkworks_utils::poseidon::PoseidonParameters

source · [−]

pub struct PoseidonParameters<F: PrimeField> {
    pub round_keys: Vec<F>,
    pub mds_matrix: Vec<Vec<F>>,
    pub full_rounds: u8,
    pub partial_rounds: u8,
    pub width: u8,
    pub sbox: PoseidonSbox,
}

Expand description

The Poseidon permutation.

Fields

round_keys: Vec<F>

The round key constants

mds_matrix: Vec<Vec<F>>

The MDS matrix to apply in the mix layer.

full_rounds: u8

Number of full SBox rounds

partial_rounds: u8

Number of partial rounds

width: u8

The size of the permutation, in field elements.

sbox: PoseidonSbox

The S-box to apply in the sub words layer.

Implementations

source

impl<F: PrimeField> PoseidonParameters<F>

source

pub fn new(
 round_keys: Vec<F>,
 mds_matrix: Vec<Vec<F>>,
 full_rounds: u8,
 partial_rounds: u8,
 width: u8,
 sbox: PoseidonSbox
) -> Self

source

pub fn generate<R: Rng>(_rng: &mut R) -> Self

source

pub fn create_mds<R: Rng>(_rng: &mut R) -> Vec<Vec<F>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

source

pub fn create_round_keys<R: Rng>(_rng: &mut R) -> Vec<F>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

source

pub fn to_bytes(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

source

pub fn from_bytes(bytes: &[u8 ]) -> Result<Self, Error>

Trait Implementations

source

impl<F: Clone + PrimeField> Clone for PoseidonParameters<F>

source

fn clone(&self) -> PoseidonParameters<F>

Returns a copy 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 + PrimeField> Debug for PoseidonParameters<F>

source

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

Formats the value using the given formatter. Read more

source

impl<F: Default + PrimeField> Default for PoseidonParameters<F>

source

fn default() -> PoseidonParameters<F>

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl<F> RefUnwindSafe for PoseidonParameters<F> where
F: RefUnwindSafe,

impl<F> Send for PoseidonParameters<F>

impl<F> Sync for PoseidonParameters<F>

impl<F> Unpin for PoseidonParameters<F> where
F: Unpin,

impl<F> UnwindSafe for PoseidonParameters<F> where
F: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

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

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V

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

Struct arkworks_utils::poseidon::PoseidonParameters

Fields

Implementations

impl<F: PrimeField> PoseidonParameters<F>

pub fn new( round_keys: Vec<F>, mds_matrix: Vec<Vec<F>>, full_rounds: u8, partial_rounds: u8, width: u8, sbox: PoseidonSbox) -> Self

pub fn generate<R: Rng>(_rng: &mut R) -> Self

pub fn create_mds<R: Rng>(_rng: &mut R) -> Vec<Vec<F>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn create_round_keys<R: Rng>(_rng: &mut R) -> Vec<F>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn to_bytes(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Trait Implementations

impl<F: Clone + PrimeField> Clone for PoseidonParameters<F>

fn clone(&self) -> PoseidonParameters<F>

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

impl<F: Debug + PrimeField> Debug for PoseidonParameters<F>

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

impl<F: Default + PrimeField> Default for PoseidonParameters<F>

fn default() -> PoseidonParameters<F>

Auto Trait Implementations

impl<F> RefUnwindSafe for PoseidonParameters<F> where F: RefUnwindSafe,

impl<F> Send for PoseidonParameters<F>

impl<F> Sync for PoseidonParameters<F>

impl<F> Unpin for PoseidonParameters<F> where F: Unpin,

impl<F> UnwindSafe for PoseidonParameters<F> where F: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new(
round_keys: Vec<F>,
mds_matrix: Vec<Vec<F>>,
full_rounds: u8,
partial_rounds: u8,
width: u8,
sbox: PoseidonSbox
) -> Self

pub fn create_mds<R: Rng>(_rng: &mut R) -> Vec<Vec<F>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn create_round_keys<R: Rng>(_rng: &mut R) -> Vec<F>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn to_bytes(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn from_bytes(bytes: &[u8 ]) -> Result<Self, Error>

impl<F> RefUnwindSafe for PoseidonParameters<F> where
F: RefUnwindSafe,

impl<F> Unpin for PoseidonParameters<F> where
F: Unpin,

impl<F> UnwindSafe for PoseidonParameters<F> where
F: UnwindSafe,

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,