Barretenberg
The ZK-SNARK library at the core of Aztec
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
bb::field12< quadratic_field, base_field, Fq12Params > Class Template Reference

#include <field12.hpp>

Classes

struct  ell_coeffs
 

Public Member Functions

constexpr field12 (const base_field &a=base_field::zero(), const base_field &b=base_field::zero())
 
constexpr field12 (const field12 &other)
 
constexpr field12 (field12 &&other) noexcept
 
constexpr field12 & operator= (const field12 &other) noexcept
 
constexpr field12 & operator= (field12 &&other) noexcept
 
constexpr ~field12 () noexcept=default
 
constexpr field12 operator+ (const field12 &other) const
 
constexpr field12 operator- (const field12 &other) const
 
constexpr field12 operator* (const field12 &other) const
 
constexpr field12 operator/ (const field12 &other) const
 
constexpr field12 operator+= (const field12 &other)
 
constexpr field12 operator-= (const field12 &other)
 
constexpr field12 operator*= (const field12 &other)
 
constexpr field12 operator/= (const field12 &other)
 
constexpr void self_sparse_mul (const ell_coeffs &ell)
 
constexpr field12 sqr () const
 
constexpr field12 invert () const
 
constexpr field12 frobenius_map_three () const
 
constexpr field12 frobenius_map_two () const
 
constexpr field12 frobenius_map_one () const
 
constexpr field12 cyclotomic_squared () const
 
constexpr field12 unitary_inverse () const
 
constexpr field12 to_montgomery_form ()
 
constexpr field12 from_montgomery_form ()
 
constexpr bool is_zero () const
 
constexpr bool operator== (const field12 &other) const
 

Static Public Member Functions

static constexpr field12 zero ()
 
static constexpr field12 one ()
 
static constexpr base_field mul_by_non_residue (const base_field &a)
 
static constexpr field12 random_element (numeric::RNG *engine=nullptr)
 

Public Attributes

base_field c0
 
base_field c1
 

Detailed Description

template<typename quadratic_field, typename base_field, typename Fq12Params>
class bb::field12< quadratic_field, base_field, Fq12Params >

Definition at line 11 of file field12.hpp.

Constructor & Destructor Documentation

◆ field12() [1/3]

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr bb::field12< quadratic_field, base_field, Fq12Params >::field12 ( const base_field &  a = base_field::zero(),
const base_field &  b = base_field::zero() 
)
inlineconstexpr

Definition at line 13 of file field12.hpp.

◆ field12() [2/3]

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr bb::field12< quadratic_field, base_field, Fq12Params >::field12 ( const field12< quadratic_field, base_field, Fq12Params > &  other)
inlineconstexpr

Definition at line 18 of file field12.hpp.

◆ field12() [3/3]

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr bb::field12< quadratic_field, base_field, Fq12Params >::field12 ( field12< quadratic_field, base_field, Fq12Params > &&  other)
inlineconstexprnoexcept

Definition at line 23 of file field12.hpp.

◆ ~field12()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr bb::field12< quadratic_field, base_field, Fq12Params >::~field12 ( )
constexprdefaultnoexcept

Member Function Documentation

◆ cyclotomic_squared()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::cyclotomic_squared ( ) const
inlineconstexpr

Definition at line 232 of file field12.hpp.

◆ frobenius_map_one()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::frobenius_map_one ( ) const
inlineconstexpr

Definition at line 224 of file field12.hpp.

◆ frobenius_map_three()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::frobenius_map_three ( ) const
inlineconstexpr

Definition at line 208 of file field12.hpp.

◆ frobenius_map_two()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::frobenius_map_two ( ) const
inlineconstexpr

Definition at line 216 of file field12.hpp.

◆ from_montgomery_form()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::from_montgomery_form ( )
inlineconstexpr

Definition at line 263 of file field12.hpp.

◆ invert()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::invert ( ) const
inlineconstexpr

Definition at line 197 of file field12.hpp.

◆ is_zero()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr bool bb::field12< quadratic_field, base_field, Fq12Params >::is_zero ( ) const
inlineconstexpr

Definition at line 271 of file field12.hpp.

◆ mul_by_non_residue()

