Container to hold a memory allocation. More...

#include <allocator.h>

Collaboration diagram for fennec::allocation< T, AllocT >:

Detailed Description

template<typename T, class AllocT = allocator<T>>
struct fennec::allocation< T, AllocT >

Template Parameters

T	The data type of the allocation

This simply acts as a proxy for allocating memory. It does not call any constructors or initialize any values as if they were the provided data type. Any operations present work only on individual bytes.

Public Types
using	alloc_t = typename allocator_traits< AllocT >::template rebind< T >
	alias for the allocator type

using	value_t = T
	alias for the data type

using	size_t = size_t
	size type definition for ptr_traits

using	diff_t = ptrdiff_t
	diff type definition for ptr_traits

Public Member Functions
constexpr	allocation () noexcept
	Default Constructor, initializes internal data to `null` and the capacity to `0`

constexpr	allocation (size_t n) noexcept
	Sized Constructor, initializes the allocation with a block of size `n * sizeof(T)` bytes.

constexpr	allocation (const T *data, size_t n)
	Buffer Copy Constructor, initializes the allocation with a block of size `n * sizeof(T)` bytes. Then, the contents of data are byte copied into the allocation.

constexpr	allocation (size_t n, align_t align) noexcept
	Sized Constructor, initializes the allocation with a block of size `n * sizeof(T)` bytes.

constexpr	allocation (const T *data, size_t n, align_t align)
	Buffer Copy Constructor, initializes the allocation with a block of size `n * sizeof(T)` bytes. Then, the contents of data are byte copied into the allocation.

constexpr	allocation (const alloc_t &alloc) noexcept
	Allocator Constructor.

constexpr	allocation (size_t n, const alloc_t &alloc) noexcept
	Sized Allocator Constructor.

constexpr	allocation (const T *data, size_t n, const alloc_t &alloc)
	Buffer Copy Allocator Constructor, initializes the allocation with a block of size `n * sizeof(T)` bytes. Then, the contents of data are copied into the allocation.

constexpr	allocation (size_t n, align_t align, const alloc_t &alloc) noexcept
	Sized Allocator Constructor.

constexpr	allocation (const T *data, size_t n, align_t align, const alloc_t &alloc)
	Buffer Copy Allocator Constructor, initializes the allocation with a block of size `n * sizeof(T)` bytes. Then, the contents of data are copied into the allocation.

constexpr	allocation (const allocation &alloc) noexcept
	Copy Constructor, creates an allocation of equal size and performs a byte-wise copy.

constexpr	allocation (allocation &&alloc) noexcept
	Move Constructor, moves the data in `alloc` to the new object and cleans `alloc` so that it can safely destruct.

constexpr	~allocation () noexcept
	Default Destructor, releases the memory block if still present.

constexpr allocation &	operator= (const allocation &alloc)
	Copy Assignment Operator.

constexpr allocation &	operator= (allocation &&alloc) noexcept
	Move Assignment Operator.

constexpr void	allocate (size_t n, align_t align=zero< align_t >()) noexcept
	Allocate a block of memory for the allocation. If there is already an allocated block of memory, the previous allocation is released.

constexpr void	callocate (size_t n, align_t align=zero< align_t >()) noexcept
	Allocate a block of memory for the allocation. If there is already an allocated block of memory, the previous allocation is released.

constexpr void	deallocate () noexcept
	Release the block of memory.

constexpr void	reallocate (size_t n, align_t align=zero< align_t >()) noexcept
	Reallocate the block with a new size. Contents are copied to the new allocation.

constexpr void	creallocate (size_t n, align_t align=zero< align_t >()) noexcept
	Reallocate the block with a new size. Contents are copied to the new allocation.

constexpr void	clear () noexcept
	Clear the block of memory, setting all bytes to 0.

constexpr size_t	size () const
	Getter for the byte size of the allocation.

constexpr size_t	capacity () const
	Getter for the number of elements `n` of type `T` that the allocation can hold.

constexpr value_t *	data ()
	Getter for the real pointer to the allocated block of memory.

constexpr const value_t *	data () const
	Getter for the real pointer to the allocated block of memory.

Constructor & Destructor Documentation

