#include <BLI_vector_set.hh>

Public Types
using	value_type = Key
using	pointer = Key *
using	const_pointer = const Key *
using	reference = Key &
using	const_reference = const Key &
using	iterator = Key *
using	const_iterator = const Key *
using	size_type = int64_t

Public Member Functions
	VectorSet (Allocator allocator={}) noexcept
	VectorSet (NoExceptConstructor, Allocator allocator={})
	VectorSet (Span< Key > keys, Allocator allocator={})
	VectorSet (const std::initializer_list< Key > &keys, Allocator allocator={})
	VectorSet (const VectorSet &other)
	VectorSet (VectorSet &&other) noexcept
	~VectorSet ()
VectorSet &	operator= (const VectorSet &other)
VectorSet &	operator= (VectorSet &&other)
const Key &	operator[] (const int64_t index) const
	operator Span< Key > () const
Span< Key >	as_span () const
void	add_new (const Key &key)
void	add_new (Key &&key)
bool	add (const Key &key)
bool	add (Key &&key)
template<typename ForwardKey>
bool	add_as (ForwardKey &&key)
void	add_multiple (Span< Key > keys)
bool	contains (const Key &key) const
template<typename ForwardKey>
bool	contains_as (const ForwardKey &key) const
bool	remove (const Key &key)
template<typename ForwardKey>
bool	remove_as (const ForwardKey &key)
void	remove_contained (const Key &key)
template<typename ForwardKey>
void	remove_contained_as (const ForwardKey &key)
template<typename Predicate>
int64_t	remove_if (Predicate &&predicate)
Key	pop ()
int64_t	index_of (const Key &key) const
template<typename ForwardKey>
int64_t	index_of_as (const ForwardKey &key) const
int64_t	index_of_try (const Key &key) const
template<typename ForwardKey>
int64_t	index_of_try_as (const ForwardKey &key) const
int64_t	index_of_or_add (const Key &key)
int64_t	index_of_or_add (Key &&key)
template<typename ForwardKey>
int64_t	index_of_or_add_as (ForwardKey &&key)
const Key &	lookup_key (const Key &key) const
template<typename ForwardKey>
const Key &	lookup_key_as (const ForwardKey &key) const
const Key *	lookup_key_ptr (const Key &key) const
template<typename ForwardKey>
const Key *	lookup_key_ptr_as (const ForwardKey &key) const
const Key *	data () const
const Key *	begin () const
const Key *	end () const
IndexRange	index_range () const
void	print_stats (const char *name) const
int64_t	size () const
bool	is_empty () const
int64_t	capacity () const
int64_t	removed_amount () const
int64_t	size_per_element () const
int64_t	size_in_bytes () const
void	reserve (const int64_t n)
void	clear ()
void	clear_and_shrink ()
int64_t	count_collisions (const Key &key) const

Detailed Description

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>
class VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >

Template Parameters

Key	Type of the elements that are stored in this set. It has to be movable. Furthermore, the hash and is-equal functions have to support it.
ProbingStrategy	The strategy used to deal with collisions. They are defined in BLI_probing_strategies.hh.
Hash	The hash function used to hash the keys. There is a default for many types. See BLI_hash.hh for examples on how to define a custom hash function.
IsEqual	The equality operator used to compare keys. By default it will simply compare keys using the == operator.
Slot	This is what will actually be stored in the hash table array. At a minimum a slot has to be able to hold an array index and information about whether the slot is empty, occupied or removed. Using a non-standard slot type can improve performance for some types. Also see BLI_vector_set_slots.hh.
Allocator	The allocator used by this set. Should rarely be changed, except when you don't want that MEM_* etc. is used internally.

Definition at line 90 of file BLI_vector_set.hh.

Member Typedef Documentation

◆ const_iterator

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::const_iterator = const Key *

Definition at line 98 of file BLI_vector_set.hh.

◆ const_pointer

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::const_pointer = const Key *

Definition at line 94 of file BLI_vector_set.hh.

◆ const_reference

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::const_reference = const Key &

Definition at line 96 of file BLI_vector_set.hh.

◆ iterator

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::iterator = Key *

Definition at line 97 of file BLI_vector_set.hh.

◆ pointer

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::pointer = Key *

Definition at line 93 of file BLI_vector_set.hh.

◆ reference

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::reference = Key &

Definition at line 95 of file BLI_vector_set.hh.