template<typename quadratic_field , typename base_field , typename Fq12Params >
static constexpr base_field bb::field12< quadratic_field, base_field, Fq12Params >::mul_by_non_residue ( const base_field &  a)
inlinestaticconstexpr

Definition at line 59 of file field12.hpp.

◆ one()

template<typename quadratic_field , typename base_field , typename Fq12Params >
static constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::one ( )
inlinestaticconstexpr

Definition at line 57 of file field12.hpp.

◆ operator*()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator* ( const field12< quadratic_field, base_field, Fq12Params > &  other) const
inlineconstexpr

Definition at line 84 of file field12.hpp.

◆ operator*=()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator*= ( const field12< quadratic_field, base_field, Fq12Params > &  other)
inlineconstexpr

Definition at line 113 of file field12.hpp.

◆ operator+()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator+ ( const field12< quadratic_field, base_field, Fq12Params > &  other) const
inlineconstexpr

Definition at line 68 of file field12.hpp.

◆ operator+=()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator+= ( const field12< quadratic_field, base_field, Fq12Params > &  other)
inlineconstexpr

Definition at line 99 of file field12.hpp.

◆ operator-()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator- ( const field12< quadratic_field, base_field, Fq12Params > &  other) const
inlineconstexpr

Definition at line 76 of file field12.hpp.

◆ operator-=()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator-= ( const field12< quadratic_field, base_field, Fq12Params > &  other)
inlineconstexpr

Definition at line 106 of file field12.hpp.

◆ operator/()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator/ ( const field12< quadratic_field, base_field, Fq12Params > &  other) const
inlineconstexpr

Definition at line 97 of file field12.hpp.

◆ operator/=()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::operator/= ( const field12< quadratic_field, base_field, Fq12Params > &  other)
inlineconstexpr

Definition at line 119 of file field12.hpp.

◆ operator=() [1/2]

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 & bb::field12< quadratic_field, base_field, Fq12Params >::operator= ( const field12< quadratic_field, base_field, Fq12Params > &  other)
inlineconstexprnoexcept

Definition at line 28 of file field12.hpp.

◆ operator=() [2/2]

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 & bb::field12< quadratic_field, base_field, Fq12Params >::operator= ( field12< quadratic_field, base_field, Fq12Params > &&  other)
inlineconstexprnoexcept

Definition at line 38 of file field12.hpp.

◆ operator==()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr bool bb::field12< quadratic_field, base_field, Fq12Params >::operator== ( const field12< quadratic_field, base_field, Fq12Params > &  other) const
inlineconstexpr

Definition at line 273 of file field12.hpp.

◆ random_element()

template<typename quadratic_field , typename base_field , typename Fq12Params >
static constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::random_element ( numeric::RNG *  engine = nullptr)
inlinestaticconstexpr

Definition at line 247 of file field12.hpp.

◆ self_sparse_mul()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr void bb::field12< quadratic_field, base_field, Fq12Params >::self_sparse_mul ( const ell_coeffs &  ell)
inlineconstexpr

Definition at line 125 of file field12.hpp.

◆ sqr()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::sqr ( ) const
inlineconstexpr

Definition at line 183 of file field12.hpp.

◆ to_montgomery_form()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::to_montgomery_form ( )
inlineconstexpr

Definition at line 255 of file field12.hpp.

◆ unitary_inverse()

template<typename quadratic_field , typename base_field , typename Fq12Params >
constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::unitary_inverse ( ) const
inlineconstexpr

Definition at line 239 of file field12.hpp.

◆ zero()

template<typename quadratic_field , typename base_field , typename Fq12Params >
static constexpr field12 bb::field12< quadratic_field, base_field, Fq12Params >::zero ( )
inlinestaticconstexpr

Definition at line 56 of file field12.hpp.

Member Data Documentation

◆ c0

template<typename quadratic_field , typename base_field , typename Fq12Params >
base_field bb::field12< quadratic_field, base_field, Fq12Params >::c0

Definition at line 47 of file field12.hpp.

◆ c1

template<typename quadratic_field , typename base_field , typename Fq12Params >
base_field bb::field12< quadratic_field, base_field, Fq12Params >::c1

Definition at line 48 of file field12.hpp.

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