eprosima::safedds::memory Namespace Reference

Namespaces
	byte_array
	container

Classes
class	Bitmap
	Template StandardLayout structure to hold a range of items using a custom bitmap. More...
interface	IBaseBitmapSet
	Interface class with the common const methods of Bitmap. More...
interface	IByteArrayView
	IByteArrayView interface. More...
interface	IConstByteArrayView
	Provides a const interface on an existing memory block. More...
interface	IConstMutableByteArrayView
	Provides a const and mutable interface on an existing memory block. More...
interface	IContainerBase
	Container base interface. More...
interface	IList
	List-like data structure. More...
interface	IMap
	Map-like data structure. More...
interface	IMapBase
	Base methods for map-like container. More...
interface	IMutableByteArrayView
	Allows internal modifications on an existing IByteArrayView. More...
interface	IReferenceList
	List-like data structure of references. More...
interface	IReferenceMap
	Map-like data structure of references. More...
class	IRemovableBitmapSet
	Interface class with the remove method of Bitmap. More...
interface	ISet
	Set-like data structure. More...
class	ISortedList
	LinkedList data structure interface. The list is sorted from lowest (position 0) to highest (position size() - 1) values. More...
interface	IStringView
	Provides a view on top of a string. More...
struct	Optional
	Template structure to hold an optional type. More...
struct	Pair
	Template structure to hold a pair of values. More...

Functions
void *	pointer_alignment (const void *ptr, const uint32_t required_alignment, uint32_t &bytes_moved) noexcept
	Gets a pointer and return the next aligned pointer given a required alignment. The function also returns the number of bytes moved as an output parameter. More...
uint32_t	align_to (uint32_t v, uint32_t s) noexcept
	gets the aligned position for the current index and element size. More...
template<uint32_t T, uint32_t S>
constexpr uint32_t	align_to () noexcept
	gets the aligned position for the current index and element size at build time More...
template<class T , uint32_t NLONGS>
bool	operator== (const Bitmap< T, NLONGS > &first, const Bitmap< T, NLONGS > &second) noexcept
	Operator== for Bitmap objects. More...
template<class T , uint32_t NLONGS>
bool	operator!= (const Bitmap< T, NLONGS > &first, const Bitmap< T, NLONGS > &second) noexcept
	Operator!= for Bitmap objects. More...
bool	compare (const IStringView &lhs, const IStringView &rhs)
	Compare content of two IStringView. More...

Variables
constexpr uint32_t	BITMAP_BIT_SIZE = 256U
	Default Bitmap bit size. More...
constexpr uint32_t	BITMAP_LONG_SIZE = BITMAP_BIT_SIZE / portable::BITS_IN_LONG
	Default Bitmap long size. More...
constexpr uint32_t	MAP_MAX_CAPACITY = UINT32_MAX
	Max capacity to return on implementations that do not have capacity limit. More...

Function Documentation

align_to() [1/2]

template<uint32_t T, uint32_t S>

constexpr uint32_t eprosima::safedds::memory::align_to ( )

constexprnoexcept

gets the aligned position for the current index and element size at build time

Template Parameters

T	index of the value.
S	size, size MUST be power of 2.

Returns

Alignment.

align_to() [2/2]

uint32_t eprosima::safedds::memory::align_to ( uint32_t  v, uint32_t  s  )

inlinenoexcept

gets the aligned position for the current index and element size.

Parameters

v	index of the value.
s	size, size MUST be power of 2.

Returns

Alignment.

compare()

bool eprosima::safedds::memory::compare ( const IStringView &  lhs, const IStringView &  rhs  )

inline

Compare content of two IStringView.

Parameters

[in]	lhs	left side string view.
[in]	rhs	right side string view.

Returns

true if both string are equals.

operator!=()

template<class T , uint32_t NLONGS>

bool eprosima::safedds::memory::operator!= ( const Bitmap< T, NLONGS > &  first, const Bitmap< T, NLONGS > &  second  )

noexcept

Operator!= for Bitmap objects.

Parameters

first	first Bitmap to compare.
second	second Bitmap to compare.

Returns

True if Bitmap are different, false otherwise.

operator==()

template<class T , uint32_t NLONGS>

bool eprosima::safedds::memory::operator== ( const Bitmap< T, NLONGS > &  first, const Bitmap< T, NLONGS > &  second  )

noexcept

Operator== for Bitmap objects.

Parameters

first	first Bitmap to compare.
second	second Bitmap to compare.

Returns

True if Bitmap are equal, false otherwise.

pointer_alignment()

void* eprosima::safedds::memory::pointer_alignment ( const void *  ptr, const uint32_t  required_alignment, uint32_t &  bytes_moved  )

inlinenoexcept

Gets a pointer and return the next aligned pointer given a required alignment. The function also returns the number of bytes moved as an output parameter.

Parameters

ptr	pointer to align.
required_alignment	required alignment.
bytes_moved	bytes moved.

Returns

Aligned pointer.

Variable Documentation

BITMAP_BIT_SIZE

constexpr uint32_t eprosima::safedds::memory::BITMAP_BIT_SIZE = 256U

constexpr

Default Bitmap bit size.

BITMAP_LONG_SIZE

constexpr uint32_t eprosima::safedds::memory::BITMAP_LONG_SIZE = BITMAP_BIT_SIZE / portable::BITS_IN_LONG

constexpr

Default Bitmap long size.

MAP_MAX_CAPACITY

constexpr uint32_t eprosima::safedds::memory::MAP_MAX_CAPACITY = UINT32_MAX

constexpr

Max capacity to return on implementations that do not have capacity limit.