#include <pqcrystals.h>

Public Member Functions
void	_const_time_poison () const

void	_const_time_unpoison () const

decltype(auto)	begin ()

decltype(auto)	begin () const

ThisPolynomialVector	clone () const

std::span< T >	coefficients ()

std::span< const T >	coefficients () const

ThisPolynomialVector &	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

size_t	hamming_weight () const noexcept

ThisPolynomialVector &	operator+= (const ThisPolynomialVector &other)

ThisPolynomialVector &	operator-= (const ThisPolynomialVector &other)

ThisPolynomialVector &	operator= (const ThisPolynomialVector &other)=delete

ThisPolynomialVector &	operator= (ThisPolynomialVector &&other) noexcept=default

Polynomial< Trait, D > &	operator[] (size_t i)

const Polynomial< Trait, D > &	operator[] (size_t i) const

	PolynomialVector (const ThisPolynomialVector &other)=delete

	PolynomialVector (size_t vecsize)

	PolynomialVector (ThisPolynomialVector &&other) noexcept=default

ThisPolynomialVector &	reduce ()

size_t	size () const

	~PolynomialVector ()=default

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

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	PolynomialVector

Detailed Description

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

Definition at line 352 of file pqcrystals.h.

Constructor & Destructor Documentation

◆ PolynomialVector() [1/3]

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

Botan::CRYSTALS::PolynomialVector< Trait, D >::PolynomialVector ( size_t vecsize )

inline

Definition at line 398 of file pqcrystals.h.

                                       : m_polys_storage(vecsize * Trait::N) {
         for(size_t i = 0; i < vecsize; ++i) {
            m_vec.emplace_back(
               Polynomial<Trait, D>(std::span{m_polys_storage}.subspan(i * Trait::N).template first<Trait::N>()));
         }
      }

◆ PolynomialVector() [2/3]

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

Botan::CRYSTALS::PolynomialVector< Trait, D >::PolynomialVector ( const ThisPolynomialVector< Trait, D > & other )

delete

◆ PolynomialVector() [3/3]

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

Botan::CRYSTALS::PolynomialVector< Trait, D >::PolynomialVector ( ThisPolynomialVector< Trait, D > && other )

defaultnoexcept

◆ ~PolynomialVector()

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

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

default

Member Function Documentation

◆ _const_time_poison()

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

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

inline

Definition at line 486 of file pqcrystals.h.

486{ CT::poison_range(m_vec); }

Botan::CT::poison_range

constexpr void poison_range(R &&r)

Definition ct_utils.h:175

References Botan::CT::poison_range().

◆ _const_time_unpoison()

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

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

inline

Definition at line 488 of file pqcrystals.h.

488{ CT::unpoison_range(m_vec); }

Botan::CT::unpoison_range

constexpr void unpoison_range(R &&r)

Definition ct_utils.h:183

References Botan::CT::unpoison_range().

◆ begin() [1/2]

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

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

inline

Definition at line 478 of file pqcrystals.h.

478{ return m_vec.begin(); }

◆ begin() [2/2]

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

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

inline

Definition at line 480 of file pqcrystals.h.

480{ return m_vec.begin(); }

◆ clone()

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

ThisPolynomialVector Botan::CRYSTALS::PolynomialVector< Trait, D >::clone ( ) const

inline

Definition at line 415 of file pqcrystals.h.

                                         {
         ThisPolynomialVector res(size());
 
         // The default-constructed PolynomialVector has set up res.m_vec to
         // point to res.m_polys_storage. Therefore we can just copy the data
         // into res.m_polys_storage to fill the non-owning polynomials.
         copy_mem(res.m_polys_storage, m_polys_storage);
 
         return res;
      }

References Botan::copy_mem(), and Botan::CRYSTALS::PolynomialVector< Trait, D >::size().

◆ coefficients() [1/2]

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

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

inline

Definition at line 440 of file pqcrystals.h.

440{ return m_polys_storage; }

Referenced by Botan::CRYSTALS::PolynomialVector< Trait, D >::ct_validate_value_range(), Botan::CRYSTALS::operator*(), Botan::CRYSTALS::operator*(), Botan::CRYSTALS::PolynomialVector< Trait, D >::operator+=(), and Botan::CRYSTALS::PolynomialVector< Trait, D >::operator-=().

◆ coefficients() [2/2]

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

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

inline

Definition at line 442 of file pqcrystals.h.

442{ return m_polys_storage; }

◆ conditional_add_q()

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

ThisPolynomialVector & Botan::CRYSTALS::PolynomialVector< Trait, D >::conditional_add_q ( )

inline

Definition at line 467 of file pqcrystals.h.

                                                {
         for(auto& v : m_vec) {
            Trait::poly_cadd_q(v.coefficients());
         }
         return *this;
      }

◆ ct_validate_value_range()

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

bool Botan::CRYSTALS::PolynomialVector< 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 436 of file pqcrystals.h.

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

