#include <vector.h>

Inheritance diagram for hilti::rt::Vector< T, Allocator >:

Public Types
using	V = std::vector< T, Allocator >

using	size_type = integer::safe< uint64_t >

using	reference = T &

using	const_reference = const T &

using	iterator = vector::Iterator< T, Allocator >

using	const_iterator = vector::ConstIterator< T, Allocator >

using	C = std::shared_ptr< Vector * >

using	Control = control::Block< Vector< T, Allocator >, InvalidIterator >

Public Member Functions
	Vector (const Vector &other)

	Vector (Vector &&other) noexcept

	Vector (std::initializer_list< T > init, const Allocator &alloc=Allocator())

const T &	front () const

const T &	back () const

void	pop_back ()

const_iterator	iteratorAt (uint64_t i) const

Vector< T >	sub (uint64_t start, uint64_t end) const

Vector< T >	sub (uint64_t end) const

Vector &	operator= (const Vector &other)

Vector &	operator= (Vector &&other) noexcept

const T &	operator[] (uint64_t i) const &

T	operator[] (uint64_t i) &&

T &	operator[] (uint64_t i) &

void	assign (uint64_t i, T x)

Vector	operator+ (const Vector &other) const

Vector &	operator+= (const Vector &other)

iterator	insert (iterator pos, const T &value)

auto	begin ()

auto	end ()

auto	begin () const

auto	end () const

auto	cbegin () const

auto	cend () const

auto	unsafeBegin () const

auto	unsafeEnd () const

size_type	size () const

Friends
bool	operator== (const Vector &a, const Vector &b)

Detailed Description

template<typename T, typename Allocator>
class hilti::rt::Vector< T, Allocator >

HILTI's Vector is a std::vector-like type with additional safety guarantees.

In particular it guarantees that

bounds checking for subscript element access
iterators remain valid when elements are added, removed, or the whole Vector is reassigned.

If not otherwise specified, member functions have the semantics of std::vector member functions.

Member Function Documentation

◆ assign()

template<typename T , typename Allocator >

void hilti::rt::Vector< T, Allocator >::assign	(	uint64_t	i,
		T	x
	)

inline

Assigns a value to an element.

If the element is not present in the vector, it is resized to contain at i + 1 values. The other added values are default-initialized.

Parameters

i	position of the element to assign
x	value to assign

◆ back()

template<typename T , typename Allocator >

const T& hilti::rt::Vector< T, Allocator >::back ( ) const

inline

Returns the last element of the vector.

Returns: a reference to the last element

Exceptions

<tt>IndexError</tt> if the Vector is empty

◆ front()

template<typename T , typename Allocator >

const T& hilti::rt::Vector< T, Allocator >::front ( ) const

inline

Returns the first element of the vector.

Returns: a reference to the last element

Exceptions

<tt>IndexError</tt> if the Vector is empty

◆ insert()

template<typename T , typename Allocator >

iterator hilti::rt::Vector< T, Allocator >::insert	(	iterator	pos,
		const T &	value
	)

inline

Inserts value before a given position.

Parameters

pos	iterator to the position preceding the inserted value
value	value to insert

Returns: iterator pointing to the inserted element

◆ iteratorAt()

template<typename T , typename Allocator >

const_iterator hilti::rt::Vector< T, Allocator >::iteratorAt ( uint64_t i ) const

inline

Returns an iterator referring to a specific element.

Parameters

i	index of element

Exceptions

<tt>IndexError</tt> if the i is out of range.

◆ operator+()

template<typename T , typename Allocator >

Vector hilti::rt::Vector< T, Allocator >::operator+ ( const Vector< T, Allocator > & other ) const

inline

Concatenates this Vector and another Vector.

Parameters

other the other Vector to append

Returns: the concatenation of this Vector and the other Vector

◆ operator+=()

template<typename T , typename Allocator >

Vector& hilti::rt::Vector< T, Allocator >::operator+= ( const Vector< T, Allocator > & other )

inline

Appends a Vector in place.

Parameters

other the Vector to append

Returns: a reference to the modified Vector

◆ operator=() [1/2]

template<typename T , typename Allocator >

Vector& hilti::rt::Vector< T, Allocator >::operator= ( const Vector< T, Allocator > & other )

inline

Replaces the contents of this Vector with another Vector.

In contrast to assignments of std::vector iterators remain valid and after assignment will point to positions in the assigned vector.

Parameters

other the Vector to assign

Returns: a reference to the changed Vector

◆ operator=() [2/2]

template<typename T , typename Allocator >

Vector& hilti::rt::Vector< T, Allocator >::operator= ( Vector< T, Allocator > && other )

inlinenoexcept

Replaces the contents of this Vector with another Vector.

In contrast to assignments of std::vector iterators remain valid and after assignment will point to positions in the assigned vector.

Parameters

other the Vector to assign

Returns: a reference to the changed Vector

◆ operator[]() [1/3]

template<typename T , typename Allocator >

T& hilti::rt::Vector< T, Allocator >::operator[] ( uint64_t i ) &

inline

Accesses specified element.

Parameters

i	position of the element to return

Returns: a reference to the element

Exceptions

<tt>IndexError</tt> if the position is out of bounds.

◆ operator[]() [2/3]

template<typename T , typename Allocator >

T hilti::rt::Vector< T, Allocator >::operator[] ( uint64_t i ) &&

inline

Accesses specified element.

Parameters

i	position of the element to return

Returns: the element

Exceptions

<tt>IndexError</tt> if the position is out of bounds.

◆ operator[]() [3/3]

template<typename T , typename Allocator >

const T& hilti::rt::Vector< T, Allocator >::operator[] ( uint64_t i ) const &

inline

Accesses specified element.

Parameters

i	position of the element to return

Returns: a reference to the element

Exceptions

<tt>IndexError</tt> if the position is out of bounds.

◆ pop_back()

template<typename T , typename Allocator >

void hilti::rt::Vector< T, Allocator >::pop_back ( )

inline

Removes the last element of the vector.

Exceptions

<tt>IndexError</tt> if the Vector is empty

◆ sub() [1/2]

template<typename T , typename Allocator >

Vector<T> hilti::rt::Vector< T, Allocator >::sub ( uint64_t end ) const

inline

Extracts a subsequence from the vector.

Parameters

end	end index (not including)

Returns: new vector with a copy of the elements from the beginning to end

◆ sub() [2/2]

template<typename T , typename Allocator >

Vector<T> hilti::rt::Vector< T, Allocator >::sub	(	uint64_t	start,
		uint64_t	end
	)		const

inline

Extracts a subsequence from the vector.

Parameters

from	start index
end	end index (not including)

Returns: new vector with a copy of the range's elements

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

/home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.14.0/hilti/runtime/include/types/vector.h

Public Types

Public Member Functions

Friends

Detailed Description

template<typename T, typename Allocator> class hilti::rt::Vector< T, Allocator >

Member Function Documentation

◆ assign()

◆ back()

◆ front()

◆ insert()

◆ iteratorAt()

◆ operator+()

◆ operator+=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/3]

◆ operator[]() [2/3]

◆ operator[]() [3/3]

◆ pop_back()

◆ sub() [1/2]

◆ sub() [2/2]

template<typename T, typename Allocator>
class hilti::rt::Vector< T, Allocator >