Utility class for indexing objects based on specific member variable values. More...

#include <table_index.hpp>

Public Types
typedef std::vector< T * >	index_type
typedef Transform	transform_type
typedef Key	key_type
typedef T	value_type
typedef Compare	key_compare
typedef T &	reference
typedef const T &	const_reference
typedef index_type::size_type	size_type
typedef index_type::difference_type	difference_type
typedef T *	pointer
typedef const T *	const_pointer
typedef boost::indirect_iterator< typename index_type::iterator >	iterator
typedef boost::indirect_iterator< typename index_type::const_iterator >	const_iterator
typedef std::reverse_iterator< iterator >	reverse_iterator
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Public Member Functions
template<class TransformPrimitive>
	table_index (TransformPrimitive transform, const key_compare &compare=key_compare())
	table_index (const transform_type &, const key_compare &=key_compare())
template<typename InputIterator, typename TransformPrimitive>
	table_index (InputIterator first, InputIterator last, TransformPrimitive transform, const key_compare &compare=key_compare())
size_type	max_size () const
size_type	size () const
bool	empty () const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
reverse_iterator	rend ()
const_reverse_iterator	rend () const
const_reference	at (size_type n) const
reference	at (size_type n)
reference	front ()
const_reference	front () const
reference	back ()
const_reference	back () const
void	push_back (value_type &)
void	pop_back ()
iterator	insert (iterator, value_type &)
template<class InputIterator>
void	insert (iterator position, InputIterator first, InputIterator last)
iterator	erase (iterator location)
iterator	erase (iterator first, iterator last)
void	clear ()
index_type &	index ()
const index_type &	index () const
void	sort ()
void	unique ()
reference	operator[] (const key_type &)
const_reference	operator[] (const key_type &) const
iterator	find (const key_type &x)
const_iterator	find (const key_type &x) const
size_type	count (const key_type &x) const
iterator	lower_bound (const key_type &x)
const_iterator	lower_bound (const key_type &x) const
iterator	upper_bound (const key_type &x)
const_iterator	upper_bound (const key_type &x) const
std::pair< iterator, iterator >	equal_range (const key_type &x)
std::pair< const_iterator, const_iterator >	equal_range (const key_type &x) const
transform_type	transform () const

Friends
void	swap (table_index &x, table_index &y)

Related Symbols
(Note that these are not member symbols.)
void	swap (adobe::table_index &x, adobe::table_index &y)

Detailed Description

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>
class adobe::table_index< Key, T, Transform, Compare >

Terminology:

Row : any class or struct type; an element
Column : a data or logical member of an element
Table : any random access container of elements
Transformation Function : given an element returns 1 or more columns. The result is by const reference so columns must be adjacent
Key : a value which can be compared against a single member of an element

The table_index does not own the elements it indexes. Therefore the client is required to maintain the elements in the table_index as long as the table_index refers to them.

If the index is not sorted then the result of a lookup by key is undefined.

Todo: (sparent) note here on why not auto sort.

Definition at line 667 of file table_index.hpp.

Member Typedef Documentation

◆ index_type

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef std::vector<T*> index_type

Container to store the elements of the table.

Definition at line 670 of file table_index.hpp.

◆ transform_type

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef Transform transform_type

ConvertibleToFunction used to transform an element into a specific key.

Definition at line 671 of file table_index.hpp.

◆ key_type

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef Key key_type

The table_index's key type, Key.

Definition at line 673 of file table_index.hpp.

◆ value_type

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef T value_type

The type of object referenced by the table_index.

Definition at line 674 of file table_index.hpp.

◆ key_compare

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef Compare key_compare

Functor that compares two keys for ordering.

Definition at line 675 of file table_index.hpp.

◆ reference

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef T& reference

Reference to T.

Definition at line 677 of file table_index.hpp.

◆ const_reference

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef const T& const_reference

Const reference to T.

Definition at line 678 of file table_index.hpp.

◆ size_type

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef index_type::size_type size_type

An unsigned integral type.

Definition at line 679 of file table_index.hpp.