◆ size_type

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::size_type = int64_t

Definition at line 99 of file BLI_vector_set.hh.

◆ value_type

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

using blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::value_type = Key

Definition at line 92 of file BLI_vector_set.hh.

Constructor & Destructor Documentation

◆ VectorSet() [1/6]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::VectorSet ( Allocator allocator = {} )

inlinenoexcept

Initialize an empty vector set. This is a cheap operation and won't do an allocation. This is necessary to avoid a high cost when no elements are added at all. An optimized grow operation is performed on the first insertion.

Definition at line 158 of file BLI_vector_set.hh.

◆ VectorSet() [2/6]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::VectorSet	(	NoExceptConstructor	,
		Allocator	allocator = {} )

inline

Definition at line 168 of file BLI_vector_set.hh.

◆ VectorSet() [3/6]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::VectorSet	(	Span< Key >	keys,
		Allocator	allocator = {} )

inline

Definition at line 170 of file BLI_vector_set.hh.

◆ VectorSet() [4/6]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::VectorSet	(	const std::initializer_list< Key > &	keys,
		Allocator	allocator = {} )

inline

Construct a vector set that contains the given keys. Duplicates will be removed automatically.

Definition at line 178 of file BLI_vector_set.hh.

◆ VectorSet() [5/6]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::VectorSet ( const VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator > & other )

inline

Definition at line 191 of file BLI_vector_set.hh.

◆ VectorSet() [6/6]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::VectorSet ( VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator > && other )

inlinenoexcept

Definition at line 210 of file BLI_vector_set.hh.

◆ ~VectorSet()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::~VectorSet ( )

inline

Definition at line 183 of file BLI_vector_set.hh.

Member Function Documentation

