Struct snarkvm_wasm::algorithms::Poseidon

pub struct Poseidon<E, const RATE: usize>where
    E: Environment,{ /* private fields */ }

Implementations

impl<E, const RATE: usize> Poseidon<E, RATE>where
E: Environment,

pub fn setup(domain: &str) -> Result<Poseidon<E, RATE>, Error>

Initializes a new instance of Poseidon.

pub fn domain(&self) -> Field<E>

Returns the domain separator for the hash function.

pub fn parameters(
&self
) -> &Arc<PoseidonParameters<<E as Environment>::Field, RATE, _>>

Returns the Poseidon parameters for hashing.

Trait Implementations

impl<E, const RATE: usize> Clone for Poseidon<E, RATE>where
E: Clone + Environment,
<E as Environment>::Field: Clone,

fn clone(&self) -> Poseidon<E, RATE>

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

impl<E, const RATE: usize> Hash for Poseidon<E, RATE>where
E: Environment,

fn hash(
&self,
input: &[<Poseidon<E, RATE> as Hash>::Input]
) -> Result<<Poseidon<E, RATE> as Hash>::Output, Error>

Returns the cryptographic hash for a list of field elements as input.

type Input = Field<E>

type Output = Field<E>

impl<E, const RATE: usize> HashMany for Poseidon<E, RATE>where
E: Environment,

fn hash_many(
 &self,
 input: &[<Poseidon<E, RATE> as HashMany>::Input],
 num_outputs: u16
) -> Vec<<Poseidon<E, RATE> as HashMany>::Output, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Returns the cryptographic hash for a list of field elements as input, and returns the specified number of field elements as output.

type Input = Field<E>

type Output = Field<E>

impl<E, const RATE: usize> HashToGroup for Poseidon<E, RATE>where
E: Environment,

fn hash_to_group(
&self,
input: &[<Poseidon<E, RATE> as HashToGroup>::Input]
) -> Result<<Poseidon<E, RATE> as HashToGroup>::Output, Error>

Returns a group element from hashing the input.

type Input = Field<E>

type Output = Group<E>

impl<E, const RATE: usize> HashToScalar for Poseidon<E, RATE>where
E: Environment,

fn hash_to_scalar(
&self,
input: &[<Poseidon<E, RATE> as HashToScalar>::Input]
) -> Result<<Poseidon<E, RATE> as HashToScalar>::Output, Error>

Returns a scalar from hashing the input. This method uses truncation (up to data bits) to project onto the scalar field.

type Input = Field<E>

type Output = Scalar<E>

impl<E, const RATE: usize> LeafHash for Poseidon<E, RATE>where
E: Environment,

fn hash_leaf(
&self,
leaf: &<Poseidon<E, RATE> as LeafHash>::Leaf
) -> Result<<Poseidon<E, RATE> as LeafHash>::Hash, Error>

Returns the hash of the given leaf node.

type Hash = Field<E>

type Leaf = Vec<<Poseidon<E, RATE> as LeafHash>::Hash, Global>

fn hash_leaves(
&self,
leaves: &[Self::Leaf]
) -> Result<Vec<Self::Hash, Global>, Error>

Returns the hash for each leaf node.

impl<E, const RATE: usize> PRF for Poseidon<E, RATE>where
E: Environment,

type Input = Field<E>

type Output = Field<E>

type Seed = Field<E>

fn prf(
 &self,
 seed: &<Poseidon<E, RATE> as PRF>::Seed,
 input: &[<Poseidon<E, RATE> as PRF>::Input]
) -> Result<<Poseidon<E, RATE> as PRF>::Output, Error>

Returns the output for the given seed and input.

impl<E, const RATE: usize> PathHash for Poseidon<E, RATE>where
E: Environment,

fn hash_children(
 &self,
 left: &<Poseidon<E, RATE> as PathHash>::Hash,
 right: &<Poseidon<E, RATE> as PathHash>::Hash
) -> Result<<Poseidon<E, RATE> as PathHash>::Hash, Error>

Returns the hash of the given child nodes.

type Hash = Field<E>

fn hash_empty(&self) -> Result<Self::Hash, Error>

Returns the empty hash.