◆ allocation() [1/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation ( size_t n )

inlineexplicitconstexprnoexcept

Parameters

n	The number of elements of type `T` to allocate for

◆ allocation() [2/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation	(	const T *	data,
		size_t	n
	)

inlineconstexpr

Parameters

data	the buffer to copy
n	the number of elements

◆ allocation() [3/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation	(	size_t	n,
		align_t	align
	)

inlineconstexprnoexcept

Parameters

n	The number of elements of type `T` to allocate for
align	The alignment of the allocation

◆ allocation() [4/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation	(	const T *	data,
		size_t	n,
		align_t	align
	)

inlineconstexpr

Parameters

data	the buffer to copy
n	the number of elements
align	The alignment of the allocation

◆ allocation() [5/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation ( const alloc_t & alloc )

inlineexplicitconstexprnoexcept

Parameters

alloc The allocation object to copy.

This constructor should be used when the type AllocT needs internal data.

◆ allocation() [6/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation	(	size_t	n,
		const alloc_t &	alloc
	)

inlineconstexprnoexcept

Parameters

n	The number of elements of type `T` to allocate for
alloc	The allocation object to copy.

This constructor should be used when the type AllocT needs internal data.

◆ allocation() [7/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation	(	const T *	data,
		size_t	n,
		const alloc_t &	alloc
	)

inlineconstexpr

Parameters

data	the buffer to copy
n	the number of elements
alloc	The allocation object to copy.

This constructor should be used when the type AllocT needs internal data.

◆ allocation() [8/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation	(	size_t	n,
		align_t	align,
		const alloc_t &	alloc
	)

inlineconstexprnoexcept

Parameters

n	The number of elements of type `T` to allocate for
align	The alignment of the allocation
alloc	The allocation object to copy.

This constructor should be used when the type AllocT needs internal data.

◆ allocation() [9/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation	(	const T *	data,
		size_t	n,
		align_t	align,
		const alloc_t &	alloc
	)

inlineconstexpr

Parameters

data	the buffer to copy
n	the number of elements
align	The alignment of the allocation
alloc	The allocation object to copy.

This constructor should be used when the type AllocT needs internal data.

◆ allocation() [10/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation ( const allocation< T, AllocT > & alloc )

inlineconstexprnoexcept

Parameters

alloc The allocation to copy

◆ allocation() [11/11]

template<typename T , class AllocT = allocator<T>>

constexpr fennec::allocation< T, AllocT >::allocation ( allocation< T, AllocT > && alloc )

inlineconstexprnoexcept

Parameters

alloc The allocation to move

Member Function Documentation

◆ operator=() [1/2]

template<typename T , class AllocT = allocator<T>>

constexpr allocation & fennec::allocation< T, AllocT >::operator= ( const allocation< T, AllocT > & alloc )

inlineconstexpr

Parameters

alloc the allocation to copy

Returns: a reference to this

◆ operator=() [2/2]

template<typename T , class AllocT = allocator<T>>

constexpr allocation & fennec::allocation< T, AllocT >::operator= ( allocation< T, AllocT > && alloc )

inlineconstexprnoexcept

Parameters

alloc the allocation to copy

Returns: a reference to this

◆ allocate()

template<typename T , class AllocT = allocator<T>>

constexpr void fennec::allocation< T, AllocT >::allocate	(	size_t	n,
		align_t	align = `zero<align_t>()`
	)

inlineconstexprnoexcept

Parameters

n	The number of elements of type `T` to allocate for

◆ callocate()

template<typename T , class AllocT = allocator<T>>

constexpr void fennec::allocation< T, AllocT >::callocate	(	size_t	n,
		align_t	align = `zero<align_t>()`
	)

inlineconstexprnoexcept

Parameters

n	The number of elements of type `T` to allocate for

◆ size()

template<typename T , class AllocT = allocator<T>>

constexpr size_t fennec::allocation< T, AllocT >::size ( ) const

inlineconstexpr

Returns: the size of the allocation in bytes

◆ capacity()

template<typename T , class AllocT = allocator<T>>

constexpr size_t fennec::allocation< T, AllocT >::capacity ( ) const

inlineconstexpr

Returns: the size of the allocation in elements

◆ data() [1/2]

template<typename T , class AllocT = allocator<T>>

constexpr value_t * fennec::allocation< T, AllocT >::data ( )

inlineconstexpr

Returns: Pointer to the allocated memory.

◆ data() [2/2]

template<typename T , class AllocT = allocator<T>>

constexpr const value_t * fennec::allocation< T, AllocT >::data ( ) const

inlineconstexpr

Returns: Pointer to the allocated memory.

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

include/fennec/memory/allocator.h

Detailed Description

Public Types

Public Member Functions

Constructor & Destructor Documentation

◆ allocation() [1/11]

◆ allocation() [2/11]

◆ allocation() [3/11]

◆ allocation() [4/11]

◆ allocation() [5/11]

◆ allocation() [6/11]

◆ allocation() [7/11]

◆ allocation() [8/11]

◆ allocation() [9/11]

◆ allocation() [10/11]

◆ allocation() [11/11]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ allocate()

◆ callocate()

◆ size()

◆ capacity()

◆ data() [1/2]

◆ data() [2/2]