#include <pqcrystals.h>

Public Member Functions
void	_const_time_poison () const
void	_const_time_unpoison () const
decltype(auto)	begin ()
decltype(auto)	begin () const
ThisPolynomial	clone () const
std::span< T, Trait::N >	coefficients ()
std::span< const T, Trait::N >	coefficients () const
ThisPolynomial &	conditional_add_q ()
constexpr bool	ct_validate_value_range (T min, T max) const noexcept
constexpr Domain	domain () const noexcept
decltype(auto)	end ()
decltype(auto)	end () const
constexpr size_t	hamming_weight () const noexcept
decltype(auto)	operator+= (const ThisPolynomial &other)
decltype(auto)	operator-= (const ThisPolynomial &other)
ThisPolynomial &	operator= (const ThisPolynomial &other)=delete
ThisPolynomial &	operator= (ThisPolynomial &&other) noexcept
T &	operator[] (size_t i)
T	operator[] (size_t i) const
constexpr bool	owns_storage () const
	Polynomial ()
	Polynomial (const ThisPolynomial &other)=delete
	Polynomial (std::span< T, Trait::N > coeffs)
	Polynomial (ThisPolynomial &&other) noexcept
ThisPolynomial &	reduce ()
constexpr size_t	size () const
	~Polynomial ()=default

Static Public Member Functions
template<Domain OtherD> requires (D != OtherD)
static Polynomial< Trait, D >	from_domain_cast (Polynomial< Trait, OtherD > &&p)

Friends
template<Domain To, template< typename, Domain > class StructureT, crystals_trait C, Domain From> requires (To != From)
StructureT< C, To >	detail::domain_cast (StructureT< C, From > &&)
template<crystals_trait OtherTrait, Domain OtherD>
class	Polynomial

Detailed Description

template<crystals_trait Trait, Domain D = Domain::Normal>
class Botan::CRYSTALS::Polynomial< Trait, D >

Represents a polynomial with Trait::N coefficients of type Trait::T. The domain of the polynomial can be either Domain::Normal or Domain::NTT and this information is represented in the C++ type system.

Polynomials may either own their storage of piggy-back on external storage when they are part of a PolynomialVector.

Definition at line 213 of file pqcrystals.h.

Constructor & Destructor Documentation

◆ Polynomial() [1/4]

template<crystals_trait Trait, Domain D = Domain::Normal>

Botan::CRYSTALS::Polynomial< Trait, D >::Polynomial ( )

inline

Definition at line 254 of file pqcrystals.h.

254: m_coeffs_storage(Trait::N), m_coeffs(m_coeffs_storage) { BOTAN_DEBUG_ASSERT(owns_storage()); }

BOTAN_DEBUG_ASSERT

#define BOTAN_DEBUG_ASSERT(expr)

Definition assert.h:129

Botan::CRYSTALS::Polynomial

Definition pqcrystals.h:213

Botan::CRYSTALS::Polynomial< Trait, D >::owns_storage

constexpr bool owns_storage() const

Definition pqcrystals.h:318

◆ Polynomial() [2/4]

template<crystals_trait Trait, Domain D = Domain::Normal>

Botan::CRYSTALS::Polynomial< Trait, D >::Polynomial ( std::span< T, Trait::N > coeffs )

inlineexplicit

Definition at line 256 of file pqcrystals.h.

256: m_coeffs(coeffs) { BOTAN_DEBUG_ASSERT(!owns_storage()); }

◆ Polynomial() [3/4]

template<crystals_trait Trait, Domain D = Domain::Normal>

Botan::CRYSTALS::Polynomial< Trait, D >::Polynomial ( const ThisPolynomial< Trait, D > & other )

delete

◆ Polynomial() [4/4]

template<crystals_trait Trait, Domain D = Domain::Normal>

Botan::CRYSTALS::Polynomial< Trait, D >::Polynomial ( ThisPolynomial< Trait, D > && other )

inlinenoexcept

Definition at line 260 of file pqcrystals.h.

260 :

261 m_coeffs_storage(std::move(other.m_coeffs_storage)), m_coeffs(other.m_coeffs) {}

◆ ~Polynomial()

template<crystals_trait Trait, Domain D = Domain::Normal>

Botan::CRYSTALS::Polynomial< Trait, D >::~Polynomial ( )

default

Member Function Documentation

◆ _const_time_poison()

template<crystals_trait Trait, Domain D = Domain::Normal>

void Botan::CRYSTALS::Polynomial< Trait, D >::_const_time_poison ( ) const

inline

Definition at line 330 of file pqcrystals.h.

330{ CT::poison(m_coeffs); }

Botan::CT::poison

constexpr void poison(const T *p, size_t n)

Definition ct_utils.h:54

◆ _const_time_unpoison()

template<crystals_trait Trait, Domain D = Domain::Normal>

void Botan::CRYSTALS::Polynomial< Trait, D >::_const_time_unpoison ( ) const

inline

Definition at line 332 of file pqcrystals.h.

332{ CT::unpoison(m_coeffs); }

Botan::CT::unpoison