◆ difference_type

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef index_type::difference_type difference_type

A signed integral type.

Definition at line 680 of file table_index.hpp.

◆ pointer

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef T* pointer

Pointer to T.

Definition at line 681 of file table_index.hpp.

◆ const_pointer

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef const T* const_pointer

Const pointer to T.

Definition at line 682 of file table_index.hpp.

◆ iterator

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef boost::indirect_iterator<typename index_type::iterator> iterator

Iterator used to iterate through a table_index.

Definition at line 684 of file table_index.hpp.

◆ const_iterator

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef boost::indirect_iterator<typename index_type::const_iterator> const_iterator

Const iterator used to iterate through a table_index.

Definition at line 685 of file table_index.hpp.

◆ reverse_iterator

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef std::reverse_iterator<iterator> reverse_iterator

Iterator used to iterate backwards through a table_index.

Definition at line 686 of file table_index.hpp.

◆ const_reverse_iterator

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

typedef std::reverse_iterator<const_iterator> const_reverse_iterator

Const iterator used to iterate backwards through a table_index.

Definition at line 687 of file table_index.hpp.

Constructor & Destructor Documentation

◆ table_index() [1/3]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

template<class TransformPrimitive>

table_index	(	TransformPrimitive	transform,
		const key_compare &	compare = key_compare() )

explicit

Parameters

transform	ConvertibleToFunction to be converted to the transformation function for this index
compare	key comparison function for this index

Definition at line 690 of file table_index.hpp.

◆ table_index() [2/3]

template<class Key, class T, class Compare, class Transform>

table_index	(	const transform_type &	transform,
		const key_compare &	compare = key_compare() )

explicit

Constructs a table_index with the specified transformation function and key comparison function.

Definition at line 809 of file table_index.hpp.

◆ table_index() [3/3]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

template<typename InputIterator, typename TransformPrimitive>

table_index	(	InputIterator	first,
		InputIterator	last,
		TransformPrimitive	transform,
		const key_compare &	compare = key_compare() )

Constructs a table_index by copying elements from a range.

Parameters

first	iterator to first element to populate the table
last	iterator to one-past-the-last element to populate the table
transform	transformation function for this index
compare	key comparison function for this index

Definition at line 703 of file table_index.hpp.

Member Function Documentation

◆ max_size()

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::size_type max_size ( ) const

Returns: The largest possible size of the table_index.

Definition at line 881 of file table_index.hpp.

◆ size()

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::size_type size ( ) const

Returns: Returns the size of the table_index.

Definition at line 889 of file table_index.hpp.

◆ empty()

template<class Key, class T, class Compare, class Transform>

bool empty ( ) const

Returns: true if the table_index's size is 0.

Definition at line 896 of file table_index.hpp.

◆ begin() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator begin ( )

Returns: An iterator pointing to the beginning of the table_index.

Definition at line 817 of file table_index.hpp.

◆ begin() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_iterator begin ( ) const

Returns: A const_iterator pointing to the beginning of the table_index.

Definition at line 825 of file table_index.hpp.

◆ end() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator end ( )

Returns: An iterator pointing to the end of the table_index.

Definition at line 833 of file table_index.hpp.

◆ end() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_iterator end ( ) const

Returns: A const_iterator pointing to the end of the table_index.

Definition at line 841 of file table_index.hpp.

◆ rbegin() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::reverse_iterator rbegin ( )

Returns: A reverse_iterator pointing to the beginning of the reversed table_index.

Definition at line 849 of file table_index.hpp.

◆ rbegin() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_reverse_iterator rbegin ( ) const

Returns: A const_reverse_iterator pointing to the beginning of the reversed table_index.

Definition at line 857 of file table_index.hpp.

◆ rend() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::reverse_iterator rend ( )

Returns: A reverse_iterator pointing to the end of the reversed table_index.

Definition at line 865 of file table_index.hpp.

◆ rend() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_reverse_iterator rend ( ) const

Returns: A const_reverse_iterator pointing to the end of the reversed table_index.

Definition at line 873 of file table_index.hpp.

◆ at() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_reference at ( size_type n ) const

Definition at line 993 of file table_index.hpp.

◆ at() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::reference at ( size_type n )

Parameters

n	index into the table.

Returns: Element n in the table.

const

Returns: Element n in the table.

Definition at line 985 of file table_index.hpp.

◆ front() [1/2]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

reference front ( )

Returns: The first element in the table.

◆ front() [2/2]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

const_reference front ( ) const

Returns: The first element in the table.

◆ back() [1/2]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

reference back ( )

Returns: The last element in the table.

◆ back() [2/2]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

const_reference back ( ) const

Returns: The last element in the table.

◆ push_back()

template<class Key, class T, class Compare, class Transform>

void push_back ( value_type & x )

Parameters

x	The element to insert at the end of the table

Postcondition: x must exist as long as this table's reference to it exists.

Definition at line 903 of file table_index.hpp.

◆ pop_back()

template<class Key, class T, class Compare, class Transform>

void pop_back ( )

Eliminates the last element from the table.

Definition at line 910 of file table_index.hpp.

◆ insert() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator insert	(	iterator	position,
		value_type &	x )

Parameters

position	position at which the new element is to be inserted
x	The element to insert as the position specified

Returns: An iterator pointing to the new element.

Postcondition: x must exist as long as this table's reference to it exists.

Definition at line 918 of file table_index.hpp.

◆ insert() [2/2]

template<class Key, class T, class Compare, class Transform>

template<class InputIterator>

void insert	(	iterator	position,
		InputIterator	first,
		InputIterator	last )

Parameters

position	position at which the new elements are to be inserted
first	Iterator to the first new element to be inserted
last	Iterator to one past the last new element to be inserted

Postcondition: The elements found in (first, last] must exist as long as this table's references to them exist.

Definition at line 931 of file table_index.hpp.

◆ erase() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator erase ( iterator location )

Parameters

location iterator to the element to be removed from the index

Returns: An iterator pointing to the next element after the one removed from the index

Definition at line 946 of file table_index.hpp.

◆ erase() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator erase	(	iterator	first,
		iterator	last )

Parameters

first	Iterator to the first element to be erased from the index
last	Iterator to one past the last element to be erased from the index

Returns: An iterator pointing to to the next element after the ones removed from the index

Definition at line 954 of file table_index.hpp.

◆ clear()

template<class Key, class T, class Compare, class Transform>

void clear ( )

Erases the entire table_index.

Definition at line 961 of file table_index.hpp.

◆ index() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::index_type & index ( )

Returns: All the elements in the index in a std::vector

Definition at line 1123 of file table_index.hpp.

◆ index() [2/2]

template<class Key, class T, class Compare, class Transform>

const table_index< Key, T, Compare, Transform >::index_type & index ( ) const

Returns: All the elements in the index in a std::vector

Definition at line 1131 of file table_index.hpp.

◆ sort()

template<class Key, class T, class Compare, class Transform>

void sort ( )

Sorts all the elements in the table based on their transformed values as compared with the key_compare function object.

Definition at line 968 of file table_index.hpp.

◆ unique()

template<class Key, class T, class Compare, class Transform>

void unique ( )

Reduces the index to a single value per key.

Definition at line 975 of file table_index.hpp.

◆ operator[]() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::reference operator[] ( const key_type & key )

Precondition: table must be sorted.

Parameters

key	key value to find in the table index.

Returns: One or more adjacent values whose keys match key.

Definition at line 1001 of file table_index.hpp.

◆ operator[]() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_reference operator[] ( const key_type & key ) const

Precondition: table must be sorted.

Parameters

key	key value to find in the table index.

Returns: One or more adjacent values whose keys match key.

Definition at line 1014 of file table_index.hpp.

◆ find() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator find ( const key_type & x )

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: Iterator to the element with key value x, or end() if there is none.

Definition at line 1027 of file table_index.hpp.

◆ find() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_iterator find ( const key_type & x ) const

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: Iterator to the element with key value x, or end() if there is none.

