Subject: [Boost-commit] svn:boost r66081 - sandbox/itl/libs/itl/doc
From: afojgo_at_[hidden]
Date: 2010-10-18 12:06:05
Author: jofaber
Date: 2010-10-18 12:05:54 EDT (Mon, 18 Oct 2010)
New Revision: 66081
URL: http://svn.boost.org/trac/boost/changeset/66081
Log:
Updated documentation: Modified function references, symmetric difference. Modified Interface. Added section for intervals.
Text files modified:
sandbox/itl/libs/itl/doc/concepts.qbk | 2 +-
sandbox/itl/libs/itl/doc/icl.qbk | 13 +++++++++++--
sandbox/itl/libs/itl/doc/interface.qbk | 28 ++++++++++++++++++++++++----
3 files changed, 36 insertions(+), 7 deletions(-)
Modified: sandbox/itl/libs/itl/doc/concepts.qbk
==============================================================================
--- sandbox/itl/libs/itl/doc/concepts.qbk (original)
+++ sandbox/itl/libs/itl/doc/concepts.qbk 2010-10-18 12:05:54 EDT (Mon, 18 Oct 2010)
@@ -250,7 +250,7 @@
std::less,
inplace_identity //Combine parameter specified
> m;
-interval<int> itv = interval<int>::rightopen(2,7);
+interval<int>::type itv = interval<int>::rightopen(2,7);
m.add(make_pair(itv,42)); //same as insert
m.subtract(make_pair(itv,42)); //same as erase
``
Modified: sandbox/itl/libs/itl/doc/icl.qbk
==============================================================================
--- sandbox/itl/libs/itl/doc/icl.qbk (original)
+++ sandbox/itl/libs/itl/doc/icl.qbk 2010-10-18 12:05:54 EDT (Mon, 18 Oct 2010)
@@ -22,8 +22,17 @@
[def __itv__ `interval`]
[def __Itv__ `Interval`]
-[def __itv_tr__ [classref boost::icl::interval interval_traits]]
-[def __Itv_tr__ [classref boost::icl::interval Interval_traits]]
+[def __itv_tr__ [classref boost::icl::interval_traits interval_traits]]
+[def __Itv_tr__ [classref boost::icl::interval_traits Interval_traits]]
+
+[def __ro_itv__ [classref boost::icl::right_open_interval right_open_interval]]
+[def __lo_itv__ [classref boost::icl::right_open_interval left_open_interval]]
+[def __op_itv__ [classref boost::icl::open_interval open_interval]]
+[def __cl_itv__ [classref boost::icl::closed_interval closed_interval]]
+
+[def __dc_itv__ [classref boost::icl::closed_interval discrete_interval]]
+[def __ct_itv__ [classref boost::icl::closed_interval continous_interval]]
+
[def __itvs__ [classref boost::icl::interval intervals]]
[def __icl_itvs__ [classref boost::icl::interval icl::intervals]]
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-18 12:05:54 EDT (Mon, 18 Oct 2010)
@@ -16,11 +16,26 @@
[section Class templates]
+[section Intervals]
+
+[table Interval class templates
+[[group] [template] [instance parameters]]
+[[`static_bounded`] [__ro_itv__] [`<class DomainT,template<class>class Compare>`]]
+[[ ] [__lo_itv__] []]
+[[ ] [__cl_itv__] []]
+[[ ] [__op_itv__] []]
+[[`dynamic_bounded`] [__dc_itv__] []]
+[[ ] [__ct_itv__] []]
+]
+
+
+[endsect][/ Intervals]
+
+[section Sets]
+
The next two tables give an overview over ['*set class templates*] of
-the icl and compares them to std::set. Included is the __itv__ class
-template, because an interval is considered to be a set as well.
+the icl.
-[/ interval]
[/ interval_set]
[/ separate_interval_set]
[/ split_interval_set]
@@ -28,7 +43,7 @@
[table Set class templates
[[group] [template] [instance parameters]]
-[[__itv__] [__itv__] [`<DomainT,Compare>`]]
+[/ CL [__itv__] [__itv__] [`<DomainT,Compare>`]]
[[__itv_bsets__][__itv_set__] [`<DomainT,Compare,Interval,Alloc>`]]
[[] [__sep_itv_set__][`<DomainT,Compare,Interval,Alloc>`]]
[[] [__spl_itv_set__][`<DomainT,Compare,Interval,Alloc>`]]
@@ -51,6 +66,10 @@
[[__std_set__] [`_Key`] [`_Compare = std::less<_Key>`][] [`Alloc = std::alloc<_Key>`]]
]
+[endsect][/ Sets]
+
+[section Maps]
+
The next two tables give an overview over ['*map class templates*] of
the itl and compares them to =std::map=.
@@ -121,6 +140,7 @@
std::set<string, german_compare<string> > words; // 2nd parameter is a type
``
+[endsect][/ Maps]
[endsect][/ Class templates]
[section Required Concepts]