fn hash_all_children(
&self,
child_nodes: &[(Self::Hash, Self::Hash)]
) -> Result<Vec<Self::Hash, Global>, Error>

Returns the hash for each tuple of child nodes.

Auto Trait Implementations

impl<E, const RATE: usize> RefUnwindSafe for Poseidon<E, RATE>where
<E as Environment>::Field: RefUnwindSafe,

impl<E, const RATE: usize> Send for Poseidon<E, RATE>

impl<E, const RATE: usize> Sync for Poseidon<E, RATE>

impl<E, const RATE: usize> Unpin for Poseidon<E, RATE>where
<E as Environment>::Field: Unpin,

impl<E, const RATE: usize> UnwindSafe for Poseidon<E, RATE>where
<E as Environment>::Field: UnwindSafe + RefUnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

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

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
T: Clone,

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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`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>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`

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

Struct snarkvm_wasm::algorithms::Poseidon

Implementations

impl<E, const RATE: usize> Poseidon<E, RATE>where E: Environment,

pub fn setup(domain: &str) -> Result<Poseidon<E, RATE>, Error>

pub fn domain(&self) -> Field<E>

pub fn parameters( &self) -> &Arc<PoseidonParameters<<E as Environment>::Field, RATE, _>>

Trait Implementations

impl<E, const RATE: usize> Clone for Poseidon<E, RATE>where E: Clone + Environment, <E as Environment>::Field: Clone,

fn clone(&self) -> Poseidon<E, RATE>

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

impl<E, const RATE: usize> Hash for Poseidon<E, RATE>where E: Environment,

fn hash( &self, input: &[<Poseidon<E, RATE> as Hash>::Input]) -> Result<<Poseidon<E, RATE> as Hash>::Output, Error>

type Input = Field<E>

type Output = Field<E>

impl<E, const RATE: usize> HashMany for Poseidon<E, RATE>where E: Environment,

fn hash_many( &self, input: &[<Poseidon<E, RATE> as HashMany>::Input], num_outputs: u16) -> Vec<<Poseidon<E, RATE> as HashMany>::Output, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

type Input = Field<E>

type Output = Field<E>

impl<E, const RATE: usize> HashToGroup for Poseidon<E, RATE>where E: Environment,

fn hash_to_group( &self, input: &[<Poseidon<E, RATE> as HashToGroup>::Input]) -> Result<<Poseidon<E, RATE> as HashToGroup>::Output, Error>

type Input = Field<E>

type Output = Group<E>

impl<E, const RATE: usize> HashToScalar for Poseidon<E, RATE>where E: Environment,

fn hash_to_scalar( &self, input: &[<Poseidon<E, RATE> as HashToScalar>::Input]) -> Result<<Poseidon<E, RATE> as HashToScalar>::Output, Error>

type Input = Field<E>

type Output = Scalar<E>

impl<E, const RATE: usize> LeafHash for Poseidon<E, RATE>where E: Environment,

fn hash_leaf( &self, leaf: &<Poseidon<E, RATE> as LeafHash>::Leaf) -> Result<<Poseidon<E, RATE> as LeafHash>::Hash, Error>

type Hash = Field<E>

type Leaf = Vec<<Poseidon<E, RATE> as LeafHash>::Hash, Global>

fn hash_leaves( &self, leaves: &[Self::Leaf]) -> Result<Vec<Self::Hash, Global>, Error>

impl<E, const RATE: usize> PRF for Poseidon<E, RATE>where E: Environment,

type Input = Field<E>

type Output = Field<E>

type Seed = Field<E>

fn prf( &self, seed: &<Poseidon<E, RATE> as PRF>::Seed, input: &[<Poseidon<E, RATE> as PRF>::Input]) -> Result<<Poseidon<E, RATE> as PRF>::Output, Error>

impl<E, const RATE: usize> PathHash for Poseidon<E, RATE>where E: Environment,

fn hash_children( &self, left: &<Poseidon<E, RATE> as PathHash>::Hash, right: &<Poseidon<E, RATE> as PathHash>::Hash) -> Result<<Poseidon<E, RATE> as PathHash>::Hash, Error>

type Hash = Field<E>

fn hash_empty(&self) -> Result<Self::Hash, Error>