constexpr void unpoison(const T *p, size_t n)

Definition ct_utils.h:65

◆ begin() [1/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

decltype(auto) Botan::CRYSTALS::Polynomial< Trait, D >::begin ( )

inline

Definition at line 310 of file pqcrystals.h.

310{ return m_coeffs.begin(); }

Botan::CRYSTALS::Polynomial::begin

decltype(auto) begin()

Definition pqcrystals.h:310

◆ begin() [2/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

decltype(auto) Botan::CRYSTALS::Polynomial< Trait, D >::begin ( ) const

inline

Definition at line 312 of file pqcrystals.h.

312{ return m_coeffs.begin(); }

◆ clone()

template<crystals_trait Trait, Domain D = Domain::Normal>

ThisPolynomial Botan::CRYSTALS::Polynomial< Trait, D >::clone ( ) const

inline

Definition at line 280 of file pqcrystals.h.

                                   {
         ThisPolynomial res;
         copy_mem(res.m_coeffs_storage, m_coeffs);
         res.m_coeffs = std::span<T, Trait::N>(res.m_coeffs_storage);
         BOTAN_DEBUG_ASSERT(res.owns_storage());
         return res;
      }

◆ coefficients() [1/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

std::span< T, Trait::N > Botan::CRYSTALS::Polynomial< Trait, D >::coefficients ( )

inline

Definition at line 302 of file pqcrystals.h.

302{ return m_coeffs; }

Referenced by Botan::CRYSTALS::Polynomial< DilithiumPolyTraits, Botan::CRYSTALS::Domain::NTT >::ct_validate_value_range(), Botan::CRYSTALS::operator*(), and Botan::CRYSTALS::operator*().

◆ coefficients() [2/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

std::span< const T, Trait::N > Botan::CRYSTALS::Polynomial< Trait, D >::coefficients ( ) const

inline

Definition at line 304 of file pqcrystals.h.

304{ return m_coeffs; }

◆ conditional_add_q()

template<crystals_trait Trait, Domain D = Domain::Normal>

ThisPolynomial & Botan::CRYSTALS::Polynomial< Trait, D >::conditional_add_q ( )

inline

Definition at line 325 of file pqcrystals.h.

                                          {
         Trait::poly_cadd_q(m_coeffs);
         return *this;
      }

◆ ct_validate_value_range()

template<crystals_trait Trait, Domain D = Domain::Normal>

bool Botan::CRYSTALS::Polynomial< Trait, D >::ct_validate_value_range	(	T	min,
		T	max ) const

inlineconstexprnoexcept

Returns: true if all coefficients are within the range [min, max]

Definition at line 289 of file pqcrystals.h.

                                                                          {
         return detail::ct_all_within_range(coefficients(), min, max);
      }

Referenced by Botan::Dilithium_Algos::sample_in_ball().

◆ domain()

template<crystals_trait Trait, Domain D = Domain::Normal>

Domain Botan::CRYSTALS::Polynomial< Trait, D >::domain ( ) const

inlineconstexprnoexcept

Definition at line 278 of file pqcrystals.h.

278{ return D; }

◆ end() [1/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

decltype(auto) Botan::CRYSTALS::Polynomial< Trait, D >::end ( )

inline

Definition at line 314 of file pqcrystals.h.

314{ return m_coeffs.end(); }

Botan::CRYSTALS::Polynomial::end

decltype(auto) end()

Definition pqcrystals.h:314

◆ end() [2/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

decltype(auto) Botan::CRYSTALS::Polynomial< Trait, D >::end ( ) const

inline

Definition at line 316 of file pqcrystals.h.

316{ return m_coeffs.end(); }

◆ from_domain_cast()

template<crystals_trait Trait, Domain D = Domain::Normal>

template<Domain OtherD>
requires (D != OtherD)

Polynomial< Trait, D > Botan::CRYSTALS::Polynomial< Trait, D >::from_domain_cast ( Polynomial< Trait, OtherD > && p )

inlinestatic

Definition at line 249 of file pqcrystals.h.

                                                                                  {
         return Polynomial<Trait, D>(std::move(p));
      }

◆ hamming_weight()

template<crystals_trait Trait, Domain D = Domain::Normal>

size_t Botan::CRYSTALS::Polynomial< Trait, D >::hamming_weight ( ) const

inlineconstexprnoexcept

Returns: the number of non-zero coefficients in the polynomial

Definition at line 294 of file pqcrystals.h.

                                                       {
         size_t weight = 0;
         for(const auto c : m_coeffs) {
            weight += (c != 0);
         }
         return weight;
      }

Referenced by Botan::Dilithium_Algos::sample_in_ball().

◆ operator+=()

template<crystals_trait Trait, Domain D = Domain::Normal>

decltype(auto) Botan::CRYSTALS::Polynomial< Trait, D >::operator+= ( const ThisPolynomial< Trait, D > & other )

inline

Adds two polynomials element-wise. Does not perform a reduction after the addition. Therefore this operation might cause an integer overflow.

Definition at line 338 of file pqcrystals.h.

                                                             {
         Trait::poly_add(m_coeffs, m_coeffs, other.m_coeffs);
         return *this;
      }

◆ operator-=()

template<crystals_trait Trait, Domain D = Domain::Normal>

decltype(auto) Botan::CRYSTALS::Polynomial< Trait, D >::operator-= ( const ThisPolynomial< Trait, D > & other )

inline

Subtracts two polynomials element-wise. Does not perform a reduction after the subtraction. Therefore this operation might cause an integer underflow.

Definition at line 347 of file pqcrystals.h.

                                                             {
         Trait::poly_sub(m_coeffs, m_coeffs, other.m_coeffs);
         return *this;
      }

◆ operator=() [1/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

ThisPolynomial & Botan::CRYSTALS::Polynomial< Trait, D >::operator= ( const ThisPolynomial< Trait, D > & other )

delete

◆ operator=() [2/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

ThisPolynomial & Botan::CRYSTALS::Polynomial< Trait, D >::operator= ( ThisPolynomial< Trait, D > && other )

inlinenoexcept

Definition at line 265 of file pqcrystals.h.

                                                                 {
         if(this != &other) {
            BOTAN_ASSERT_NOMSG(owns_storage());
            m_coeffs_storage = std::move(other.m_coeffs_storage);
            m_coeffs = std::span<T, Trait::N>(m_coeffs_storage);
         }
         return *this;
      }

◆ operator[]() [1/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

T & Botan::CRYSTALS::Polynomial< Trait, D >::operator[] ( size_t i )

inline

Definition at line 306 of file pqcrystals.h.

306{ return m_coeffs[i]; }

◆ operator[]() [2/2]

template<crystals_trait Trait, Domain D = Domain::Normal>

T Botan::CRYSTALS::Polynomial< Trait, D >::operator[] ( size_t i ) const

inline

Definition at line 308 of file pqcrystals.h.

308{ return m_coeffs[i]; }

◆ owns_storage()

template<crystals_trait Trait, Domain D = Domain::Normal>

bool Botan::CRYSTALS::Polynomial< Trait, D >::owns_storage ( ) const

inlineconstexpr

Definition at line 318 of file pqcrystals.h.

318{ return !m_coeffs_storage.empty(); }

Referenced by Botan::CRYSTALS::Polynomial< DilithiumPolyTraits, Botan::CRYSTALS::Domain::NTT >::clone(), Botan::CRYSTALS::Polynomial< DilithiumPolyTraits, Botan::CRYSTALS::Domain::NTT >::operator=(), Botan::CRYSTALS::Polynomial< DilithiumPolyTraits, Botan::CRYSTALS::Domain::NTT >::Polynomial(), and Botan::CRYSTALS::Polynomial< DilithiumPolyTraits, Botan::CRYSTALS::Domain::NTT >::Polynomial().

◆ reduce()

template<crystals_trait Trait, Domain D = Domain::Normal>

ThisPolynomial & Botan::CRYSTALS::Polynomial< Trait, D >::reduce ( )

inline

Definition at line 320 of file pqcrystals.h.

                               {
         Trait::barrett_reduce(m_coeffs);
         return *this;
      }

Referenced by Botan::CRYSTALS::detail::dot_product().

◆ size()

template<crystals_trait Trait, Domain D = Domain::Normal>

size_t Botan::CRYSTALS::Polynomial< Trait, D >::size ( ) const

inlineconstexpr

Definition at line 276 of file pqcrystals.h.

276{ return m_coeffs.size(); }

Botan::CRYSTALS::Polynomial::size

constexpr size_t size() const

Definition pqcrystals.h:276

Referenced by Botan::CRYSTALS::pack(), Botan::Kyber_Algos::polynomial_to_message(), Botan::Dilithium_Algos::sample_in_ball(), and Botan::CRYSTALS::unpack().

◆ detail::domain_cast

template<crystals_trait Trait, Domain D = Domain::Normal>

template<Domain To, template< typename, Domain > class StructureT, crystals_trait C, Domain From>
requires (To != From)

StructureT< C, To > detail::domain_cast ( StructureT< C, From > && )

friend

◆ Polynomial

template<crystals_trait Trait, Domain D = Domain::Normal>

template<crystals_trait OtherTrait, Domain OtherD>

friend class Polynomial

friend

Definition at line 225 of file pqcrystals.h.

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

src/lib/pubkey/pqcrystals/pqcrystals.h

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Polynomial() [1/4]

◆ Polynomial() [2/4]

◆ Polynomial() [3/4]

◆ Polynomial() [4/4]

◆ ~Polynomial()

Member Function Documentation

◆ _const_time_poison()

◆ _const_time_unpoison()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clone()

◆ coefficients() [1/2]

◆ coefficients() [2/2]

◆ conditional_add_q()

◆ ct_validate_value_range()

◆ domain()

◆ end() [1/2]

◆ end() [2/2]

◆ from_domain_cast()

◆ hamming_weight()

◆ operator+=()

◆ operator-=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ owns_storage()

◆ reduce()

◆ size()

Friends And Related Symbol Documentation

◆ detail::domain_cast

◆ Polynomial