Botan 3.14.1
Crypto and TLS for C&
Botan::CRYSTALS::PolynomialVector< Trait, D > Class Template Reference

#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
std::vector< Polynomial< Trait, D > * > polynomials ()
 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>
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>
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 356 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)
inlineexplicit

Definition at line 403 of file pqcrystals.h.

404 for(size_t i = 0; i < vecsize; ++i) {
405 m_vec.emplace_back(
407 }
408 }

◆ 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 501 of file pqcrystals.h.

constexpr void poison_range(const R &r)
Definition ct_utils.h:181

◆ _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 503 of file pqcrystals.h.

constexpr void unpoison_range(const R &r)
Definition ct_utils.h:189

◆ begin() [1/2]

template<crystals_trait Trait, Domain D = Domain::Normal>
decltype(auto) Botan::CRYSTALS::PolynomialVector< Trait, D >::begin ( )
inline

Definition at line 493 of file pqcrystals.h.

493{ 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 495 of file pqcrystals.h.

495{ 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 420 of file pqcrystals.h.

420 {
422
423 // The default-constructed PolynomialVector has set up res.m_vec to
424 // point to res.m_polys_storage. Therefore we can just copy the data
425 // into res.m_polys_storage to fill the non-owning polynomials.
426 copy_mem(res.m_polys_storage, m_polys_storage);
427
428 return res;
429 }
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:144

◆ coefficients() [1/2]

◆ 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 447 of file pqcrystals.h.

447{ 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 472 of file pqcrystals.h.

472 {
473 for(auto& v : m_vec) {
475 }
476 return *this;
477 }

◆ 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 441 of file pqcrystals.h.

441 {
443 }

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 418 of file pqcrystals.h.

418{ 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 497 of file pqcrystals.h.

497{ 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 499 of file pqcrystals.h.

499{ return m_vec.end(); }

◆ from_domain_cast()

template<crystals_trait Trait, Domain D = Domain::Normal>
template<Domain OtherD>
PolynomialVector< Trait, D > Botan::CRYSTALS::PolynomialVector< Trait, D >::from_domain_cast ( PolynomialVector< Trait, OtherD > && other)
inlinestatic

Definition at line 398 of file pqcrystals.h.

398 {
400 }

◆ 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 432 of file pqcrystals.h.

432 {
433 size_t weight = 0;
434 for(const auto c : m_polys_storage) {
435 weight += (c != 0);
436 }
437 return weight;
438 }

◆ 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 449 of file pqcrystals.h.

449 {
450 BOTAN_ASSERT(m_vec.size() == other.m_vec.size(), "cannot add polynomial vectors of differing lengths");
451 for(size_t i = 0; i < m_vec.size(); ++i) {
452 Trait::poly_add(m_vec[i].coefficients(), m_vec[i].coefficients(), other.m_vec[i].coefficients());
453 }
454 return *this;
455 }
#define BOTAN_ASSERT(expr, assertion_made)
Definition assert.h:69

◆ 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 457 of file pqcrystals.h.

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

◆ 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 479 of file pqcrystals.h.

479{ 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 481 of file pqcrystals.h.

481{ return m_vec[i]; }

◆ polynomials()

template<crystals_trait Trait, Domain D = Domain::Normal>
std::vector< Polynomial< Trait, D > * > Botan::CRYSTALS::PolynomialVector< Trait, D >::polynomials ( )
inline
Returns
pointers to the polynomials in this vector, in order

Definition at line 484 of file pqcrystals.h.

484 {
486 result.reserve(m_vec.size());
487 for(auto& p : m_vec) {
488 result.push_back(&p);
489 }
490 return result;
491 }

Referenced by Botan::Kyber_Algos::PolynomialSampler< SeedT >::sample_polynomial_vector_cbd_eta1().

◆ reduce()

template<crystals_trait Trait, Domain D = Domain::Normal>
ThisPolynomialVector & Botan::CRYSTALS::PolynomialVector< Trait, D >::reduce ( )
inline

Definition at line 465 of file pqcrystals.h.

465 {
466 for(auto& p : m_vec) {
468 }
469 return *this;
470 }

◆ size()

◆ detail::domain_cast

template<crystals_trait Trait, Domain D = Domain::Normal>
template<Domain To, template< typename, Domain > class StructureT, crystals_trait C, Domain 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 367 of file pqcrystals.h.


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