Definition at line 1040 of file table_index.hpp.

◆ count()

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::size_type count ( const key_type & x ) const

const

Precondition: table must be sorted.

Parameters

x	key value to count within the index

Returns: Count of the elements with key value x.

Definition at line 1053 of file table_index.hpp.

◆ lower_bound() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator lower_bound ( const key_type & x )

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: The first position where the element transformed to x could be inserted without violating the ordering of the table.

Definition at line 1061 of file table_index.hpp.

◆ lower_bound() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_iterator lower_bound ( const key_type & x ) const

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: The first position where the element transformed to x could be inserted without violating the ordering of the table.

Definition at line 1071 of file table_index.hpp.

◆ upper_bound() [1/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::iterator upper_bound ( const key_type & x )

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: The last position where the element transformed to x could be inserted without violating the ordering of the table.

Definition at line 1081 of file table_index.hpp.

◆ upper_bound() [2/2]

template<class Key, class T, class Compare, class Transform>

table_index< Key, T, Compare, Transform >::const_iterator upper_bound ( const key_type & x ) const

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: The last position where the element transformed to x could be inserted without violating the ordering of the table.

Definition at line 1091 of file table_index.hpp.

◆ equal_range() [1/2]

template<class Key, class T, class Compare, class Transform>

std::pair< typename table_index< Key, T, Compare, Transform >::iterator, typename table_index< Key, T, Compare, Transform >::iterator > equal_range ( const key_type & x )

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: Essentially a combination of the values returned by lower_bound and upper_bound

Definition at line 1102 of file table_index.hpp.

◆ equal_range() [2/2]

template<class Key, class T, class Compare, class Transform>

std::pair< typename table_index< Key, T, Compare, Transform >::const_iterator, typename table_index< Key, T, Compare, Transform >::const_iterator > equal_range ( const key_type & x ) const

Precondition: table must be sorted.

Parameters

x	key value to find within the index

Returns: Essentially a combination of the values returned by lower_bound and upper_bound

Definition at line 1113 of file table_index.hpp.

◆ transform()

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

transform_type transform ( ) const

Definition at line 774 of file table_index.hpp.

◆ swap [1/2]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

void swap	(	table_index< Key, T, Transform, Compare > &	x,
		table_index< Key, T, Transform, Compare > &	y )

friend

Definition at line 776 of file table_index.hpp.

◆ swap() [2/2]

template<typename Key, typename T, typename Transform = mem_data_t<T, const Key>, typename Compare = std::less<Key>>

void swap	(	adobe::table_index< Key, T, Transform, Compare > &	x,
		adobe::table_index< Key, T, Transform, Compare > &	y )

Swaps the contents of two table_indexes.

Parameters

x	the first table_index to swap.
y	the second table_index to swap.

Public Types

Public Member Functions

Friends

Related Symbols

Detailed Description

Member Typedef Documentation

◆ index_type

◆ transform_type

◆ key_type

◆ value_type

◆ key_compare

◆ reference

◆ const_reference

◆ size_type

◆ difference_type

◆ pointer

◆ const_pointer

◆ iterator

◆ const_iterator

◆ reverse_iterator

◆ const_reverse_iterator

Constructor & Destructor Documentation

◆ table_index() [1/3]

◆ table_index() [2/3]

◆ table_index() [3/3]

Member Function Documentation

◆ max_size()

◆ size()

◆ empty()

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ at() [1/2]

◆ at() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ push_back()

◆ pop_back()

◆ insert() [1/2]

◆ insert() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ clear()

◆ index() [1/2]

◆ index() [2/2]

◆ sort()

◆ unique()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ find() [1/2]

◆ find() [2/2]

◆ count()

◆ lower_bound() [1/2]

◆ lower_bound() [2/2]

◆ upper_bound() [1/2]

◆ upper_bound() [2/2]

◆ equal_range() [1/2]

◆ equal_range() [2/2]

◆ transform()

Friends And Related Symbol Documentation

◆ swap [1/2]

◆ swap() [2/2]