Open Lighting Architecture
Latest Git
|
Various helper functions related to STL classes.
Files | |
file | STLUtils.h |
Helper functions for STL classes. | |
Functions | |
template<typename T > | |
void | ola::STLEmptyStack (T *stack) |
Clear a stack. More... | |
template<typename T > | |
void | ola::STLEmptyStackAndDelete (T *stack) |
Clear a stack and delete all pointers.. More... | |
template<typename T > | |
void | ola::STLDeleteElements (T *sequence) |
Delete the elements of a Sequence. More... | |
template<typename T > | |
void | ola::STLDeleteValues (T *container) |
template<typename T1 , typename T2 > | |
bool | ola::STLContains (const T1 &container, const T2 &value) |
template<typename T1 > | |
void | ola::STLKeys (const T1 &container, std::vector< typename T1::key_type > *keys) |
template<typename T1 , typename T2 > | |
void | ola::STLValues (const T1 &container, std::vector< T2 > *values) |
Extract a vector of values from a pair associative container. More... | |
template<typename T1 > | |
T1::mapped_type * | ola::STLFind (T1 *container, const typename T1::key_type &key) |
Lookup a value by key in a associative container. More... | |
template<typename T1 > | |
T1::mapped_type const * | ola::STLFind (const T1 *container, const typename T1::key_type &key) |
Lookup a value by key in a associative container. More... | |
template<typename T1 > | |
T1::mapped_type | ola::STLFindOrNull (const T1 &container, const typename T1::key_type &key) |
Lookup a value by key in a associative container. More... | |
template<typename T1 > | |
bool | ola::STLReplace (T1 *container, const typename T1::key_type &key, const typename T1::mapped_type &value) |
Replace a value in a pair associative container, inserting the key, value if it doesn't already exist. More... | |
template<typename T1 > | |
T1::mapped_type | ola::STLReplacePtr (T1 *container, const typename T1::key_type &key, const typename T1::mapped_type &value) |
Replace a value in a pair associative container. If the key existed, the old value is returned, otherwise NULL is returned. More... | |
template<typename T1 > | |
bool | ola::STLReplaceAndDelete (T1 *container, const typename T1::key_type &key, const typename T1::mapped_type &value) |
Similar to STLReplace but this will delete the value if the replacement occurs. More... | |
template<typename T1 > | |
bool | ola::STLInsertIfNotPresent (T1 *container, const typename T1::value_type &key_value) |
Insert a value into a container only if this value doesn't already exist. More... | |
template<typename T1 > | |
bool | ola::STLInsertIfNotPresent (T1 *container, const typename T1::key_type &key, const typename T1::mapped_type &value) |
Insert a value into a container only if this value doesn't already exist. More... | |
template<typename T1 > | |
void | ola::STLInsertOrDie (T1 *container, const typename T1::key_type &key, const typename T1::mapped_type &value) |
Insert an key : value into a pair associative container, or abort the program if the key already exists. More... | |
template<typename T1 > | |
bool | ola::STLRemove (T1 *container, const typename T1::key_type &key) |
Remove a key / value from a container. More... | |
template<typename T1 > | |
bool | ola::STLLookupAndRemove (T1 *container, const typename T1::key_type &key, typename T1::mapped_type *value) |
Lookup and remove a key from a pair associative container. More... | |
template<typename T1 > | |
T1::iterator | ola::STLLookupOrInsertNull (T1 *container, const typename T1::key_type &key) |
Lookup or insert a NULL value into a pair associative container. More... | |
template<typename T1 > | |
void | ola::PairAssociativeAssignNew (T1 **location) |
template<typename T1 > | |
T1::iterator | ola::STLLookupOrInsertNew (T1 *container, const typename T1::key_type &key) |
Lookup or insert a new object into a pair associative container. More... | |
template<typename T1 > | |
bool | ola::STLRemoveAndDelete (T1 *container, const typename T1::key_type &key) |
Remove a value from a pair associative container and delete it. More... | |
template<typename T1 > | |
T1::mapped_type | ola::STLLookupAndRemovePtr (T1 *container, const typename T1::key_type &key) |
Remove a value from a pair associative container and return the value. More... | |
template<typename T1 , typename T2 > | |
void | ola::STLMapFromKeys (T1 *output, const T2 input, typename T1::mapped_type value) |
|
inline |
Returns true if the container contains the value.
T1 | A container. |
T2 | The value to search for. |
container | the container to search in. |
value | the value to search for. |
void ola::STLDeleteElements | ( | T * | sequence | ) |
Delete the elements of a Sequence.
sequence | the Sequence to delete the elements from. |
T | A Sequence. |
All elements in the sequence will be deleted. The sequence will be cleared.
void ola::STLDeleteValues | ( | T * | container | ) |
Delete all values in a pair associative container.
container |
T | A pair associative container. |
All elements in the container will be deleted. The container will be cleared.
void ola::STLEmptyStack | ( | T * | stack | ) |
Clear a stack.
T | A stack. |
void ola::STLEmptyStackAndDelete | ( | T * | stack | ) |
Clear a stack and delete all pointers..
T | A stack of pointers. |
T1::mapped_type* ola::STLFind | ( | T1 * | container, |
const typename T1::key_type & | key | ||
) |
Lookup a value by key in a associative container.
T1 | A container. |
container | the container to search in. |
key | the key to search for. |
T1::mapped_type const* ola::STLFind | ( | const T1 * | container, |
const typename T1::key_type & | key | ||
) |
Lookup a value by key in a associative container.
T1 | A container. |
container | the container to search in. |
key | the key to search for. |
T1::mapped_type ola::STLFindOrNull | ( | const T1 & | container, |
const typename T1::key_type & | key | ||
) |
Lookup a value by key in a associative container.
T1 | A container. |
container | the container to search in. |
key | the key to search for. |
This assumes that NULL can be co-erced to the mapped_type of the container. It's most suitable for containers with pointers.
bool ola::STLInsertIfNotPresent | ( | T1 * | container, |
const typename T1::value_type & | key_value | ||
) |
Insert a value into a container only if this value doesn't already exist.
T1 | A container. |
container | the container to insert the value in. |
key_value | the pair<key, value> to insert. |
bool ola::STLInsertIfNotPresent | ( | T1 * | container, |
const typename T1::key_type & | key, | ||
const typename T1::mapped_type & | value | ||
) |
Insert a value into a container only if this value doesn't already exist.
T1 | A container. |
container | the container to insert the value in. |
key | the key to insert. |
value | the value to insert. |
void ola::STLInsertOrDie | ( | T1 * | container, |
const typename T1::key_type & | key, | ||
const typename T1::mapped_type & | value | ||
) |
Insert an key : value into a pair associative container, or abort the program if the key already exists.
T1 | A container. |
container | the container to insert the value in. |
key | the key to insert. |
value | the value to insert. |
void ola::STLKeys | ( | const T1 & | container, |
std::vector< typename T1::key_type > * | keys | ||
) |
Extract the list of keys from a pair associative container.
T1 | A container. |
[in] | container | the container to extract the keys for. |
[out] | keys | the vector to populate with the keys. |
bool ola::STLLookupAndRemove | ( | T1 * | container, |
const typename T1::key_type & | key, | ||
typename T1::mapped_type * | value | ||
) |
Lookup and remove a key from a pair associative container.
T1 | A container. |
[in] | container | the container to remove the key from. |
[in] | key | the key to remove. |
[out] | value | A pointer which will be set to the removed value. |
Lookup a value by key in a pair associative container. If the value exists, it's removed from the container, the value placed in value and true is returned.
T1::mapped_type ola::STLLookupAndRemovePtr | ( | T1 * | container, |
const typename T1::key_type & | key | ||
) |
Remove a value from a pair associative container and return the value.
T1 | A container. |
[in] | container | the container to remove the key from. |
[in] | key | the key to remove. |
T1::iterator ola::STLLookupOrInsertNew | ( | T1 * | container, |
const typename T1::key_type & | key | ||
) |
Lookup or insert a new object into a pair associative container.
T1 | A container. |
[in] | container | the container to lookup from or insert into. |
[in] | key | the key to lookup. |
T1::iterator ola::STLLookupOrInsertNull | ( | T1 * | container, |
const typename T1::key_type & | key | ||
) |
Lookup or insert a NULL value into a pair associative container.
T1 | A container. |
[in] | container | the container to lookup from or insert into. |
[in] | key | the key to lookup. |
Lookup a value by key in a pair associative container or insert NULL if it doesn't already exist.
void ola::STLMapFromKeys | ( | T1 * | output, |
const T2 | input, | ||
typename T1::mapped_type | value | ||
) |
Add elements of a sequence to an associative container.
output | The associative container to add to. |
input | The sequence containing the elements to add. |
value | The value to use for each key in input. |
T1 | A pair associative container. |
T2 | A sequence. |
Any existing elements that conflict with the values in the sequence will be replaced.
bool ola::STLRemove | ( | T1 * | container, |
const typename T1::key_type & | key | ||
) |
Remove a key / value from a container.
T1 | A container. |
container | the container to remove the key from. |
key | the key to remove. |
bool ola::STLRemoveAndDelete | ( | T1 * | container, |
const typename T1::key_type & | key | ||
) |
Remove a value from a pair associative container and delete it.
T1 | A container. |
[in] | container | the container to remove the key from. |
[in] | key | the key to remove. |
bool ola::STLReplace | ( | T1 * | container, |
const typename T1::key_type & | key, | ||
const typename T1::mapped_type & | value | ||
) |
Replace a value in a pair associative container, inserting the key, value if it doesn't already exist.
T1 | A container. |
container | the container to replace the value in. |
key | the key to insert / replace. |
value | the value to insert / replace. |
bool ola::STLReplaceAndDelete | ( | T1 * | container, |
const typename T1::key_type & | key, | ||
const typename T1::mapped_type & | value | ||
) |
Similar to STLReplace but this will delete the value if the replacement occurs.
T1 | A container. |
container | the container to replace the value in. |
key | the key to insert / replace. |
value | the value to insert / replace. |
T1::mapped_type ola::STLReplacePtr | ( | T1 * | container, |
const typename T1::key_type & | key, | ||
const typename T1::mapped_type & | value | ||
) |
Replace a value in a pair associative container. If the key existed, the old value is returned, otherwise NULL is returned.
T1 | A container. |
container | the container to replace the value in. |
key | the key to insert / replace. |
value | the value to insert / replace. |
void ola::STLValues | ( | const T1 & | container, |
std::vector< T2 > * | values | ||
) |
Extract a vector of values from a pair associative container.
T1 | A container. |
T2 | The type of the values. |
[in] | container | the container to extract the values for. |
[out] | values | the vector to populate with the values. |