|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r66076 - sandbox/itl/libs/itl/doc
From: afojgo_at_[hidden]
Date: 2010-10-18 08:29:29
Author: jofaber
Date: 2010-10-18 08:29:27 EDT (Mon, 18 Oct 2010)
New Revision: 66076
URL: http://svn.boost.org/trac/boost/changeset/66076
Log:
Updated documentation: Modified function references, symmetric difference.
Text files modified:
sandbox/itl/libs/itl/doc/functions_symmetric_difference.qbk | 84 +++++++++++++++++++--------------------
sandbox/itl/libs/itl/doc/interface.qbk | 5 +
2 files changed, 43 insertions(+), 46 deletions(-)
Modified: sandbox/itl/libs/itl/doc/functions_symmetric_difference.qbk
==============================================================================
--- sandbox/itl/libs/itl/doc/functions_symmetric_difference.qbk (original)
+++ sandbox/itl/libs/itl/doc/functions_symmetric_difference.qbk 2010-10-18 08:29:27 EDT (Mon, 18 Oct 2010)
@@ -13,10 +13,14 @@
[section Synopsis][/ Symmetric difference]
[table
-[[Symmetric difference] [__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__] ]
-[[`T& T::flip(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] ]
+[[Symmetric difference] [__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__] ]
+
+[[`T& T::flip(const P&)`] [__ei] [__bp] [ ] [__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] ]
+
]
Functions and operators that implement ['*symmetric difference*] on *itl* objects
@@ -34,18 +38,21 @@
[endsect][/ Synopsis Symmetric difference]
-[section Member functions][/ Symmetric difference]
+[section Functions][/ Symmetric difference]
/Symmetric difference/ is implemented on interval containers
-by the member function `T& T::flip(const P& operand)`.
+by the function `T& flip(T&, const P& operand)`.
``
-y.flip(x)
+flip(y,x)
``
deletes every element of `y`,
if it is contained in `x`. Elements of
`x` not contained in `y` are added.
+For icl containers flip is also availabel as memeber function
+`T& T::flip(const P& operand)`.
+
[/ paratract, surtract, symetract, topple, symmetric_subtract]
The admissible combinations of types for member function
@@ -53,21 +60,19 @@
['*overload table*] below:
``
-// overload table for
-T& T::flip(const P&)
-
-flip | e i b p
------+--------
- s | s
- m | m
- S | S S
- M | M M
+/* overload table for */ T\P| e i b p
+T& T::flip(const P&) ---+--------
+T& flip(T&, const P&) s | s
+ m | m
+ S | S S
+ M | M M
``
-The next table contains complexity characteristics for member functions `flip`.
+The next table contains complexity characteristics for functions `flip`.
[table Time Complexity for member functions flip on icl containers
-[[`T& T::flip(const P&)`] [__ch_dom_t__][__ch_itv_t__][__ch_dom_mp_t__][__ch_itv_mp_t__]]
+[[`T& T::flip(const P&)`\n
+ `T& flip(T&, const P&)`] [__ch_dom_t__][__ch_itv_t__][__ch_dom_mp_t__][__ch_itv_mp_t__]]
[[__icl_set__] [__Olgn__] [] [] [] ]
[[__icl_map__] [] [] [__Olgn__][] ]
[[__itv_set__\n__sep_itv_set__][__Olgn__] [__On__] [] [] ]
@@ -85,17 +90,12 @@
that implements ['*symmetric difference*].
``
-// overload tables for
-T& operator ^= (T&, const P&)
-
-element containers: interval containers:
-^= | e b s m ^= | e i b p S M
----+-------- ---+------------
-s | s s S | S S S
-m | m m M | M M M
+// overload tables for element containers: interval containers:
+T& operator ^= (T&, const P&) ^= | e b s m ^= | e i b p S M
+ ---+-------- ---+------------
+ s | s s S | S S S
+ m | m m M | M M M
``
-
-
Complexity characteristics for inplace operators
that implement ['*symmetric difference*]
are given by the next tables where
@@ -124,22 +124,18 @@
following overloads are available:
``
-// overload tables for
-T operator ^ (T, const P&)
-T operator ^ (const P&, T)
-
-element containers: interval containers:
-^ | e b s m ^ | e i b p S1 S2 S3 M1 M3
----+-------- ---+---------------------------
-e | s e | S1 S2 S3
-b | m i | S1 S2 S3
-s | s s b | M1 M3
-m | m m p | M1 M3
- S1 | S1 S1 S1 S2 S3
- S2 | S2 S2 S2 S2 S3
- S3 | S3 S3 S3 S3 S3
- M1 | M1 M1 M1 M3
- M3 | M3 M3 M3 M3
+// overload tables for element containers: interval containers:
+T operator ^ (T, const P&) ^ | e b s m ^ | e i b p S1 S2 S3 M1 M3
+T operator ^ (const P&, T) ---+-------- ---+---------------------------
+ e | s e | S1 S2 S3
+ b | m i | S1 S2 S3
+ s | s s b | M1 M3
+ m | m m p | M1 M3
+ S1 | S1 S1 S1 S2 S3
+ S2 | S2 S2 S2 S2 S3
+ S3 | S3 S3 S3 S3 S3
+ M1 | M1 M1 M1 M3
+ M3 | M3 M3 M3 M3
``
To resolve ambiguities among interval containers
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 08:29:27 EDT (Mon, 18 Oct 2010)
@@ -524,11 +524,12 @@
`bool disjoint(const T&, const P&)`] [__i] [__eiS][__eiS __bpM][__es] [__bm] ]
[[__biLSymmetricDifference__] [ ] [ ] [ ] [ ] [ ] ]
-[[`T& T::flip(const P&)`\n
- `T& flip(T&, const P&)`] [ ] [__ei] [__bp] [__e] [__b] ]
+[[`T& T::flip(const P&)`] [ ] [__ei] [__bp] [ ] [__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__] [__ch_itvs__][__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] ]
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk