#include <field6.hpp>

Public Member Functions
constexpr	field6 (const base_field &a=base_field::zero(), const base_field &b=base_field::zero(), const base_field &c=base_field::zero())

constexpr	field6 (const field6 &other)

constexpr	field6 (field6 &&other) noexcept

constexpr field6 &	operator= (const field6 &other) noexcept

constexpr field6 &	operator= (field6 &&other) noexcept

constexpr	~field6 () noexcept=default

constexpr field6	operator+ (const field6 &other) const

constexpr field6	operator- (const field6 &other) const

constexpr field6	operator- () const

constexpr field6	operator* (const field6 &other) const

constexpr field6	operator/ (const field6 &other) const

constexpr field6	sqr () const

constexpr field6	operator+= (const field6 &other)

constexpr field6	operator-= (const field6 &other)

constexpr field6	operator*= (const field6 &other)

constexpr field6	operator/= (const field6 &other)

constexpr void	self_neg ()

constexpr void	self_sqr ()

constexpr field6	invert () const

constexpr field6	mul_by_fq2 (const base_field &other) const

constexpr field6	frobenius_map_three () const

constexpr field6	frobenius_map_two () const

constexpr field6	frobenius_map_one () const

constexpr field6	to_montgomery_form () const

constexpr field6	from_montgomery_form () const

constexpr bool	is_zero () const

constexpr bool	operator== (const field6 &other) const

constexpr field6	sparse_mul (const base_field &a0, const base_field &a1) const
	Multiply a field6 element by a0 + a1 * v.

Static Public Member Functions
static constexpr field6	zero ()

static constexpr field6	one ()

static constexpr base_field	mul_by_non_residue (const base_field &a)

static constexpr field6	random_element (numeric::RNG *engine=nullptr)

Public Attributes
base_field	c0

base_field	c1

base_field	c2

Detailed Description

template<typename base_field, typename Fq6Params>
class bb::field6< base_field, Fq6Params >

Definition at line 11 of file field6.hpp.

Constructor & Destructor Documentation

◆ field6() [1/3]

template<typename base_field , typename Fq6Params >

constexpr bb::field6< base_field, Fq6Params >::field6	(	const base_field &	a = `base_field::zero()`,
		const base_field &	b = `base_field::zero()`,
		const base_field &	c = `base_field::zero()`
	)

inlineconstexpr

Definition at line 13 of file field6.hpp.

◆ field6() [2/3]

template<typename base_field , typename Fq6Params >

constexpr bb::field6< base_field, Fq6Params >::field6 ( const field6< base_field, Fq6Params > & other )

inlineconstexpr

Definition at line 21 of file field6.hpp.

◆ field6() [3/3]

template<typename base_field , typename Fq6Params >

constexpr bb::field6< base_field, Fq6Params >::field6 ( field6< base_field, Fq6Params > && other )

inlineconstexprnoexcept

Definition at line 27 of file field6.hpp.

◆ ~field6()

template<typename base_field , typename Fq6Params >

constexpr bb::field6< base_field, Fq6Params >::~field6 ( )

constexprdefaultnoexcept

Member Function Documentation

◆ frobenius_map_one()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::frobenius_map_one ( ) const

inlineconstexpr

Definition at line 199 of file field6.hpp.

◆ frobenius_map_three()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::frobenius_map_three ( ) const

inlineconstexpr

Definition at line 185 of file field6.hpp.

◆ frobenius_map_two()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::frobenius_map_two ( ) const

inlineconstexpr

Definition at line 194 of file field6.hpp.

◆ from_montgomery_form()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::from_montgomery_form ( ) const

inlineconstexpr

Definition at line 227 of file field6.hpp.

◆ invert()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::invert ( ) const

inlineconstexpr

Definition at line 167 of file field6.hpp.

◆ is_zero()

template<typename base_field , typename Fq6Params >

constexpr bool bb::field6< base_field, Fq6Params >::is_zero ( ) const

inlineconstexpr

Definition at line 236 of file field6.hpp.

◆ mul_by_fq2()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::mul_by_fq2 ( const base_field & other ) const

inlineconstexpr

Definition at line 183 of file field6.hpp.

◆ mul_by_non_residue()

template<typename base_field , typename Fq6Params >

static constexpr base_field bb::field6< base_field, Fq6Params >::mul_by_non_residue ( const base_field & a )

inlinestaticconstexpr

Definition at line 61 of file field6.hpp.

◆ one()

template<typename base_field , typename Fq6Params >

static constexpr field6 bb::field6< base_field, Fq6Params >::one ( )

inlinestaticconstexpr

Definition at line 59 of file field6.hpp.

◆ operator*()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator* ( const field6< base_field, Fq6Params > & other ) const

inlineconstexpr

Definition at line 90 of file field6.hpp.

◆ operator*=()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator*= ( const field6< base_field, Fq6Params > & other )

