Subject: [Boost-commit] svn:boost r65996 - sandbox/itl/libs/itl/doc
From: afojgo_at_[hidden]
Date: 2010-10-15 20:41:20
Author: jofaber
Date: 2010-10-15 20:41:18 EDT (Fri, 15 Oct 2010)
New Revision: 65996
URL: http://svn.boost.org/trac/boost/changeset/65996
Log:
Updated documentation: Section Concepts. Modified table function synopsis.
Text files modified:
sandbox/itl/libs/itl/doc/interface.qbk | 69 +++++++++++++++++++++++----------------
sandbox/itl/libs/itl/doc/itl.qbk | 6 +++
2 files changed, 46 insertions(+), 29 deletions(-)
Modified: sandbox/itl/libs/itl/doc/interface.qbk
==============================================================================
--- sandbox/itl/libs/itl/doc/interface.qbk (original)
+++ sandbox/itl/libs/itl/doc/interface.qbk 2010-10-15 20:41:18 EDT (Fri, 15 Oct 2010)
@@ -352,7 +352,7 @@
sets and maps are provided.
[table Icl Associated types
-[[Purpose][Aspect][Type][interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[Purpose][Aspect][Type][interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[/[ ] [ ] [ ] [ ] [ ] [ ] [ ] [ ] ]
[/ interval itvset itvmap itl:set itl:map ]
[[['*Data*]] [__conceptual__][`domain_type`] [`D`] [`D`] [`D`] [`D`] [`D`] ]
@@ -361,13 +361,13 @@
[[ ] [ ][`segment_type`][`i<D,cp>`][`i<D,cp>`][`(i<D,cp>,C)`][ ] [ ] ]
[[ ] [['size] ][`size_type`] [`sz<D>`][`sz<D>`][`sz<D>`] [size_t] [size_t] ]
[[ ] [ ][`difference_type`] [`df<D>`][`df<D>`][`df<D>`] [size_t] [size_t] ]
-[[ ] [ ][][interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[ ] [ ][][interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[['*Data*]] [__iterative__ ][`key_type`] [`D`][`i<D,cp>`][`i<D,cp>`] [`D`] [`D`] ]
[[ ] [ ][`data_type`] [`D`][`i<D,cp>`] [`C`] [`D`] [`C`] ]
[[ ] [ ][`value_type`] [`D`][`i<D,cp>`][`(i<D,cp>,C)`][`D`][`(D,C)`]]
[[ ] [ ][`interval_type`] [`i<D,cp>`][`i<D,cp>`][`i<D,cp>`] [ ] [ ] ]
[[ ] [['allocation]][`allocator_type`] [ ][`a<i<D,cp>>`][`a<(i<D,cp>, C)>`][`a<D>`][`a<(D,C)>`]]
-[[ ] [ ][][interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[ ] [ ][][interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[['*Ordering*]] [__conceptual__][`domain_compare`] [`cp<D>`][`cp<D>`][`cp<D>`][`cp<D>`][`cp<D>`] ]
[[ ] [__iterative__ ][`key_compare`] [`cp<D>`] [`Xl`] [`Xl`] [`cp<D>`] [`cp<D>`] ]
[[ ] [ ][`interval_compare`] [ ] [`Xl`] [`Xl`] [ ] [ ] ]
@@ -409,6 +409,7 @@
[[`T` ] [] [a container type]]
[[`P` ] [] [polymorphical container argument type]]
[[`J` ] [] [polymorphical iterator type]]
+[[`K` ] [] [polymorphical element_iterator type for interval containers]]
[[`V` ] [] [various types `V`, that do dot fall in the categories above]]
[[1,2,... ] [] [number of implementations for this function]]
[[A ] [] [implementation generated by compilers]]
@@ -425,8 +426,8 @@
[/ memberref boost::itl::set::iterative_size `iterative_size`]
[table Icl Interfaces
-[[T] [interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
-[/ interval itvset itvmap itl:set itl:map ]
+[[T] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
+[/ interval itvset itvmap itl:set itl:map ]
[[__biLConsCopyDest__ [#function_synopsis_table]][ ] [ ] [ ] [ ] [ ] ]
[[`T::T()`] [1] [1] [1] [1] [1] ]
[[`T::T(const P&)`] [A] [__eiS] [__bpM] [1] [1] ]
@@ -434,13 +435,15 @@
[[`T& T::operator=(const P&)`] [A] [__S] [__M] [1] [1] ]
[[`void T::swap(T&)`] [ ] [1] [1] [1] [1] ]
-[[__biLContainedness__ ][interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[__biLContainedness__ ][interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[`void T::clear()`] [1] [1] [1] [1] [1] ]
+[[`void clear(const T&)`] [1] [1] [1] [1] [1] ]
[[`bool T::empty()const`] [1] [1] [1] [1] [1] ]
-[[`bool T::contains(const P&)const`] [__ei] [__eiS][__eiS __bpM][__es] [__bm] ]
-[[`bool T::contained_in(const P&)const`] [__i] [__S] [__M] [1] [1] ]
+[[`bool is_empty(const T&)`] [1] [1] [1] [1] [1] ]
+[[`bool contains(const T&, const P&)`] [__ei] [__eiS][__eiS __bpM][__es] [__bm] ]
+[[`bool within(const P&, const T&)`] [__ei] [__eiS][__eiS __bpM][__es] [__bm] ]
-[[__biLEquivsOrderings__ ][interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[__biLEquivsOrderings__ ][interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[`bool operator == (const T&, const T&)`] [1] [1] [1] [1] [1] ]
[[`bool operator != (const T&, const T&)`] [1] [1] [1] [1] [1] ]
[[`bool operator < (const T&, const T&)`] [1] [1] [1] [1] [1] ]
@@ -450,44 +453,46 @@
[[`bool is_element_equal(const T&, const P&)`] [ ] [__S] [__M] [1] [1] ]
[[`bool is_element_less(const T&, const P&)`] [ ] [__S] [__M] [1] [1] ]
[[`bool is_element_greater(const T&, const P&)`][ ] [__S] [__M] [1] [1] ]
-[[`bool is_protonic_equal(const T&, const P&)`][ ] [ ] [__M] [ ] [1] ]
+[[`bool is_distinct_equal(const T&, const P&)`][ ] [ ] [__M] [ ] [1] ]
-[[__biLSize__ ] [interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[__biLSize__ ] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[`size_type T::size()const`] [1] [1] [1] [1] [1] ]
-[[`size_type T::cardinality()const`] [1] [1] [1] [1] [1] ]
-[[`difference_type T::length()const`] [1] [1] [1] [ ] [ ] ]
-[[`size_t T::iterative_size()const`] [ ] [1] [1] [1] [1] ]
-[[`size_t T::interval_count()const`] [ ] [1] [1] [ ] [ ] ]
+[[`size_type size(const T&)`] [1] [1] [1] [1] [1] ]
+[[`size_type cardinality(const T&)`] [1] [1] [1] [1] [1] ]
+[[`difference_type length(const T&)`] [1] [1] [1] [ ] [ ] ]
+[[`size_t iterative_size(const T&)`] [ ] [1] [1] [1] [1] ]
+[[`size_t interval_count(const T&)`] [ ] [1] [1] [ ] [ ] ]
-[[__biLRange__ ] [ ] [ ] [ ] [ ] [ ] ]
+[[__biLRange__ ] [ ] [ ] [ ] [ ] [ ] ]
[[`interval<domain_type> hull(const T&)`] [ ] [1] [1] [ ] [ ] ]
-[[`domain_type T::lower()const`] [1] [1] [1] [ ] [ ] ]
-[[`domain_type T::upper()const`] [1] [1] [1] [ ] [ ] ]
-[[`domain_type T::first()const`] [1] [1] [1] [ ] [ ] ]
-[[`domain_type T::last()const`] [1] [1] [1] [ ] [ ] ]
-[[__biLSelection__ ] [ ] [ ] [ ] [ ] [ ] ]
+[[__biLSelection__ ] [ ] [ ] [ ] [ ] [ ] ]
[[`J T::find(const domain_type&)`] [ ] [1] [1] [2] [2] ]
[[`codomain_type& operator[] (const domain_type&)`][ ] [ ] [] [ ] [1] ]
[[`codomain_type operator() (const domain_type&)const`][ ][ ] [1] [ ] [1] ]
-[[__biLAddition__] [interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[__biLAddition__] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[`T& T::add(const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
[[`T& T::add(J pos, const P&)`] [ ] [__i] [__p] [__e] [__b] ]
+[[`T& add(T&, const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
+[[`T& add(T&, J pos, const P&)`] [ ] [__i] [__p] [__e] [__b] ]
[[`T& operator +=(T&, const P&)`] [ ] [__eiS] [__bpM] [__es] [__bm] ]
[[`T operator + (T, const P&)`\n`T operator + (const P&, T)`]
[ ] [__eiS] [__bpM] [__es] [__bm] ]
[[`T& operator |=( T&, const P&)`] [ ] [__eiS] [__bpM] [__es] [__bm] ]
[[`T operator | (T, const P&)`\n`T operator | (const P&, T)`]
[ ] [__eiS] [__bpM] [__es] [__bm] ]
-[[__biLSubtraction__] [ ] [ ] [ ] [ ] [ ] ]
+[[__biLSubtraction__] [ ] [ ] [ ] [ ] [ ] ]
[[`T& T::subtract(const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
+[[`T& subtract(T&, const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
[[`T& operator -=( T&, const P&)`] [ ] [__eiS][__eiS __bpM][__es] [__bm] ]
[[`T operator - (T, const P&)`] [ ] [__eiS][__eiS __bpM][__es] [__bm] ]
-[[__biLInsertion__] [interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[__biLInsertion__] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[`V T::insert(const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
[[`V T::insert(J pos, const P&)`] [ ] [__i] [__p] [__e] [__b] ]
+[[`V insert(T&, const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
+[[`V insert(T&, J pos, const P&)`] [ ] [__i] [__p] [__e] [__b] ]
[[`T& insert(T&, const P&)`] [ ] [__eiS] [__bpM] [__es] [__bm] ]
[[`T& T::set(const P&)`] [ ] [ ] [__bp] [ ] [1] ]
@@ -497,8 +502,8 @@
[[`void T::erase(iterator)`] [ ] [1] [1] [1] [1] ]
[[`void T::erase(iterator,iterator)`] [ ] [1] [1] [1] [1] ]
-[[__biLIntersection__] [interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
-[[`void T::add_intersection(T&, const P&)const`][ ] [__eiS][__eiS __bpM][ ] [ ] ]
+[[__biLIntersection__] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
+[[`void add_intersection(T&, const T&, const P&)`][ ] [__eiS][__eiS __bpM][ ] [ ] ]
[[`T& operator &=(T&, const P&)`] [__i] [__eiS][__eiS __bpM][__es] [__bm] ]
[[`T operator & (T, const P&)`\n`T operator & (const P&, T)`]
[__i] [__eiS][__eiS __bpM][__es] [__bm] ]
@@ -506,10 +511,11 @@
[[__biLSymmetricDifference__] [ ] [ ] [ ] [ ] [ ] ]
[[`T& T::flip(const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
+[[`T& flip(T&, const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
[[`T& operator ^=(T&, const P&)`] [ ] [__eiS] [__bpM] [__es] [__bm] ]
[[`T operator ^ (T, const P&)`\n`T operator ^ (const P&, T)`]
[ ] [__eiS] [__bpM] [__es] [__bm] ]
-[[__biLIteratorRelated__] [interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[__biLIteratorRelated__] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[`J T::begin()`] [ ] [2] [2] [2] [2] ]
[[`J T::end()`] [ ] [2] [2] [2] [2] ]
[[`J T::rbegin()`] [ ] [2] [2] [2] [2] ]
@@ -518,10 +524,15 @@
[[`J T::upper_bound(const key_type&)`] [ ] [2] [2] [2] [2] ]
[[`pair<J,J> T::equal_range(const key_type&)`] [ ] [2] [2] [2] [2] ]
-[[__biLStreaming__ ] [interval][__ch_itv_sets__][__ch_itv_maps__][itl::set][itl::map]]
+[[__biLIteratorRelated__] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
+[[`K elements_begin(P&)`] [ ] [2] [2] [2] [2] ]
+[[`K elements_end(P&)`] [ ] [2] [2] [2] [2] ]
+[[`K elements_rbegin(P&)`] [ ] [2] [2] [2] [2] ]
+[[`K elements_rend(P&)`] [ ] [2] [2] [2] [2] ]
+
+[[__biLStreaming__ ] [interval][__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]]
[[`std::basic_ostream operator << (basic_ostream&, const T&)`]
[1] [1] [1] [1] [1] ]
-[[`std::string T::as_string()`] [1] [1] [1] [1] [1] ]
]
[h4 Element iterators for interval containers]
Modified: sandbox/itl/libs/itl/doc/itl.qbk
==============================================================================
--- sandbox/itl/libs/itl/doc/itl.qbk (original)
+++ sandbox/itl/libs/itl/doc/itl.qbk 2010-10-15 20:41:18 EDT (Fri, 15 Oct 2010)
@@ -160,11 +160,17 @@
[def __ch_itv_t__ interval\ntype]
[def __ch_dom_mp_t__ domain\nmapping\ntype]
[def __ch_itv_mp_t__ interval\nmapping\ntype]
+
[def __ch_itv_sets__ interval\nsets]
[def __ch_itv_maps__ interval\nmaps]
[def __ch_itl_set__ interval\nsets]
[def __ch_itl_map__ interval\nmaps]
+[def __ch_ele_sets__ element\nsets]
+[def __ch_ele_maps__ element\nmaps]
+[def __ch_ele_set__ element\nsets]
+[def __ch_ele_map__ element\nmaps]
+
[def __bi_conceptual__ ['*fundamental*]]
[def __conceptual__ fundamental]
[def __Conceptual__ Fundamental]