Botan::donna128 Class Reference

#include <donna128.h>

Public Member Functions
constexpr	donna128 (uint64_t l=0, uint64_t h=0)
constexpr uint64_t	hi () const
constexpr uint64_t	lo () const
constexpr	operator uint64_t () const
constexpr uint64_t	operator&= (uint64_t mask)
constexpr donna128 &	operator+= (const donna128 &x)
constexpr donna128 &	operator+= (uint64_t x)

Friends
constexpr friend uint64_t	operator& (const donna128 &x, uint64_t mask)
template<std::unsigned_integral T>
constexpr friend donna128	operator<< (const donna128 &x, T shift)
template<std::unsigned_integral T>
constexpr friend donna128	operator>> (const donna128 &x, T shift)

Detailed Description

Definition at line 17 of file donna128.h.

Constructor & Destructor Documentation

donna128()

Botan::donna128::donna128 ( uint64_t l = 0, uint64_t h = 0 )

inlineexplicitconstexpr

Definition at line 19 of file donna128.h.

: m_lo(l), m_hi(h) {}

Referenced by operator&, operator+=(), operator+=(), operator<<, and operator>>.

Member Function Documentation

hi()

uint64_t Botan::donna128::hi ( ) const

inlineconstexpr

Definition at line 85 of file donna128.h.

{ return m_hi; }

Referenced by Botan::operator*(), Botan::operator|(), and Botan::operator|().

lo()

uint64_t Botan::donna128::lo ( ) const

inlineconstexpr

Definition at line 83 of file donna128.h.

{ return m_lo; }

Referenced by Botan::combine_lower(), operator uint64_t(), Botan::operator*(), Botan::operator|(), and Botan::operator|().

operator uint64_t()

Botan::donna128::operator uint64_t ( ) const

inlineexplicitconstexpr

Definition at line 87 of file donna128.h.

{ return lo(); }

References lo().

operator&=()

uint64_t Botan::donna128::operator&= ( uint64_t mask )

inlineconstexpr

Definition at line 61 of file donna128.h.

                                                   {
         m_hi = 0;
         m_lo &= mask;
         return m_lo;
      }

operator+=() [1/2]

donna128 & Botan::donna128::operator+= ( const donna128 & x )

inlineconstexpr

Definition at line 67 of file donna128.h.

                                                        {
         m_lo += x.m_lo;
         m_hi += x.m_hi;
 
         const uint64_t carry = CT::Mask<uint64_t>::is_lt(m_lo, x.m_lo).if_set_return(1);
         m_hi += carry;
         return *this;
      }

References Botan::carry(), donna128(), and Botan::CT::Mask< T >::is_lt().

operator+=() [2/2]

donna128 & Botan::donna128::operator+= ( uint64_t x )

inlineconstexpr

Definition at line 76 of file donna128.h.

                                                 {
         m_lo += x;
         const uint64_t carry = CT::Mask<uint64_t>::is_lt(m_lo, x).if_set_return(1);
         m_hi += carry;
         return *this;
      }

References Botan::carry(), donna128(), and Botan::CT::Mask< T >::is_lt().

Friends And Related Symbol Documentation

operator&

friend uint64_t operator& ( const donna128 & x, uint64_t mask )

friend

Definition at line 59 of file donna128.h.

{ return x.m_lo & mask; }

References donna128().

operator<<

template<std::unsigned_integral T>

friend donna128 operator<< ( const donna128 & x, T shift )

friend

Definition at line 42 of file donna128.h.

                                                                       {
         donna128 z = x;
         if(shift > 64) {
            z.m_hi = z.m_lo << (shift - 64);
            z.m_lo = 0;
         } else if(shift == 64) {
            z.m_hi = z.m_lo;
            z.m_lo = 0;
         } else if(shift > 0) {
            const uint64_t carry = z.m_lo >> static_cast<size_t>(64 - shift);
            z.m_lo = (z.m_lo << shift);
            z.m_hi = (z.m_hi << shift) | carry;
         }
 
         return z;
      }

References Botan::carry(), and donna128().

operator>>

template<std::unsigned_integral T>

friend donna128 operator>> ( const donna128 & x, T shift )

friend

Definition at line 22 of file donna128.h.

                                                                       {
         donna128 z = x;
 
         if(shift > 64) {
            z.m_lo = z.m_hi >> (shift - 64);
            z.m_hi = 0;
         } else if(shift == 64) {
            z.m_lo = z.m_hi;
            z.m_hi = 0;
         } else if(shift > 0) {
            const uint64_t carry = z.m_hi << static_cast<size_t>(64 - shift);
            z.m_hi >>= shift;
            z.m_lo >>= shift;
            z.m_lo |= carry;
         }
 
         return z;
      }

References Botan::carry(), and donna128().

---

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

• src/lib/utils/donna128.h