inlineconstexpr

Definition at line 146 of file field6.hpp.

◆ operator+()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator+ ( const field6< base_field, Fq6Params > & other ) const

inlineconstexpr

Definition at line 63 of file field6.hpp.

◆ operator+=()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator+= ( const field6< base_field, Fq6Params > & other )

inlineconstexpr

Definition at line 130 of file field6.hpp.

◆ operator-() [1/2]

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator- ( ) const

inlineconstexpr

Definition at line 81 of file field6.hpp.

◆ operator-() [2/2]

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator- ( const field6< base_field, Fq6Params > & other ) const

inlineconstexpr

Definition at line 72 of file field6.hpp.

◆ operator-=()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator-= ( const field6< base_field, Fq6Params > & other )

inlineconstexpr

Definition at line 138 of file field6.hpp.

◆ operator/()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator/ ( const field6< base_field, Fq6Params > & other ) const

inlineconstexpr

Definition at line 110 of file field6.hpp.

◆ operator/=()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::operator/= ( const field6< base_field, Fq6Params > & other )

inlineconstexpr

Definition at line 152 of file field6.hpp.

◆ operator=() [1/2]

template<typename base_field , typename Fq6Params >

constexpr field6 & bb::field6< base_field, Fq6Params >::operator= ( const field6< base_field, Fq6Params > & other )

inlineconstexprnoexcept

Definition at line 33 of file field6.hpp.

◆ operator=() [2/2]

template<typename base_field , typename Fq6Params >

constexpr field6 & bb::field6< base_field, Fq6Params >::operator= ( field6< base_field, Fq6Params > && other )

inlineconstexprnoexcept

Definition at line 44 of file field6.hpp.

◆ operator==()

template<typename base_field , typename Fq6Params >

constexpr bool bb::field6< base_field, Fq6Params >::operator== ( const field6< base_field, Fq6Params > & other ) const

inlineconstexpr

Definition at line 238 of file field6.hpp.

◆ random_element()

template<typename base_field , typename Fq6Params >

static constexpr field6 bb::field6< base_field, Fq6Params >::random_element ( numeric::RNG * engine = nullptr )

inlinestaticconstexpr

Definition at line 208 of file field6.hpp.

◆ self_neg()

template<typename base_field , typename Fq6Params >

constexpr void bb::field6< base_field, Fq6Params >::self_neg ( )

inlineconstexpr

Definition at line 158 of file field6.hpp.

◆ self_sqr()

template<typename base_field , typename Fq6Params >

constexpr void bb::field6< base_field, Fq6Params >::self_sqr ( )

inlineconstexpr

Definition at line 165 of file field6.hpp.

◆ sparse_mul()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::sparse_mul	(	const base_field &	a0,
		const base_field &	a1
	)		const

inlineconstexpr

Multiply a field6 element by a0 + a1 * v.

Algorithm 6 from https://cacr.uwaterloo.ca/techreports/2012/cacr2012-17.pdf

Parameters

a0
a1

Returns: constexpr field6

Definition at line 249 of file field6.hpp.

◆ sqr()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::sqr ( ) const

inlineconstexpr

Definition at line 112 of file field6.hpp.

◆ to_montgomery_form()

template<typename base_field , typename Fq6Params >

constexpr field6 bb::field6< base_field, Fq6Params >::to_montgomery_form ( ) const

inlineconstexpr

Definition at line 218 of file field6.hpp.

◆ zero()

template<typename base_field , typename Fq6Params >

static constexpr field6 bb::field6< base_field, Fq6Params >::zero ( )

inlinestaticconstexpr

Definition at line 58 of file field6.hpp.

Member Data Documentation

◆ c0

template<typename base_field , typename Fq6Params >

base_field bb::field6< base_field, Fq6Params >::c0

Definition at line 54 of file field6.hpp.

◆ c1

template<typename base_field , typename Fq6Params >

base_field bb::field6< base_field, Fq6Params >::c1

Definition at line 55 of file field6.hpp.

◆ c2

template<typename base_field , typename Fq6Params >

base_field bb::field6< base_field, Fq6Params >::c2

Definition at line 56 of file field6.hpp.

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

src/barretenberg/ecc/fields/field6.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ field6() [1/3]

◆ field6() [2/3]

◆ field6() [3/3]

◆ ~field6()

Member Function Documentation

◆ frobenius_map_one()

◆ frobenius_map_three()

◆ frobenius_map_two()

◆ from_montgomery_form()

◆ invert()

◆ is_zero()

◆ mul_by_fq2()

◆ mul_by_non_residue()

◆ one()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ random_element()

◆ self_neg()

◆ self_sqr()

◆ sparse_mul()

◆ sqr()

◆ to_montgomery_form()

◆ zero()

Member Data Documentation

◆ c0

◆ c1

◆ c2