◆ add() [1/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add ( const Key & key )

inline

Add a key to the vector set. If the key exists in the set already, nothing is done. The return value is true if the key was newly added.

This is similar to std::unordered_set::insert.

Definition at line 282 of file BLI_vector_set.hh.

Referenced by BKE_pbvh_bmesh_node_save_orig(), and blender::geometry::preprocess_meshes().

◆ add() [2/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add ( Key && key )

inline

Definition at line 286 of file BLI_vector_set.hh.

◆ add_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_as ( ForwardKey && key )

inline

Definition at line 290 of file BLI_vector_set.hh.

◆ add_multiple()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_multiple ( Span< Key > keys )

inline

Convenience function to add many keys to the vector set at once. Duplicates are removed automatically.

We might be able to make this faster than sequentially adding all keys, but that is not implemented yet.

Definition at line 302 of file BLI_vector_set.hh.

◆ add_new() [1/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_new ( const Key & key )

inline

Add a new key to the vector set. This invokes undefined behavior when the key is in the set already. When you know for certain that a key is not in the set yet, use this method for better performance. This also expresses the intent better.

Definition at line 267 of file BLI_vector_set.hh.

◆ add_new() [2/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_new ( Key && key )

inline

Definition at line 271 of file BLI_vector_set.hh.

◆ as_span()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

Span< Key > blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::as_span ( ) const

inline

Get a Span referencing the keys vector. The referenced memory buffer is only valid as long as the vector set is not changed.

The keys must not be changed, because this would change their hash value.

Definition at line 257 of file BLI_vector_set.hh.

Referenced by paintface_select_loop().

◆ begin()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

const Key * blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::begin ( ) const

inline

Definition at line 464 of file BLI_vector_set.hh.

Referenced by blender::geometry::preprocess_meshes().

◆ capacity()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::capacity ( ) const

inline

Returns the number of available slots. This is mostly for debugging purposes.

Definition at line 510 of file BLI_vector_set.hh.

◆ clear()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::clear ( )

inline

Remove all keys from the vector set.

Definition at line 553 of file BLI_vector_set.hh.

◆ clear_and_shrink()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::clear_and_shrink ( )

inline

Removes all keys from the set and frees any allocated memory.

Definition at line 568 of file BLI_vector_set.hh.

◆ contains()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains ( const Key & key ) const

inline

Returns true if the key is in the vector set.

This is similar to std::unordered_set::find() != std::unordered_set::end().

Definition at line 314 of file BLI_vector_set.hh.

◆ contains_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains_as ( const ForwardKey & key ) const

inline

Definition at line 318 of file BLI_vector_set.hh.

◆ count_collisions()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::count_collisions ( const Key & key ) const

inline

Get the number of collisions that the probing strategy has to go through to find the key or determine that it is not in the set.

Definition at line 578 of file BLI_vector_set.hh.

◆ data()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

const Key * blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::data ( ) const

inline

Get a pointer to the beginning of the array containing all keys.

Definition at line 459 of file BLI_vector_set.hh.

Referenced by blender::geometry::execute_realize_grease_pencil_tasks().

◆ end()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

const Key * blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::end ( ) const

inline

Definition at line 469 of file BLI_vector_set.hh.

Referenced by blender::geometry::preprocess_meshes().

◆ index_of()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of ( const Key & key ) const

inline

Return the location of the key in the vector. It is assumed that the key is in the vector set. If this is not necessarily the case, use index_of_try.

Definition at line 385 of file BLI_vector_set.hh.

Referenced by BKE_pbvh_bmesh_node_save_orig(), copyFinalLoopArray_task_cb(), blender::geometry::gather_realize_tasks_recursive(), and blender::geometry::preprocess_meshes().

◆ index_of_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of_as ( const ForwardKey & key ) const

inline

Definition at line 389 of file BLI_vector_set.hh.

◆ index_of_or_add() [1/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of_or_add ( const Key & key )

inline

Return the index of the key in the vector. If the key is not in the set, add it and return its index.

Definition at line 411 of file BLI_vector_set.hh.

Referenced by blender::geometry::preprocess_grease_pencils().

◆ index_of_or_add() [2/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of_or_add ( Key && key )

inline

Definition at line 415 of file BLI_vector_set.hh.

◆ index_of_or_add_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of_or_add_as ( ForwardKey && key )

inline

Definition at line 419 of file BLI_vector_set.hh.

◆ index_of_try()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of_try ( const Key & key ) const

inline

Return the location of the key in the vector. If the key is not in the set, -1 is returned. If you know for sure that the key is in the set, it is better to use index_of instead.

Definition at line 398 of file BLI_vector_set.hh.

◆ index_of_try_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_of_try_as ( const ForwardKey & key ) const

inline

Definition at line 402 of file BLI_vector_set.hh.

◆ index_range()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

IndexRange blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::index_range ( ) const

inline

Get an index range containing all valid indices for this array.

Definition at line 477 of file BLI_vector_set.hh.

Referenced by blender::nodes::node_geo_split_to_instances_cc::split_curve_groups(), blender::nodes::node_geo_split_to_instances_cc::split_instance_groups(), and blender::nodes::node_geo_split_to_instances_cc::split_pointcloud_groups().

◆ is_empty()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::is_empty ( ) const

inline

Returns true if no keys are stored.

Definition at line 502 of file BLI_vector_set.hh.

Referenced by blender::geometry::execute_realize_grease_pencil_tasks().

◆ lookup_key()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

const Key & blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_key ( const Key & key ) const

inline

Returns the key that is stored in the vector set that compares equal to the given key. This invokes undefined behavior when the key is not in the set.

Definition at line 428 of file BLI_vector_set.hh.

◆ lookup_key_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

const Key & blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_key_as ( const ForwardKey & key ) const

inline

Definition at line 432 of file BLI_vector_set.hh.

◆ lookup_key_ptr()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

const Key * blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_key_ptr ( const Key & key ) const

inline

Returns a pointer to the key that is stored in the vector set that compares equal to the given key. If the key is not in the set, null is returned.

Definition at line 443 of file BLI_vector_set.hh.

◆ lookup_key_ptr_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

const Key * blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_key_ptr_as ( const ForwardKey & key ) const

inline

Definition at line 447 of file BLI_vector_set.hh.

◆ operator Span< Key >()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::operator Span< Key > ( ) const

inline

Definition at line 246 of file BLI_vector_set.hh.

◆ operator=() [1/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

VectorSet & blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::operator= ( const VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator > & other )

inline

Definition at line 226 of file BLI_vector_set.hh.

◆ operator=() [2/2]

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

VectorSet & blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::operator= ( VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator > && other )

inline

Definition at line 231 of file BLI_vector_set.hh.

◆ operator[]()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

const Key & blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::operator[] ( const int64_t index ) const

inline

Get the key stored at the given position in the vector.

Definition at line 239 of file BLI_vector_set.hh.

◆ pop()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

Key blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::pop ( )

inline

Delete and return a key from the set. This will remove the last element in the vector. The order of the remaining elements in the set is not changed.

Definition at line 376 of file BLI_vector_set.hh.

◆ print_stats()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::print_stats ( const char * name ) const

inline

Print common statistics like size and collision count. This is useful for debugging purposes.

Definition at line 485 of file BLI_vector_set.hh.

◆ remove()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove ( const Key & key )

inline

Deletes the key from the set. Returns true when the key existed in the set and is now removed. This might change the order of elements in the vector.

This is similar to std::unordered_set::erase.

Definition at line 329 of file BLI_vector_set.hh.

◆ remove_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

bool blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove_as ( const ForwardKey & key )

inline

Definition at line 333 of file BLI_vector_set.hh.

◆ remove_contained()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove_contained ( const Key & key )

inline

Deletes the key from the set. This invokes undefined behavior when the key is not in the set. It might change the order of elements in the vector.

Definition at line 342 of file BLI_vector_set.hh.

◆ remove_contained_as()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename ForwardKey>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove_contained_as ( const ForwardKey & key )

inline

Definition at line 346 of file BLI_vector_set.hh.

◆ remove_if()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

template<typename Predicate>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove_if ( Predicate && predicate )

inline

Remove all values for which the given predicate is true and return the number or values removed. This may change the order of elements in the vector.

This is similar to std::erase_if.

Definition at line 357 of file BLI_vector_set.hh.

◆ removed_amount()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::removed_amount ( ) const

inline

Returns the amount of removed slots in the set. This is mostly for debugging purposes.

Definition at line 518 of file BLI_vector_set.hh.

◆ reserve()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

void blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::reserve ( const int64_t n )

inline

Potentially resize the vector set such that it can hold n elements without doing another grow.

Definition at line 543 of file BLI_vector_set.hh.

Referenced by BKE_pbvh_bmesh_node_save_orig().

◆ size()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::size ( ) const

inline

Returns the number of keys stored in the vector set.

Definition at line 494 of file BLI_vector_set.hh.

Referenced by blender::geometry::execute_realize_grease_pencil_tasks(), blender::geometry::preprocess_curves(), blender::geometry::preprocess_grease_pencils(), blender::geometry::preprocess_meshes(), and blender::geometry::preprocess_pointclouds().

◆ size_in_bytes()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::size_in_bytes ( ) const

inline

Returns the approximate memory requirements of the set in bytes. This is more correct for larger sets.

Definition at line 535 of file BLI_vector_set.hh.

◆ size_per_element()

template<typename Key, typename ProbingStrategy = DefaultProbingStrategy, typename Hash = DefaultHash<Key>, typename IsEqual = DefaultEquality<Key>, typename Slot = typename DefaultVectorSetSlot<Key>::type, typename Allocator = GuardedAllocator>

int64_t blender::VectorSet< Key, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::size_per_element ( ) const

inline

Returns the bytes required per element. This is mostly for debugging purposes.

Definition at line 526 of file BLI_vector_set.hh.

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

BLI_vector_set.hh

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ iterator

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ VectorSet() [1/6]

◆ VectorSet() [2/6]

◆ VectorSet() [3/6]

◆ VectorSet() [4/6]

◆ VectorSet() [5/6]

◆ VectorSet() [6/6]

◆ ~VectorSet()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ add_as()

◆ add_multiple()

◆ add_new() [1/2]

◆ add_new() [2/2]

◆ as_span()

◆ begin()

◆ capacity()

◆ clear()

◆ clear_and_shrink()

◆ contains()

◆ contains_as()

◆ count_collisions()

◆ data()

◆ end()

◆ index_of()

◆ index_of_as()

◆ index_of_or_add() [1/2]

◆ index_of_or_add() [2/2]

◆ index_of_or_add_as()

◆ index_of_try()

◆ index_of_try_as()

◆ index_range()

◆ is_empty()

◆ lookup_key()

◆ lookup_key_as()

◆ lookup_key_ptr()

◆ lookup_key_ptr_as()

◆ operator Span< Key >()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]()

◆ pop()

◆ print_stats()

◆ remove()

◆ remove_as()

◆ remove_contained()

◆ remove_contained_as()

◆ remove_if()

◆ removed_amount()

◆ reserve()

◆ size()

◆ size_in_bytes()

◆ size_per_element()