fn hash_all_children( &self, child_nodes: &[(Self::Hash, Self::Hash)]) -> Result<Vec<Self::Hash, Global>, Error>

Auto Trait Implementations

impl<E, const RATE: usize> RefUnwindSafe for Poseidon<E, RATE>where <E as Environment>::Field: RefUnwindSafe,

impl<E, const RATE: usize> Send for Poseidon<E, RATE>

impl<E, const RATE: usize> Sync for Poseidon<E, RATE>

impl<E, const RATE: usize> Unpin for Poseidon<E, RATE>where <E as Environment>::Field: Unpin,

impl<E, const RATE: usize> UnwindSafe for Poseidon<E, RATE>where <E as Environment>::Field: UnwindSafe + RefUnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<E, const RATE: usize> Poseidon<E, RATE>where
E: Environment,

pub fn parameters(
&self
) -> &Arc<PoseidonParameters<<E as Environment>::Field, RATE, _>>

impl<E, const RATE: usize> Clone for Poseidon<E, RATE>where
E: Clone + Environment,
<E as Environment>::Field: Clone,

impl<E, const RATE: usize> Hash for Poseidon<E, RATE>where
E: Environment,

fn hash(
&self,
input: &[<Poseidon<E, RATE> as Hash>::Input]
) -> Result<<Poseidon<E, RATE> as Hash>::Output, Error>

impl<E, const RATE: usize> HashMany for Poseidon<E, RATE>where
E: Environment,

fn hash_many(
&self,
input: &[<Poseidon<E, RATE> as HashMany>::Input],
num_outputs: u16
) -> Vec<<Poseidon<E, RATE> as HashMany>::Output, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

impl<E, const RATE: usize> HashToGroup for Poseidon<E, RATE>where
E: Environment,

fn hash_to_group(
&self,
input: &[<Poseidon<E, RATE> as HashToGroup>::Input]
) -> Result<<Poseidon<E, RATE> as HashToGroup>::Output, Error>

impl<E, const RATE: usize> HashToScalar for Poseidon<E, RATE>where
E: Environment,

fn hash_to_scalar(
&self,
input: &[<Poseidon<E, RATE> as HashToScalar>::Input]
) -> Result<<Poseidon<E, RATE> as HashToScalar>::Output, Error>

impl<E, const RATE: usize> LeafHash for Poseidon<E, RATE>where
E: Environment,

fn hash_leaf(
&self,
leaf: &<Poseidon<E, RATE> as LeafHash>::Leaf
) -> Result<<Poseidon<E, RATE> as LeafHash>::Hash, Error>

fn hash_leaves(
&self,
leaves: &[Self::Leaf]
) -> Result<Vec<Self::Hash, Global>, Error>

impl<E, const RATE: usize> PRF for Poseidon<E, RATE>where
E: Environment,

fn prf(
&self,
seed: &<Poseidon<E, RATE> as PRF>::Seed,
input: &[<Poseidon<E, RATE> as PRF>::Input]
) -> Result<<Poseidon<E, RATE> as PRF>::Output, Error>

impl<E, const RATE: usize> PathHash for Poseidon<E, RATE>where
E: Environment,

fn hash_children(
&self,
left: &<Poseidon<E, RATE> as PathHash>::Hash,
right: &<Poseidon<E, RATE> as PathHash>::Hash
) -> Result<<Poseidon<E, RATE> as PathHash>::Hash, Error>

fn hash_all_children(
&self,
child_nodes: &[(Self::Hash, Self::Hash)]
) -> Result<Vec<Self::Hash, Global>, Error>

impl<E, const RATE: usize> RefUnwindSafe for Poseidon<E, RATE>where
<E as Environment>::Field: RefUnwindSafe,

impl<E, const RATE: usize> Unpin for Poseidon<E, RATE>where
<E as Environment>::Field: Unpin,

impl<E, const RATE: usize> UnwindSafe for Poseidon<E, RATE>where
<E as Environment>::Field: UnwindSafe + RefUnwindSafe,

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

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

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

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T>where T: Future, type Output = <T as Future>::Output;`

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T>where T: Future, type Output = <T as Future>::Output;`