Barretenberg
The ZK-SNARK library at the core of Aztec
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
bb::avm2::simulation::Poseidon2 Class Reference

#include <poseidon2.hpp>

Inheritance diagram for bb::avm2::simulation::Poseidon2:
bb::avm2::simulation::Poseidon2Interface

Public Member Functions

 Poseidon2 (ExecutionIdManagerInterface &execution_id_manager, GreaterThanInterface &gt, EventEmitterInterface< Poseidon2HashEvent > &hash_emitter, EventEmitterInterface< Poseidon2PermutationEvent > &perm_emitter, EventEmitterInterface< Poseidon2PermutationMemoryEvent > &perm_mem_emitter)
 
FF hash (const std::vector< FF > &input) override
 Hashes a vector of field elements using the Poseidon2 permutation function in a sponge-like manner with capacity 1 and rate 3.
 
std::array< FF, 4 > permutation (const std::array< FF, 4 > &input) override
 Applies the Poseidon2 permutation function to a single input state.
 
void permutation (MemoryInterface &memory, MemoryAddress src_address, MemoryAddress dst_address) override
 Applies the Poseidon2 permutation function to a single input state from memory. This function reads 4 sequential elements from memory and writes 4 sequential elements to memory.
 
- Public Member Functions inherited from bb::avm2::simulation::Poseidon2Interface
virtual ~Poseidon2Interface ()=default
 

Private Attributes

ExecutionIdManagerInterface & execution_id_manager
 
GreaterThanInterface & gt
 
EventEmitterInterface< Poseidon2HashEvent > & hash_events
 
EventEmitterInterface< Poseidon2PermutationEvent > & perm_events
 
EventEmitterInterface< Poseidon2PermutationMemoryEvent > & perm_mem_events
 

Detailed Description

Definition at line 17 of file poseidon2.hpp.

Constructor & Destructor Documentation

◆ Poseidon2()

bb::avm2::simulation::Poseidon2::Poseidon2 ( ExecutionIdManagerInterface &  execution_id_manager,
GreaterThanInterface &  gt,
EventEmitterInterface< Poseidon2HashEvent > &  hash_emitter,
EventEmitterInterface< Poseidon2PermutationEvent > &  perm_emitter,
EventEmitterInterface< Poseidon2PermutationMemoryEvent > &  perm_mem_emitter 
)
inline

Definition at line 19 of file poseidon2.hpp.

Member Function Documentation

◆ hash()

FF bb::avm2::simulation::Poseidon2::hash ( const std::vector< FF > &  input)
overridevirtual

Hashes a vector of field elements using the Poseidon2 permutation function in a sponge-like manner with capacity 1 and rate 3.

Parameters
inputThe input vector of field elements to hash.
Returns
The hash of the input vector as a field element.

Implements bb::avm2::simulation::Poseidon2Interface.

Definition at line 35 of file poseidon2.cpp.

◆ permutation() [1/2]

std::array< FF, 4 > bb::avm2::simulation::Poseidon2::permutation ( const std::array< FF, 4 > &  input)
overridevirtual

Applies the Poseidon2 permutation function to a single input state.

Parameters
inputThe input state as an array of 4 field elements to apply the permutation function to.
Returns
The output state as an array of 4 field elements after the permutation function has been applied.

Implements bb::avm2::simulation::Poseidon2Interface.

Definition at line 74 of file poseidon2.cpp.

◆ permutation() [2/2]

void bb::avm2::simulation::Poseidon2::permutation ( MemoryInterface &  memory,
MemoryAddress  src_address,
MemoryAddress  dst_address 
)
overridevirtual

Applies the Poseidon2 permutation function to a single input state from memory. This function reads 4 sequential elements from memory and writes 4 sequential elements to memory.

Parameters
memoryThe memory interface to read and write from.
src_addressThe source memory address to read from.
dst_addressThe destination memory address to write to.
Exceptions
Poseidon2Exception
  • if the source or destination memory slice is out of range.
  • if the tags of the input memory slice are not FF.

Implements bb::avm2::simulation::Poseidon2Interface.

Definition at line 92 of file poseidon2.cpp.

Member Data Documentation

◆ execution_id_manager

ExecutionIdManagerInterface& bb::avm2::simulation::Poseidon2::execution_id_manager
private

Definition at line 36 of file poseidon2.hpp.

◆ gt

GreaterThanInterface& bb::avm2::simulation::Poseidon2::gt
private

Definition at line 37 of file poseidon2.hpp.

◆ hash_events

EventEmitterInterface<Poseidon2HashEvent>& bb::avm2::simulation::Poseidon2::hash_events
private

Definition at line 38 of file poseidon2.hpp.

◆ perm_events

EventEmitterInterface<Poseidon2PermutationEvent>& bb::avm2::simulation::Poseidon2::perm_events
private

Definition at line 39 of file poseidon2.hpp.

◆ perm_mem_events

EventEmitterInterface<Poseidon2PermutationMemoryEvent>& bb::avm2::simulation::Poseidon2::perm_mem_events
private

Definition at line 40 of file poseidon2.hpp.

The documentation for this class was generated from the following files: