impeller::AllocationSize< Period > Class Template Reference

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.
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.
template<size_t OtherPeriod>
constexpr	AllocationSize (const AllocationSize< OtherPeriod > &other)
	Create an allocation size from another instance with a different period.
constexpr	AllocationSize (uint64_t byte_size, FromBytesTag)
	Create an allocation size with the amount directly specified in bytes.
constexpr uint64_t	GetByteSize () const
constexpr double	GetSize () const
template<class AllocationSize >
constexpr AllocationSize	ConvertTo ()
	Convert the allocation size from one unit to another.
constexpr auto	operator<=> (const AllocationSize &other) const =default
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 30 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 44 of file allocation_size.h.

      : 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 56 of file allocation_size.h.

      : 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 66 of file allocation_size.h.

      : 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 91 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 72 of file allocation_size.h.

{ return bytes_; }

Referenced by impeller::AllocationSize< Period >::ConvertTo(), 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 77 of file allocation_size.h.

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

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

Referenced by impeller::testing::TEST().

operator bool()

template<size_t Period>

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

inlineexplicitconstexpr

Definition at line 101 of file allocation_size.h.

{ return bytes_ != 0u; }

operator+()

template<size_t Period>

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

inlineconstexpr

Definition at line 105 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 115 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 110 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 120 of file allocation_size.h.

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

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

operator<=>()

template<size_t Period>

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

constexprdefault

---

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

• impeller/base/allocation_size.h