A container based on std::vector but with an upper bound. More...

#include <bounded_vector.hpp>

Inheritance diagram for rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >:

Collaboration diagram for rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >:

Public Member Functions
	BoundedVector () noexcept(std::is_nothrow_default_constructible< Alloc >::value)
	Create a BoundedVector with no elements. More...

	BoundedVector (const typename Base::allocator_type &a) noexcept
	Creates a BoundedVector with no elements. More...

	BoundedVector (typename Base::size_type n, const typename Base::allocator_type &a=allocator_type())
	Create a BoundedVector with default constructed elements. More...

	BoundedVector (typename Base::size_type n, const typename Base::value_type &value, const typename Base::allocator_type &a=allocator_type())
	Create a BoundedVector with copies of an exemplar element. More...

	BoundedVector (const BoundedVector &x)
	BoundedVector copy constructor. More...

	BoundedVector (BoundedVector &&x) noexcept
	BoundedVector move constructor. More...

	BoundedVector (const BoundedVector &x, const typename Base::allocator_type &a)
	Copy constructor with alternative allocator. More...

	BoundedVector (std::initializer_list< typename Base::value_type > l, const typename Base::allocator_type &a=typename Base::allocator_type())
	Build a BoundedVector from an initializer list. More...

template<typename InputIterator >
	BoundedVector (InputIterator first, InputIterator last, const typename Base::allocator_type &a=allocator_type())
	Build a BoundedVector from a range. More...

	~BoundedVector () noexcept
	The dtor only erases the elements. More...

BoundedVector &	operator= (const BoundedVector &x)
	BoundedVector assignment operator. More...

BoundedVector &	operator= (BoundedVector &&x)
	BoundedVector move assignment operator More...

BoundedVector &	operator= (std::initializer_list< typename Base::value_type > l)
	BoundedVector list assignment operator. More...

void	assign (typename Base::size_type n, const typename Base::value_type &val)
	Assign a given value to a BoundedVector. More...

template<typename InputIterator >
void	assign (InputIterator first, InputIterator last)
	Assign a range to a BoundedVector. More...

void	assign (std::initializer_list< typename Base::value_type > l)
	Assign an initializer list to a BoundedVector. More...

Base::size_type	max_size () const noexcept

void	resize (typename Base::size_type new_size)
	Resize the BoundedVector to the specified number of elements. More...

void	resize (typename Base::size_type new_size, const typename Base::value_type &x)
	Resize the BoundedVector to the specified number of elements. More...

void	reserve (typename Base::size_type n)
	Attempt to preallocate enough memory for specified number of elements. More...

template<typename T , typename std::enable_if< !std::is_same< T, Tp >::value &&!std::is_same< T, bool >::value >::type * = nullptr>
T *	data () noexcept
	Return a pointer such that [data(), data() + size()) is a valid range. More...

template<typename T , typename std::enable_if< !std::is_same< T, Tp >::value &&!std::is_same< T, bool >::value >::type * = nullptr>
const T *	data () const noexcept

void	push_back (const typename Base::value_type &x)
	Add data to the end of the BoundedVector. More...

void	push_back (typename Base::value_type &&x)

template<typename ... Args>
auto	emplace_back (Args &&... args)
	Add data to the end of the BoundedVector. More...

template<typename ... Args>
Base::iterator	emplace (typename Base::const_iterator position, Args &&... args)
	Insert an object in BoundedVector before specified iterator. More...

Base::iterator	insert (typename Base::const_iterator position, const typename Base::value_type &x)
	Insert given value into BoundedVector before specified iterator. More...

Base::iterator	insert (typename Base::const_iterator position, typename Base::value_type &&x)
	Insert given rvalue into BoundedVector before specified iterator. More...

Base::iterator	insert (typename Base::const_iterator position, std::initializer_list< typename Base::value_type > l)
	Insert an initializer_list into the BoundedVector. More...

Base::iterator	insert (typename Base::const_iterator position, typename Base::size_type n, const typename Base::value_type &x)
	Insert a number of copies of given data into the BoundedVector. More...

template<typename InputIterator >
Base::iterator	insert (typename Base::const_iterator position, InputIterator first, InputIterator last)
	Insert a range into the BoundedVector. More...

T	begin (T... args)

T	end (T... args)

T	rbegin (T... args)

T	rend (T... args)

T	cbegin (T... args)

T	cend (T... args)

T	crbegin (T... args)

T	crend (T... args)

T	size (T... args)

T	shrink_to_fit (T... args)

T	capacity (T... args)

T	empty (T... args)

T	at (T... args)

T	front (T... args)

T	back (T... args)

T	erase (T... args)

T	pop_back (T... args)

T	clear (T... args)

Friends
bool	operator== (const BoundedVector &x, const BoundedVector &y)
	Vector equality comparison. More...

bool	operator< (const BoundedVector &x, const BoundedVector &y)
	Vector ordering relation. More...

bool	operator!= (const BoundedVector &x, const BoundedVector &y)
	Based on operator==. More...

bool	operator> (const BoundedVector &x, const BoundedVector &y)
	Based on operator<. More...

bool	operator<= (const BoundedVector &x, const BoundedVector &y)
	Based on operator<. More...

bool	operator>= (const BoundedVector &x, const BoundedVector &y)
	Based on operator<. More...

Additional Inherited Members
Protected Member Functions inherited from std::vector< Tp, std::allocator< Tp > >
T	push_back (T... args)

T	crbegin (T... args)

T	erase (T... args)

T	data (T... args)

T	insert (T... args)

T	pop_back (T... args)

T	shrink_to_fit (T... args)

T	back (T... args)

T	end (T... args)

T	resize (T... args)

T	emplace_back (T... args)

T	size (T... args)

T	cbegin (T... args)

T	front (T... args)

T	~vector (T... args)

T	rbegin (T... args)

T	crend (T... args)

T	assign (T... args)

T	operator= (T... args)

T	vector (T... args)

T	reserve (T... args)

T	capacity (T... args)

T	empty (T... args)

T	cend (T... args)

T	swap (T... args)

T	max_size (T... args)

T	rend (T... args)

T	get_allocator (T... args)

T	clear (T... args)

T	at (T... args)

T	emplace (T... args)

T	operator[] (T... args)

T	begin (T... args)

Detailed Description

template<typename Tp, std::size_t UpperBound, typename Alloc = std::allocator<Tp>>
class rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >

A container based on std::vector but with an upper bound.

Meets the same requirements as std::vector.

Parameters

Tp	Type of element
UpperBound	The upper bound for the number of elements
Alloc	Allocator type, defaults to std::allocator<Tp>

Constructor & Destructor Documentation

◆ BoundedVector() [1/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector ( )

inlinenoexcept

Create a BoundedVector with no elements.

◆ BoundedVector() [2/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector ( const typename Base::allocator_type & a )

inlineexplicitnoexcept

Creates a BoundedVector with no elements.

Parameters

a	An allocator object

◆ BoundedVector() [3/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector	(	typename Base::size_type	n,
		const typename Base::allocator_type &	a = `allocator_type()`
	)

inlineexplicit

Create a BoundedVector with default constructed elements.

This constructor fills the BoundedVector with n default constructed elements.

Parameters

n	The number of elements to initially create
a	An allocator

◆ BoundedVector() [4/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector	(	typename Base::size_type	n,
		const typename Base::value_type &	value,
		const typename Base::allocator_type &	a = `allocator_type()`
	)

inline

Create a BoundedVector with copies of an exemplar element.

This constructor fills the BoundedVector with n copies of value.

Parameters

n	The number of elements to initially create
value	An element to copy
a	An allocator

◆ BoundedVector() [5/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector ( const BoundedVector< Tp, UpperBound, Alloc > & x )

inline

BoundedVector copy constructor.

The newly-created BoundedVector uses a copy of the allocation object used by x. All the elements of x are copied, but any extra memory in x (for fast expansion) will not be copied.

Parameters

x	A BoundedVector of identical element and allocator types

◆ BoundedVector() [6/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector ( BoundedVector< Tp, UpperBound, Alloc > && x )

inlinenoexcept

BoundedVector move constructor.

The newly-created BoundedVector contains the exact contents of x. The contents of x are a valid, but unspecified BoundedVector.

Parameters

x	A BoundedVector of identical element and allocator types

◆ BoundedVector() [7/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector	(	const BoundedVector< Tp, UpperBound, Alloc > &	x,
		const typename Base::allocator_type &	a
	)

inline

Copy constructor with alternative allocator.

◆ BoundedVector() [8/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector	(	std::initializer_list< typename Base::value_type >	l,
		const typename Base::allocator_type &	a = `typename Base::allocator_type()`
	)

inline

Build a BoundedVector from an initializer list.

Create a BoundedVector consisting of copies of the elements in the initializer_list l.

This will call the element type's copy constructor N times (where N is l.size()) and do no memory reallocation.

Parameters

l	An initializer_list
a	An allocator

◆ BoundedVector() [9/9]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

template<typename InputIterator >

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::BoundedVector	(	InputIterator	first,
		InputIterator	last,
		const typename Base::allocator_type &	a = `allocator_type()`
	)

inline

Build a BoundedVector from a range.

Create a BoundedVector consisting of copies of the elements from [first,last).

If the iterators are forward, bidirectional, or random-access, then this will call the elements' copy constructor N times (where N is distance(first,last)) and do no memory reallocation. But if only input iterators are used, then this will do at most 2N calls to the copy constructor, and logN memory reallocations.

Parameters

first	An input iterator
last	An input iterator
a	An allocator

◆ ~BoundedVector()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::~BoundedVector ( )

inlinenoexcept

The dtor only erases the elements.

Note that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.

Member Function Documentation

◆ operator=() [1/3]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

BoundedVector& rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::operator= ( const BoundedVector< Tp, UpperBound, Alloc > & x )

inline

BoundedVector assignment operator.

All the elements of x are copied, but any extra memory in x (for fast expansion) will not be copied. Unlike the copy constructor, the allocator object is not copied.

Parameters

x	A BoundedVector of identical element and allocator types

◆ operator=() [2/3]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

BoundedVector& rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::operator= ( BoundedVector< Tp, UpperBound, Alloc > && x )

inline

BoundedVector move assignment operator

Parameters

x	A BoundedVector of identical element and allocator types.

◆ operator=() [3/3]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

BoundedVector& rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::operator= ( std::initializer_list< typename Base::value_type > l )

inline

BoundedVector list assignment operator.

This function fills a BoundedVector with copies of the elements in the initializer list l.

Note that the assignment completely changes the BoundedVector and that the resulting BoundedVector's size is the same as the number of elements assigned. Old data may be lost.

Parameters

l	An initializer_list

◆ assign() [1/3]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::assign	(	typename Base::size_type	n,
		const typename Base::value_type &	val
	)

inline

Assign a given value to a BoundedVector.

This function fills a BoundedVector with n copies of the given value. Note that the assignment completely changes the BoundedVector and that the resulting BoundedVector's size is the same as the number of elements assigned. Old data may be lost.

Parameters

n	Number of elements to be assigned
val	Value to be assigned

◆ assign() [2/3]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

template<typename InputIterator >

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::assign	(	InputIterator	first,
		InputIterator	last
	)

inline

Assign a range to a BoundedVector.

This function fills a BoundedVector with copies of the elements in the range [first,last).

Note that the assignment completely changes the BoundedVector and that the resulting BoundedVector's size is the same as the number of elements assigned. Old data may be lost.

Parameters

first	An input iterator
last	An input iterator

◆ assign() [3/3]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::assign ( std::initializer_list< typename Base::value_type > l )

inline

Assign an initializer list to a BoundedVector.

This function fills a BoundedVector with copies of the elements in the initializer list l.

Note that the assignment completely changes the BoundedVector and that the resulting BoundedVector's size is the same as the number of elements assigned. Old data may be lost.

Parameters

l	An initializer_list

◆ max_size()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

Base::size_type rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::max_size ( ) const

inlinenoexcept

Returns the size() of the largest possible BoundedVector.

◆ resize() [1/2]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::resize ( typename Base::size_type new_size )

inline

Resize the BoundedVector to the specified number of elements.

This function will resize the BoundedVector to the specified number of elements. If the number is smaller than the BoundedVector's current size the BoundedVector is truncated, otherwise default constructed elements are appended.

Parameters

new_size Number of elements the BoundedVector should contain

◆ resize() [2/2]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::resize	(	typename Base::size_type	new_size,
		const typename Base::value_type &	x
	)

inline

Resize the BoundedVector to the specified number of elements.

This function will resize the BoundedVector to the specified number of elements. If the number is smaller than the BoundedVector's current size the BoundedVector is truncated, otherwise the BoundedVector is extended and new elements are populated with given data.

Parameters

new_size	Number of elements the BoundedVector should contain
x	Data with which new elements should be populated

◆ reserve()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::reserve ( typename Base::size_type n )

inline

Attempt to preallocate enough memory for specified number of elements.

This function attempts to reserve enough memory for the BoundedVector to hold the specified number of elements. If the number requested is more than max_size(), length_error is thrown.

The advantage of this function is that if optimal code is a necessity and the user can determine the number of elements that will be required, the user can reserve the memory in advance, and thus prevent a possible reallocation of memory and copying of BoundedVector data.

Parameters

n	Number of elements required

Exceptions

std::length_error If n exceeds max_size()

◆ data() [1/2]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

template<typename T , typename std::enable_if< !std::is_same< T, Tp >::value &&!std::is_same< T, bool >::value >::type * = nullptr>

T* rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::data ( )

inlinenoexcept

Return a pointer such that [data(), data() + size()) is a valid range.

For a non-empty BoundedVector, data() == &front().

◆ data() [2/2]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

template<typename T , typename std::enable_if< !std::is_same< T, Tp >::value &&!std::is_same< T, bool >::value >::type * = nullptr>

const T* rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::data ( ) const

inlinenoexcept

◆ push_back() [1/2]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::push_back ( const typename Base::value_type & x )

inline

Add data to the end of the BoundedVector.

This is a typical stack operation. The function creates an element at the end of the BoundedVector and assigns the given data to it. Due to the nature of a BoundedVector this operation can be done in constant time if the BoundedVector has preallocated space available.

Parameters

x	Data to be added

◆ push_back() [2/2]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

void rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::push_back ( typename Base::value_type && x )

inline

◆ emplace_back()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

template<typename ... Args>

auto rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::emplace_back ( Args &&... args )

inline

Add data to the end of the BoundedVector.

This is a typical stack operation. The function creates an element at the end of the BoundedVector and assigns the given data to it. Due to the nature of a BoundedVector this operation can be done in constant time if the BoundedVector has preallocated space available.

Parameters

args	Arguments to be forwarded to the constructor of Tp

◆ emplace()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

template<typename ... Args>

Base::iterator rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::emplace	(	typename Base::const_iterator	position,
		Args &&...	args
	)

inline

Insert an object in BoundedVector before specified iterator.

This function will insert an object of type T constructed with T(std::forward<Args>(args)...) before the specified location. Note that this kind of operation could be expensive for a BoundedVector and if it is frequently used the user should consider using std::list.

Parameters

position	A const_iterator into the BoundedVector
args	Arguments

Returns: An iterator that points to the inserted data

◆ insert() [1/5]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

Base::iterator rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::insert	(	typename Base::const_iterator	position,
		const typename Base::value_type &	x
	)

inline

Insert given value into BoundedVector before specified iterator.

This function will insert a copy of the given value before the specified location. Note that this kind of operation could be expensive for a BoundedVector and if it is frequently used the user should consider using std::list.

Parameters

position	A const_iterator into the BoundedVector
x	Data to be inserted

Returns: An iterator that points to the inserted data

◆ insert() [2/5]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

Base::iterator rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::insert	(	typename Base::const_iterator	position,
		typename Base::value_type &&	x
	)

inline

Insert given rvalue into BoundedVector before specified iterator.

This function will insert a copy of the given rvalue before the specified location. Note that this kind of operation could be expensive for a BoundedVector and if it is frequently used the user should consider using std::list.

Parameters

position	A const_iterator into the BoundedVector
x	Data to be inserted

Returns: An iterator that points to the inserted data

◆ insert() [3/5]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

Base::iterator rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::insert	(	typename Base::const_iterator	position,
		std::initializer_list< typename Base::value_type >	l
	)

inline

Insert an initializer_list into the BoundedVector.

This function will insert copies of the data in the initializer_list l into the BoundedVector before the location specified by position.

Note that this kind of operation could be expensive for a BoundedVector and if it is frequently used the user should consider using std::list.

Parameters

position	An iterator into the BoundedVector
l	An initializer_list

◆ insert() [4/5]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

Base::iterator rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::insert	(	typename Base::const_iterator	position,
		typename Base::size_type	n,
		const typename Base::value_type &	x
	)

inline

Insert a number of copies of given data into the BoundedVector.

This function will insert a specified number of copies of the given data before the location specified by position.

Note that this kind of operation could be expensive for a BoundedVector and if it is frequently used the user should consider using std::list.

Parameters

position	A const_iterator into the BoundedVector
n	Number of elements to be inserted
x	Data to be inserted

Returns: An iterator that points to the inserted data

◆ insert() [5/5]

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

template<typename InputIterator >

Base::iterator rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >::insert	(	typename Base::const_iterator	position,
		InputIterator	first,
		InputIterator	last
	)

inline

Insert a range into the BoundedVector.

This function will insert copies of the data in the range [first,last) into the BoundedVector before the location specified by pos.

Note that this kind of operation could be expensive for a BoundedVector and if it is frequently used the user should consider using std::list.

Parameters

position	A const_iterator into the BoundedVector
first	An input iterator
last	An input iterator

Returns: An iterator that points to the inserted data

◆ begin()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::begin

◆ end()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::end

◆ rbegin()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::rbegin

◆ rend()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::rend

◆ cbegin()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::cbegin

◆ cend()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::cend

◆ crbegin()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::crbegin

◆ crend()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::crend

◆ size()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::size

◆ shrink_to_fit()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::shrink_to_fit

◆ capacity()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::capacity

◆ empty()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::empty

◆ at()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::at

◆ front()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::front

◆ back()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::back

◆ erase()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::erase

◆ pop_back()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::pop_back

◆ clear()

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

T std::vector::clear

Friends And Related Function Documentation

◆ operator==

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

bool operator==	(	const BoundedVector< Tp, UpperBound, Alloc > &	x,
		const BoundedVector< Tp, UpperBound, Alloc > &	y
	)

friend

Vector equality comparison.

This is an equivalence relation. It is linear in the size of the vectors. Vectors are considered equivalent if their sizes are equal, and if corresponding elements compare equal.

Parameters

x	A BoundedVector
y	A BoundedVector of the same type as x

Returns: True if the size and elements of the vectors are equal

◆ operator<

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

bool operator<	(	const BoundedVector< Tp, UpperBound, Alloc > &	x,
		const BoundedVector< Tp, UpperBound, Alloc > &	y
	)

friend

Vector ordering relation.

This is a total ordering relation. It is linear in the size of the vectors. The elements must be comparable with <.

See std::lexicographical_compare() for how the determination is made.

Parameters

x	A BoundedVector
y	A BoundedVector of the same type as x

Returns: True if x is lexicographically less than y

◆ operator!=

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

bool operator!=	(	const BoundedVector< Tp, UpperBound, Alloc > &	x,
		const BoundedVector< Tp, UpperBound, Alloc > &	y
	)

friend

Based on operator==.

◆ operator>

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

bool operator>	(	const BoundedVector< Tp, UpperBound, Alloc > &	x,
		const BoundedVector< Tp, UpperBound, Alloc > &	y
	)

friend

Based on operator<.

◆ operator<=

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

bool operator<=	(	const BoundedVector< Tp, UpperBound, Alloc > &	x,
		const BoundedVector< Tp, UpperBound, Alloc > &	y
	)

friend

Based on operator<.

◆ operator>=

template<typename Tp , std::size_t UpperBound, typename Alloc = std::allocator<Tp>>

bool operator>=	(	const BoundedVector< Tp, UpperBound, Alloc > &	x,
		const BoundedVector< Tp, UpperBound, Alloc > &	y
	)

friend

Based on operator<.

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

include/rosidl_runtime_cpp/bounded_vector.hpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<typename Tp, std::size_t UpperBound, typename Alloc = std::allocator<Tp>> class rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >

Constructor & Destructor Documentation

◆ BoundedVector() [1/9]

◆ BoundedVector() [2/9]

◆ BoundedVector() [3/9]

◆ BoundedVector() [4/9]

◆ BoundedVector() [5/9]

◆ BoundedVector() [6/9]

◆ BoundedVector() [7/9]

◆ BoundedVector() [8/9]

◆ BoundedVector() [9/9]

◆ ~BoundedVector()

Member Function Documentation

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ assign() [1/3]

◆ assign() [2/3]

◆ assign() [3/3]

◆ max_size()

◆ resize() [1/2]

◆ resize() [2/2]

◆ reserve()

◆ data() [1/2]

◆ data() [2/2]

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ emplace_back()

◆ emplace()

◆ insert() [1/5]

◆ insert() [2/5]

◆ insert() [3/5]

◆ insert() [4/5]

◆ insert() [5/5]

◆ begin()

◆ end()

◆ rbegin()

◆ rend()

◆ cbegin()

◆ cend()

◆ crbegin()

◆ crend()

◆ size()

◆ shrink_to_fit()

◆ capacity()

◆ empty()

◆ at()

◆ front()

◆ back()

◆ erase()

◆ pop_back()

◆ clear()

Friends And Related Function Documentation

◆ operator==

◆ operator<

◆ operator!=

◆ operator>

◆ operator<=

◆ operator>=

template<typename Tp, std::size_t UpperBound, typename Alloc = std::allocator<Tp>>
class rosidl_runtime_cpp::BoundedVector< Tp, UpperBound, Alloc >