References Botan::CRYSTALS::PolynomialVector< Trait, D >::coefficients().

Referenced by Botan::Dilithium_Algos::make_hint(), and Botan::Dilithium_Algos::use_hint().

◆ domain()

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

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

inlineconstexprnoexcept

Definition at line 413 of file pqcrystals.h.

413{ return D; }

◆ end() [1/2]

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

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

inline

Definition at line 482 of file pqcrystals.h.

482{ return m_vec.end(); }

◆ end() [2/2]

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

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

inline

Definition at line 484 of file pqcrystals.h.

484{ return m_vec.end(); }

◆ from_domain_cast()

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

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

static PolynomialVector< Trait, D > Botan::CRYSTALS::PolynomialVector< Trait, D >::from_domain_cast ( PolynomialVector< Trait, OtherD > && other )

inlinestatic

Definition at line 393 of file pqcrystals.h.

                                                                                                  {
         return PolynomialVector<Trait, D>(std::move(other));
      }

References Botan::CRYSTALS::PolynomialVector< Trait, D >::PolynomialVector.

◆ hamming_weight()

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

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

inlinenoexcept

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

Definition at line 427 of file pqcrystals.h.

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

◆ operator+=()

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

ThisPolynomialVector & Botan::CRYSTALS::PolynomialVector< Trait, D >::operator+= ( const ThisPolynomialVector< Trait, D > & other )

inline

Definition at line 444 of file pqcrystals.h.

                                                                          {
         BOTAN_ASSERT(m_vec.size() == other.m_vec.size(), "cannot add polynomial vectors of differing lengths");
         for(size_t i = 0; i < m_vec.size(); ++i) {
            Trait::poly_add(m_vec[i].coefficients(), m_vec[i].coefficients(), other.m_vec[i].coefficients());
         }
         return *this;
      }

References BOTAN_ASSERT, and Botan::CRYSTALS::PolynomialVector< Trait, D >::coefficients().

◆ operator-=()

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

ThisPolynomialVector & Botan::CRYSTALS::PolynomialVector< Trait, D >::operator-= ( const ThisPolynomialVector< Trait, D > & other )

inline

Definition at line 452 of file pqcrystals.h.

                                                                          {
         BOTAN_ASSERT(m_vec.size() == other.m_vec.size(), "cannot subtract polynomial vectors of differing lengths");
         for(size_t i = 0; i < m_vec.size(); ++i) {
            Trait::poly_sub(m_vec[i].coefficients(), m_vec[i].coefficients(), other.m_vec[i].coefficients());
         }
         return *this;
      }

References BOTAN_ASSERT, and Botan::CRYSTALS::PolynomialVector< Trait, D >::coefficients().

◆ operator=() [1/2]

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

ThisPolynomialVector & Botan::CRYSTALS::PolynomialVector< Trait, D >::operator= ( const ThisPolynomialVector< Trait, D > & other )

delete

◆ operator=() [2/2]

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

ThisPolynomialVector & Botan::CRYSTALS::PolynomialVector< Trait, D >::operator= ( ThisPolynomialVector< Trait, D > && other )

defaultnoexcept

◆ operator[]() [1/2]

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

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

inline

Definition at line 474 of file pqcrystals.h.

474{ return m_vec[i]; }

◆ operator[]() [2/2]

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

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

inline

Definition at line 476 of file pqcrystals.h.

476{ return m_vec[i]; }

◆ reduce()

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

ThisPolynomialVector & Botan::CRYSTALS::PolynomialVector< Trait, D >::reduce ( )

inline

Definition at line 460 of file pqcrystals.h.

                                     {
         for(auto& p : m_vec) {
            Trait::barrett_reduce(p.coefficients());
         }
         return *this;
      }

◆ size()

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

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

inline

Definition at line 411 of file pqcrystals.h.

411{ return m_vec.size(); }

Referenced by Botan::CRYSTALS::PolynomialVector< Trait, D >::clone(), Botan::Dilithium_PublicKeyInternal::Dilithium_PublicKeyInternal(), Botan::CRYSTALS::detail::dot_product(), Botan::Dilithium_Algos::make_hint(), Botan::CRYSTALS::operator*(), Botan::CRYSTALS::operator+(), Botan::Dilithium_Algos::power2round(), and Botan::Dilithium_Algos::use_hint().

Friends And Related Symbol Documentation

◆ 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

◆ PolynomialVector

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

template<crystals_trait OtherTrait, Domain OtherD>

friend class PolynomialVector

friend

Definition at line 363 of file pqcrystals.h.

Referenced by Botan::CRYSTALS::PolynomialVector< Trait, D >::from_domain_cast().

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

◆ PolynomialVector() [1/3]

◆ PolynomialVector() [2/3]

◆ PolynomialVector() [3/3]

◆ ~PolynomialVector()

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]

◆ reduce()

◆ size()

Friends And Related Symbol Documentation

◆ detail::domain_cast

◆ PolynomialVector