Represents the size of an allocation in different units. More...

#include <allocation_size.h>

Public Member Functions
constexpr	AllocationSize ()=default
	Create a zero allocation size. More...

template<class T , class = std::enable_if_t<std::is_arithmetic_v<T>>>
constexpr	AllocationSize (T size)
	Create an allocation size with the amount in the `Period` number of bytes. More...

template<size_t OtherPeriod>
constexpr	AllocationSize (const AllocationSize< OtherPeriod > &other)
	Create an allocation size from another instance with a different period. More...

constexpr	AllocationSize (uint64_t byte_size, FromBytesTag)
	Create an allocation size with the amount directly specified in bytes. More...

constexpr uint64_t	GetByteSize () const

constexpr double	GetSize () const

template<class AllocationSize >
constexpr AllocationSize	ConvertTo ()
	Convert the allocation size from one unit to another. More...

constexpr bool	operator< (const AllocationSize &other) const

constexpr bool	operator> (const AllocationSize &other) const

constexpr bool	operator>= (const AllocationSize &other) const

constexpr bool	operator<= (const AllocationSize &other) const

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

constexpr bool	operator!= (const AllocationSize &other) const

constexpr	operator bool () const

constexpr AllocationSize	operator+ (const AllocationSize &other) const

constexpr AllocationSize	operator- (const AllocationSize &other) const

constexpr AllocationSize &	operator+= (const AllocationSize &other)

constexpr AllocationSize &	operator-= (const AllocationSize &other)

Detailed Description

template<size_t Period>
class impeller::AllocationSize< Period >

Represents the size of an allocation in different units.

        Refer to the typedefs for Bytes, KiloBytes, MegaBytes,
        Gigabytes, KibiBytes, MebiBytes, and GibiBytes below when using.

        Storage and all operations are always on unsigned units of
        bytes.

Template Parameters

Period The number of bytes in 1 unit of the allocation size.

Definition at line 29 of file allocation_size.h.

Constructor & Destructor Documentation

◆ AllocationSize() [1/4]

template<size_t Period>

constexpr impeller::AllocationSize< Period >::AllocationSize ( )

constexprdefault

Create a zero allocation size.

Referenced by impeller::AllocationSize< Period >::operator+(), and impeller::AllocationSize< Period >::operator-().

◆ AllocationSize() [2/4]

template<size_t Period>

template<class T , class = std::enable_if_t<std::is_arithmetic_v<T>>>

constexpr impeller::AllocationSize< Period >::AllocationSize ( T size )

inlineexplicitconstexpr

Create an allocation size with the amount in the Period number of bytes.

Parameters

[in] size The size in Period number of bytes.

Definition at line 43 of file allocation_size.h.

44 : bytes_(std::ceil(size) * Period) {}

◆ AllocationSize() [3/4]

template<size_t Period>

template<size_t OtherPeriod>

constexpr impeller::AllocationSize< Period >::AllocationSize ( const AllocationSize< OtherPeriod > & other )

inlineexplicitconstexpr

Create an allocation size from another instance with a different period.

Parameters

[in] other The other allocation size.

Template Parameters

OtherPeriod The period of the other allocation.

Definition at line 55 of file allocation_size.h.

56 : bytes_(other.GetByteSize()) {}

◆ AllocationSize() [4/4]

template<size_t Period>

constexpr impeller::AllocationSize< Period >::AllocationSize	(	uint64_t	byte_size,
		FromBytesTag
	)

inlineconstexpr

Create an allocation size with the amount directly specified in bytes.

Parameters

[in]	byte_size	The byte size.
[in]	tag	A tag for this constructor.

Definition at line 65 of file allocation_size.h.

66 : bytes_(byte_size) {}

Member Function Documentation

◆ ConvertTo()

template<size_t Period>

template<class AllocationSize >

constexpr AllocationSize impeller::AllocationSize< Period >::ConvertTo ( )

inlineconstexpr

Convert the allocation size from one unit to another.

        Conversions are non-truncating.

Template Parameters

AllocationSize The allocation size to convert to.

Returns: The new allocation size.

Definition at line 90 of file allocation_size.h.

                                        {
     return AllocationSize{GetByteSize(), FromBytesTag::kFromBytes};
   }

References impeller::AllocationSize< Period >::GetByteSize(), and impeller::kFromBytes.

◆ GetByteSize()

template<size_t Period>

constexpr uint64_t impeller::AllocationSize< Period >::GetByteSize ( ) const

inlineconstexpr

Returns: The byte size.

Definition at line 71 of file allocation_size.h.

71 { return bytes_; }

Referenced by impeller::AllocationSize< Period >::ConvertTo(), impeller::CreateMappingWithCopy(), impeller::AllocationSize< Period >::GetSize(), impeller::AllocationSize< Period >::operator+(), impeller::AllocationSize< Period >::operator+=(), impeller::AllocationSize< Period >::operator-(), impeller::AllocationSize< Period >::operator-=(), and impeller::testing::TEST().

◆ GetSize()

template<size_t Period>

constexpr double impeller::AllocationSize< Period >::GetSize ( ) const

inlineconstexpr

Returns: The number of Periods of bytes.

Definition at line 76 of file allocation_size.h.

                                    {
     return GetByteSize() / static_cast<double>(Period);
   }

References impeller::AllocationSize< Period >::GetByteSize().

Referenced by impeller::testing::TEST(), and impeller::testing::TEST_P().

◆ operator bool()

template<size_t Period>

constexpr impeller::AllocationSize< Period >::operator bool ( ) const

inlineexplicitconstexpr

Definition at line 123 of file allocation_size.h.

123 { return bytes_ != 0u; }

◆ operator!=()

template<size_t Period>

constexpr bool impeller::AllocationSize< Period >::operator!= ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 117 of file allocation_size.h.

                                                                {
     return bytes_ != other.bytes_;
   }

◆ operator+()

template<size_t Period>

constexpr AllocationSize impeller::AllocationSize< Period >::operator+ ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 127 of file allocation_size.h.

                                                                         {
     return AllocationSize(bytes_ + other.GetByteSize(),
                           FromBytesTag::kFromBytes);
   }

References impeller::AllocationSize< Period >::AllocationSize(), impeller::AllocationSize< Period >::GetByteSize(), and impeller::kFromBytes.

◆ operator+=()

template<size_t Period>

constexpr AllocationSize& impeller::AllocationSize< Period >::operator+= ( const AllocationSize< Period > & other )

inlineconstexpr

Definition at line 137 of file allocation_size.h.

                                                                     {
     bytes_ += other.GetByteSize();
     return *this;
   }

References impeller::AllocationSize< Period >::GetByteSize().

◆ operator-()

template<size_t Period>

constexpr AllocationSize impeller::AllocationSize< Period >::operator- ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 132 of file allocation_size.h.

                                                                         {
     return AllocationSize(bytes_ - other.GetByteSize(),
                           FromBytesTag::kFromBytes);
   }

References impeller::AllocationSize< Period >::AllocationSize(), impeller::AllocationSize< Period >::GetByteSize(), and impeller::kFromBytes.

◆ operator-=()

template<size_t Period>

constexpr AllocationSize& impeller::AllocationSize< Period >::operator-= ( const AllocationSize< Period > & other )

inlineconstexpr

Definition at line 142 of file allocation_size.h.

                                                                     {
     bytes_ -= other.GetByteSize();
     return *this;
   }

References impeller::AllocationSize< Period >::GetByteSize().

◆ operator<()

template<size_t Period>

constexpr bool impeller::AllocationSize< Period >::operator< ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 97 of file allocation_size.h.

                                                               {
     return bytes_ < other.bytes_;
   }

◆ operator<=()

template<size_t Period>

constexpr bool impeller::AllocationSize< Period >::operator<= ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 109 of file allocation_size.h.

                                                                {
     return bytes_ <= other.bytes_;
   }

◆ operator==()

template<size_t Period>

constexpr bool impeller::AllocationSize< Period >::operator== ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 113 of file allocation_size.h.

                                                                {
     return bytes_ == other.bytes_;
   }

◆ operator>()

template<size_t Period>

constexpr bool impeller::AllocationSize< Period >::operator> ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 101 of file allocation_size.h.

                                                               {
     return bytes_ > other.bytes_;
   }

◆ operator>=()

template<size_t Period>

constexpr bool impeller::AllocationSize< Period >::operator>= ( const AllocationSize< Period > & other ) const

inlineconstexpr

Definition at line 105 of file allocation_size.h.

                                                                {
     return bytes_ >= other.bytes_;
   }

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

impeller/base/allocation_size.h

Public Member Functions

Detailed Description

template<size_t Period> class impeller::AllocationSize< Period >

Constructor & Destructor Documentation

◆ AllocationSize() [1/4]

◆ AllocationSize() [2/4]

◆ AllocationSize() [3/4]

◆ AllocationSize() [4/4]

Member Function Documentation

◆ ConvertTo()

◆ GetByteSize()

◆ GetSize()

◆ operator bool()

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

template<size_t Period>
class impeller::AllocationSize< Period >