vec< T, A, vl_embed > Struct Template Reference
#include <vec.h>
Collaboration diagram for vec< T, A, vl_embed >:
Public Types | |
| using | pop_ret_type |
Static Public Member Functions | |
| static size_t | embedded_size (unsigned) |
Data Fields | |
| vec_prefix | m_vecpfx |
Friends | |
| template<typename , typename , typename > | |
| struct | vec |
| struct | va_gc |
| struct | va_gc_atomic |
| struct | va_heap |
Detailed Description
Embeddable vector. These vectors are suitable to be embedded
in other data structures so that they can be pre-allocated in a
contiguous memory block.
Embeddable vectors are implemented using the trailing array idiom,
thus they are not resizeable without changing the address of the
vector object itself. This means you cannot have variables or
fields of embeddable vector type -- always use a pointer to a
vector. The one exception is the final field of a structure, which
could be a vector type.
You will have to use the embedded_size & embedded_init calls to
create such objects, and they will not be resizeable (so the 'safe'
allocation variants are not available).
Properties:
- The whole vector and control data are allocated in a single
contiguous block. It uses the trailing-vector idiom, so
allocation must reserve enough space for all the elements
in the vector plus its control data.
- The vector cannot be re-allocated.
- The vector cannot grow nor shrink.
- No indirections needed for access/manipulation.
- It requires 2 words of storage (prior to vector allocation). Member Typedef Documentation
◆ pop_ret_type
Member Function Documentation
◆ address() [1/2]
◆ address() [2/2]
◆ allocated()
◆ begin() [1/2]
◆ begin() [2/2]
◆ block_remove()
Remove LEN elements starting at the IXth. Ordering is retained. This is an O(N) operation due to memmove.
References gcc_checking_assert, and ggc_alloc().
◆ bsearch() [1/2]
|
inline |
Search the contents of the sorted vector with a binary search. CMP is the comparison function to pass to bsearch.
References ggc_alloc(), NULL, and T.
◆ bsearch() [2/2]
|
inline |
Search the contents of the sorted vector with a binary search. CMP is the comparison function to pass to bsearch.
References ggc_alloc(), NULL, and T.
◆ contains()
Return true if SEARCH is an element of V. Note that this is O(N) in the size of the vector and so should be used with care.
References i.
◆ copy()
Return a pointer to a copy of this vector.
References ggc_alloc(), NULL, PASS_MEM_STAT, vec_alloc(), and vec_copy_construct().
Referenced by vec_safe_copy().
◆ embedded_init()
|
inline |
Initialize the vector to contain room for ALLOC elements and NUM active elements.
References ggc_alloc().
◆ embedded_size()
Return the number of bytes needed to embed an instance of an embeddable vec inside another data structure. Use these methods to determine the required size and initialization of a vector V of type T embedded within another structure (as the final member): size_t vec<T, A, vl_embed>::embedded_size (unsigned alloc); void v->embedded_init (unsigned alloc, unsigned num); These allow the caller to perform the memory allocation.
References ggc_alloc(), and T.
◆ end() [1/2]
◆ end() [2/2]
◆ is_empty()
◆ iterate() [1/2]
Return iteration condition and update *PTR to (a copy of) the IX'th
element of this vector. Use this to iterate over the elements of a
vector as follows,
for (ix = 0; v->iterate (ix, &val); ix++)
continue;
References ggc_alloc().
◆ iterate() [2/2]
Return iteration condition and update *PTR to point to the
IX'th element of this vector. Use this to iterate over the
elements of a vector as follows,
for (ix = 0; v->iterate (ix, &ptr); ix++)
continue;
This variant is for vectors of objects.
References CONST_CAST, and ggc_alloc().
◆ last()
Get the final element of the vector, which must not be empty.
References gcc_checking_assert.
◆ length()
◆ lower_bound()
| unsigned vec< T, A, vl_embed >::lower_bound | ( | const T & | obj, |
| bool(*)(const T &, const T &) | lessthan ) const |
Find and return the first position in which OBJ could be inserted without changing the ordering of this vector. LESSTHAN is a function that returns true if the first argument is strictly less than the second.
References ggc_alloc().
◆ operator[]() [1/2]
References gcc_checking_assert, and ggc_alloc().
◆ operator[]() [2/2]
Index into vector. Return the IX'th element. IX must be in the domain of the vector.
References gcc_checking_assert, and ggc_alloc().
◆ ordered_remove()
Remove an element from the IXth position of this vector. Ordering of remaining elements is preserved. This is an O(N) operation due to memmove. Not suitable for non-trivially copyable types.
References gcc_checking_assert, and ggc_alloc().
◆ pop()
Pop and return a reference to the last element off the end of the vector. If T has non-trivial destructor, this method just pops the element and returns void type.
References gcc_checking_assert, and last.
◆ qsort()
Sort the contents of this vector with qsort. CMP is the comparison function to pass to qsort.
References gcc_qsort(), and T.
◆ quick_grow()
Grow the vector to a specific length. LEN must be as long or longer than the current length. The new elements are uninitialized.
References gcc_checking_assert.
◆ quick_grow_cleared()
Grow the vector to a specific length. LEN must be as long or longer than the current length. The new elements are initialized to zero.
References gcc_checking_assert, ggc_alloc(), and vec_default_construct().
◆ quick_insert()
Insert an element, OBJ, at the IXth position of this vector. There must be sufficient space. This operation is not suitable for non-trivially copyable types.
References gcc_checking_assert, and ggc_alloc().
◆ quick_push()
Push OBJ (a new element) onto the end of the vector. There must be sufficient space in the vector. Return a pointer to the slot where OBJ was inserted.
References gcc_checking_assert, ggc_alloc(), and T.
◆ sort()
|
inline |
Sort the contents of this vector with qsort. CMP is the comparison function to pass to qsort.
References gcc_sort_r(), and T.
◆ space()
If this vector has space for NELEMS additional entries, return true. You usually only need to use this if you are doing your own vector reallocation, for instance on an embedded vector. This returns true in exactly the same circumstances that vec::reserve will.
References ggc_alloc().
◆ splice() [1/2]
◆ splice() [2/2]
◆ stablesort()
|
inline |
Sort the contents of this vector with gcc_stablesort_r. CMP is the comparison function to pass to qsort.
References gcc_stablesort_r(), and T.
◆ truncate()
Set the length of the vector to SIZE. The new length must be less than or equal to the current length. This is an O(1) operation.
References gcc_checking_assert, and vec_destruct().
◆ unordered_remove()
Remove an element from the IXth position of this vector. Ordering of remaining elements is destroyed. This is an O(1) operation.
References gcc_checking_assert, and ggc_alloc().
Friends And Related Symbol Documentation
◆ va_gc
◆ va_gc_atomic
◆ va_heap
◆ vec
Field Documentation
◆ m_vecpfx
The documentation for this struct was generated from the following file:
