|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r58952 - in sandbox/itl/libs: itl/doc itl/doxy_doc itl/example/boost_party_ itl/example/interval_ itl/example/interval_container_ itl/example/large_bitset_ itl/example/man_power_ itl/example/month_and_week_grid_ itl/example/overlap_counter_ itl/example/party_ itl/example/partys_height_average_ itl/example/partys_tallest_guests_ itl/example/std_copy_ itl/example/std_transform_ itl/example/user_groups_ itl_xt/example/amount_cube_ itl_xt/example/history_ validate/example/de_morgan_
From: afojgo_at_[hidden]
Date: 2010-01-12 14:15:04
Author: jofaber
Date: 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
New Revision: 58952
URL: http://svn.boost.org/trac/boost/changeset/58952
Log:
Added Documentation: Brief descriptions for example files for the doxygen docs.
Text files modified:
sandbox/itl/libs/itl/doc/examples.qbk | 6 +++---
sandbox/itl/libs/itl/doxy_doc/Doxyfile | 2 +-
sandbox/itl/libs/itl/example/boost_party_/boost_party.cpp | 4 +++-
sandbox/itl/libs/itl/example/interval_/interval.cpp | 7 ++++---
sandbox/itl/libs/itl/example/interval_container_/interval_container.cpp | 6 +-----
sandbox/itl/libs/itl/example/large_bitset_/large_bitset.cpp | 13 +++++++++++++
sandbox/itl/libs/itl/example/man_power_/man_power.cpp | 1 +
sandbox/itl/libs/itl/example/month_and_week_grid_/month_and_week_grid.cpp | 1 +
sandbox/itl/libs/itl/example/overlap_counter_/overlap_counter.cpp | 3 +++
sandbox/itl/libs/itl/example/party_/party.cpp | 3 +--
sandbox/itl/libs/itl/example/partys_height_average_/partys_height_average.cpp | 8 +++++---
sandbox/itl/libs/itl/example/partys_tallest_guests_/partys_tallest_guests.cpp | 2 ++
sandbox/itl/libs/itl/example/std_copy_/std_copy.cpp | 1 +
sandbox/itl/libs/itl/example/std_transform_/std_transform.cpp | 1 +
sandbox/itl/libs/itl/example/user_groups_/user_groups.cpp | 4 +---
sandbox/itl/libs/itl_xt/example/amount_cube_/amount_cube.cpp | 1 +
sandbox/itl/libs/itl_xt/example/history_/history.cpp | 2 ++
sandbox/itl/libs/validate/example/de_morgan_/de_morgan.cpp | 4 ++--
18 files changed, 46 insertions(+), 23 deletions(-)
Modified: sandbox/itl/libs/itl/doc/examples.qbk
==============================================================================
--- sandbox/itl/libs/itl/doc/examples.qbk (original)
+++ sandbox/itl/libs/itl/doc/examples.qbk 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -22,7 +22,7 @@
Closed and open interval borders]]
[[basic] [[link boost_itl.examples.interval_container Interval container]]
[__itv_set__,\n__sep_itv_set__,\n__spl_itv_set__,\n__spl_itv_map__,\n__itv_map__]
- [basic characteristics of interval container]]
+ [Basic characteristics of interval containers]]
[[basic] [[link boost_itl.examples.overlap_counter Overlap counter]]
[__itv_map__][The most simple application of an interval map:
Counting the overlaps of added intervals.]]
@@ -31,12 +31,12 @@
[[basic] [[link boost_itl.examples.std_transform Std transform]]
[__itv_map__,\n__sep_itv_set__][Fill interval containers from user defined objects using `std::transform`.]]
[[advanced][[link boost_itl.examples.partys_height_average Party's height average]]
- [__itv_map__][Using /aggregate on overlap/ the average of party guests is computed.
+ [__itv_map__][Using /aggregate on overlap/ a history of height averages of party guests is computed.
Associated values are user defined class objects, that implement
an appropriate `operator +=` for the aggregation.]]
[[advanced][[link boost_itl.examples.partys_tallest_guests Party's tallest guests]]
[__itv_map__,\n__spl_itv_map__]
- [Using /aggregate on overlap/ the height of the party's tallest guests is computed.
+ [Using /aggregate on overlap/ the heights of the party's tallest guests are computed.
Associated values are aggregated via a maximum functor, that can
be chosen as template parameter of an interval_map class template.]]
[[advanced][[link boost_itl.examples.month_and_week_grid Time grids for months and weeks]]
Modified: sandbox/itl/libs/itl/doxy_doc/Doxyfile
==============================================================================
--- sandbox/itl/libs/itl/doxy_doc/Doxyfile (original)
+++ sandbox/itl/libs/itl/doxy_doc/Doxyfile 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -15,7 +15,7 @@
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
-STRIP_FROM_PATH = D:/cygwin/home/jofa/dev/boost_sandbox/itl
+STRIP_FROM_PATH = C:/cygwin/home/jofa/dev/boost_sandbox/itl
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
Modified: sandbox/itl/libs/itl/example/boost_party_/boost_party.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/boost_party_/boost_party.cpp (original)
+++ sandbox/itl/libs/itl/example/boost_party_/boost_party.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,7 +9,9 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
-/** Example boost_party.cpp \file boost_party.cpp
+/** Example boost_party.cpp \file boost_party.cpp
+ \brief Generates an attendance history of a party by inserting into an interval_map.
+ Demonstrating <i>aggregate on overlap</i>.
boost_party.cpp demonstrates the possibilities of an interval map
(interval_map or split_interval_map). Boost::posix_time::ptime is used as time
Modified: sandbox/itl/libs/itl/example/interval_/interval.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/interval_/interval.cpp (original)
+++ sandbox/itl/libs/itl/example/interval_/interval.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,11 +9,12 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
/** Example interval.cpp \file interval.cpp
+ \brief Intervals for integral and continuous instance types.
+ Closed and open interval borders.
Much of the library code deals with intervals which are implemented
- as class interval.
-
- This program gives a very short samlpe of different interval instances.
+ as class interval. This program gives a very short samlpe of different
+ interval instances.
\include interval_/interval.cpp
*/
Modified: sandbox/itl/libs/itl/example/interval_container_/interval_container.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/interval_container_/interval_container.cpp (original)
+++ sandbox/itl/libs/itl/example/interval_container_/interval_container.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -10,11 +10,7 @@
+-----------------------------------------------------------------------------*/
/** Example interval_container.cpp \file interval_container.cpp
- Sample file interval_container.cpp demontrates basic characteristics of
- interval container objects.
-
- Simple interactive shells for the manipulation of interval containers can be found
- in the 'tests.sln' project.
+ \brief Demonstrates basic characteristics of interval container objects.
\include interval_container_/interval_container.cpp
*/
Modified: sandbox/itl/libs/itl/example/large_bitset_/large_bitset.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/large_bitset_/large_bitset.cpp (original)
+++ sandbox/itl/libs/itl/example/large_bitset_/large_bitset.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -7,6 +7,19 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
/** Example large_bitset.cpp \file large_bitset.cpp
+ \brief Shows a bitset class that combines interval and bitset compression
+ in order to represent very large bitsets efficiently.
+
+ Example large_bitset.cpp demonstrates the usage of a large_bitset class
+ template that is implemented as an interval_map of bitsets. The idea is
+ to combine interval compression and bitset compression. Large uninterrupted
+ runs of bits are represented by intervals (interval compression). Local
+ nests of varying bitsequences are represented by associated bitests
+ (bitset compression).
+
+ Find a commented sample implementation in the boost book documentation
+ <a href="http://www.herold-faulhaber.de/boost_itl/doc/libs/itl/doc/html/boost_itl/projects.html#boost_itl.projects.large_bitset">
+ here</a>.
\include large_bitset_/large_bitset.cpp
*/
Modified: sandbox/itl/libs/itl/example/man_power_/man_power.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/man_power_/man_power.cpp (original)
+++ sandbox/itl/libs/itl/example/man_power_/man_power.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,6 +9,7 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
/** Example man_power.cpp \file man_power.cpp
+ \brief Using set style operators to compute with interval sets and maps.
Interval sets and maps can be filled and manipulated using
set style operation like union (+=), difference (-=) and intersection
Modified: sandbox/itl/libs/itl/example/month_and_week_grid_/month_and_week_grid.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/month_and_week_grid_/month_and_week_grid.cpp (original)
+++ sandbox/itl/libs/itl/example/month_and_week_grid_/month_and_week_grid.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,6 +9,7 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
/** Example month_and_week_grid.cpp \file month_and_week_grid.cpp
+ \brief Creating and combining time grids.
A split_interval_set preserves all interval borders on insertion
and intersection operations. So given a split_interval_set ...
Modified: sandbox/itl/libs/itl/example/overlap_counter_/overlap_counter.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/overlap_counter_/overlap_counter.cpp (original)
+++ sandbox/itl/libs/itl/example/overlap_counter_/overlap_counter.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -10,6 +10,9 @@
+-----------------------------------------------------------------------------*/
/** Example overlap_counter.cpp \file overlap_counter.cpp
+ \brief The most simple application of an interval map:
+ Counting the overlaps of added intervals.
+
The most basic application of an interval_map is a counter counting
the number of overlaps of intervals inserted into it.
Modified: sandbox/itl/libs/itl/example/party_/party.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/party_/party.cpp (original)
+++ sandbox/itl/libs/itl/example/party_/party.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -15,7 +15,7 @@
using namespace std;
using namespace boost::itl;
-/** Example party.cpp \file Party.cpp
+/**
Party.cpp demonstrates the possibilities of an interval map (interval_map or
split_interval_map). An interval_map maps intervals to a given content. In
@@ -50,7 +50,6 @@
The accumulative behavior accumulates associated values on every overlap of
an insertion for the associated values.
- \include party_/party.cpp
*/
// Type itl::set<string> collects the names of party guests. Therefore it needs to
Modified: sandbox/itl/libs/itl/example/partys_height_average_/partys_height_average.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/partys_height_average_/partys_height_average.cpp (original)
+++ sandbox/itl/libs/itl/example/partys_height_average_/partys_height_average.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -10,11 +10,13 @@
+-----------------------------------------------------------------------------*/
/** Example partys_height_average.cpp \file partys_height_average.cpp
+ \brief Using <i>aggregate on overlap</i> a history of height averages of
+ party guests is computed.
In partys_height_average.cpp we compute yet another aggregation:
- The average height of guests. This is done by defining a class
- counted_sum that sums up heights and counts the number of guests
- via an operator +=.
+ The average height of guests as it changes over time. This is done by
+ defining a class counted_sum that sums up heights and counts the number
+ of guests via an operator +=.
Based on the operator += we can aggregate counted sums on addition
of interval value pairs into an interval_map.
Modified: sandbox/itl/libs/itl/example/partys_tallest_guests_/partys_tallest_guests.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/partys_tallest_guests_/partys_tallest_guests.cpp (original)
+++ sandbox/itl/libs/itl/example/partys_tallest_guests_/partys_tallest_guests.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -10,6 +10,8 @@
+-----------------------------------------------------------------------------*/
/** Example partys_tallest_guests.cpp \file partys_tallest_guests.cpp
+ \brief Using <i>aggregate on overlap</i> the heights of the party's tallest
+ guests are computed.
In partys_tallest_guests.cpp we use a different instantiation of
interval map templates to compute maxima of guest heights.
Modified: sandbox/itl/libs/itl/example/std_copy_/std_copy.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/std_copy_/std_copy.cpp (original)
+++ sandbox/itl/libs/itl/example/std_copy_/std_copy.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,6 +9,7 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
/** Example std_copy.cpp \file std_copy.cpp
+ \brief Fill interval containers using std::copy.
Example std_copy shows how algorithm std::copy can be used to
fill interval containers from other std::containers and how copying
Modified: sandbox/itl/libs/itl/example/std_transform_/std_transform.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/std_transform_/std_transform.cpp (original)
+++ sandbox/itl/libs/itl/example/std_transform_/std_transform.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,6 +9,7 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
/** Example std_transform.cpp \file std_transform.cpp
+ \brief Fill interval containers from user defined objects using std::transform.
Example std_transform shows how algorithm std::transform can be used to
fill interval containers from std::containers of objects of a user
Modified: sandbox/itl/libs/itl/example/user_groups_/user_groups.cpp
==============================================================================
--- sandbox/itl/libs/itl/example/user_groups_/user_groups.cpp (original)
+++ sandbox/itl/libs/itl/example/user_groups_/user_groups.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,9 +9,7 @@
http://www.boost.org/LICENSE_1_0.txt)
+-----------------------------------------------------------------------------*/
/** Example user_groups.cpp \file user_groups.cpp
-
- Example user_groups.cpp shows the availability of set operations
- on interval maps.
+ \brief Shows the availability of set operations on interval maps.
In the example there is a user group 'med_users' of a hosptial staff
that has the authorisation to handle medical data of patients.
Modified: sandbox/itl/libs/itl_xt/example/amount_cube_/amount_cube.cpp
==============================================================================
--- sandbox/itl/libs/itl_xt/example/amount_cube_/amount_cube.cpp (original)
+++ sandbox/itl/libs/itl_xt/example/amount_cube_/amount_cube.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -22,6 +22,7 @@
using namespace boost::itl;
/** Example amount_cube.cpp \file amount_cube.cpp
+ \brief Demonstrates computations of aggregates using maps of tuples or <i>cubes</i>
The template class TupelComputerT is a general class for computing aggregations
on values that are associated to elements of a cartesian product. Stated more
Modified: sandbox/itl/libs/itl_xt/example/history_/history.cpp
==============================================================================
--- sandbox/itl/libs/itl_xt/example/history_/history.cpp (original)
+++ sandbox/itl/libs/itl_xt/example/history_/history.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -14,6 +14,8 @@
#include "../toytime.h"
/** Example history.cpp \file history.cpp
+\brief Shows how different attributes that change in time are merged into a
+ single history object.
History demonstrates further possibilities of an interval map
(interval_map or split_interval_map). For a more basic example see party.cpp.
Modified: sandbox/itl/libs/validate/example/de_morgan_/de_morgan.cpp
==============================================================================
--- sandbox/itl/libs/validate/example/de_morgan_/de_morgan.cpp (original)
+++ sandbox/itl/libs/validate/example/de_morgan_/de_morgan.cpp 2010-01-12 14:15:02 EST (Tue, 12 Jan 2010)
@@ -9,11 +9,11 @@
+-----------------------------------------------------------------------------*/
/** Example de_morgan.cpp \file de_morgan.cpp
+\brief Demonstrates law based testing for De Morgan's law on interval_sets.
Example de_morgan.cpp demonstrates some tests of
<a href="http://en.wikipedia.org/wiki/De_Morgan%27s_laws">
-De Morgan's law</a>
-on interval_set.
+De Morgan's law</a> on interval_set.
This law is selected, because we can show some interesting semantical
distinctions that reveal themselves in different instantiations of the law.
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