A container used to represent a linear boolean selection.
List of all members.
A linear boolean selection is a set of context-free indices, each of which toggles the selection "on" or "off". From an implementation standpoint, each selection index must be greater than the one that precedes it (strictly monotonically increasing). There is also a boolean value associated with the selection, and that is to represent whether or not the selection is to start out "on" or "off" -- thus the inversion of a selection has the same selection boundary set but a different boolean value.
Selections are context-free, meaning that a selection can be spoken about without making reference to a container. This allows for selections to be manipulated without applying them to a series of elements (e.g., union, size, etc.). Selections can then be applied to a container to get context-relevant information (e.g., the number of elements contained within a selection). Selections can also be used in place of a predicate for some algorithms. There are a series of algorithms associated with the selection container; Please see selection.
Definition at line 48 of file selection.hpp.
Member Typedef Documentation
Constructor & Destructor Documentation
|start_selected||Specifies whether or not this selection begins "on" or not. If so, a selection has everything selected when it is first constructed (as it has no other toggle points). |
Definition at line 79 of file selection.hpp.
|| start_selected =
Constructor with the ability to initialize the selection with toggle points from the get-go.
[ first, last ) is strictly monotonically increasing
|first||an iterator to the first toggle point to include |
|last||an iterator to one past the last toggle point to include |
|start_selected||Specifies whether or not this selection begins "on" or not. |
Definition at line 94 of file selection.hpp.
Member Function Documentation
gets an iterator to the beginning of the toggle point sequence
Definition at line 121 of file selection.hpp.
true if there is at least one toggle point, or the selection starts selected.
Definition at line 108 of file selection.hpp.
gets an iterator to the end of the toggle point sequence
Definition at line 124 of file selection.hpp.
fetches a toggle point at index i of the toggle point sequence
Definition at line 127 of file selection.hpp.
pushes a toggle point onto the back of the selection. The index must be greater than the previous toggle point.
Definition at line 113 of file selection.hpp.
- the number of boundaries in the selection; to get the number of elements contained within a selection, a container must also be supplied, as such:
selection_t::size_type selected_element_size(adobe::size(selection, container))
Definition at line 104 of file selection.hpp.
- Whether or not the selection begins toggled "on"
Definition at line 139 of file selection.hpp.
Friends And Related Function Documentation