Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r66396 - in sandbox/icl/libs/icl: doc doxy_doc doxy_doc/doxygen_input/pages prj_home
From: afojgo_at_[hidden]
Date: 2010-11-04 06:27:09


Author: jofaber
Date: 2010-11-04 06:27:04 EDT (Thu, 04 Nov 2010)
New Revision: 66396
URL: http://svn.boost.org/trac/boost/changeset/66396

Log:
Corrections on docs and html pages.
Added:
   sandbox/icl/libs/icl/prj_home/index.html (contents, props changed)
Text files modified:
   sandbox/icl/libs/icl/doc/introduction.qbk | 2
   sandbox/icl/libs/icl/doxy_doc/Doxyfile | 2
   sandbox/icl/libs/icl/doxy_doc/doxygen_input/pages/doxygen_mainpage.hpp | 82 ++++++++++++++++++++++++++++-----------
   3 files changed, 61 insertions(+), 25 deletions(-)

Modified: sandbox/icl/libs/icl/doc/introduction.qbk
==============================================================================
--- sandbox/icl/libs/icl/doc/introduction.qbk (original)
+++ sandbox/icl/libs/icl/doc/introduction.qbk 2010-11-04 06:27:04 EDT (Thu, 04 Nov 2010)
@@ -76,7 +76,7 @@
 
 [section Definition and Basic Example]
 
-The [*Interval Template Library (ICL)] provides __itvs__ and two kinds of
+The [*Interval Container Library (ICL)] provides __itvs__ and two kinds of
 interval containers: __itv_sets__ and __itv_maps__.
 
 * An __itv_bset__ is a *set* that is implemented as a set of intervals.

Modified: sandbox/icl/libs/icl/doxy_doc/Doxyfile
==============================================================================
--- sandbox/icl/libs/icl/doxy_doc/Doxyfile (original)
+++ sandbox/icl/libs/icl/doxy_doc/Doxyfile 2010-11-04 06:27:04 EDT (Thu, 04 Nov 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/icl
+STRIP_FROM_PATH = D:/cygwin/home/jofa/dev/boost_sandbox/itl
 STRIP_FROM_INC_PATH =
 SHORT_NAMES = NO
 JAVADOC_AUTOBRIEF = NO

Modified: sandbox/icl/libs/icl/doxy_doc/doxygen_input/pages/doxygen_mainpage.hpp
==============================================================================
--- sandbox/icl/libs/icl/doxy_doc/doxygen_input/pages/doxygen_mainpage.hpp (original)
+++ sandbox/icl/libs/icl/doxy_doc/doxygen_input/pages/doxygen_mainpage.hpp 2010-11-04 06:27:04 EDT (Thu, 04 Nov 2010)
@@ -11,12 +11,12 @@
 #define BOOST_ICL_DOXYGEN_MAINPAGE_HPP_JOFA_091216
 
 /**
-\mainpage Boost Interval Container Library
+\mainpage Interval Container Library (aka. Interval Template Library)
 
-\section header_sec Boost Interval Container Library
+\section header_sec Interval Container Library
 
 Author: Joachim Faulhaber\n
-Copyright (c) 2007-2009: Joachim Faulhaber\n
+Copyright (c) 2007-2010: Joachim Faulhaber\n
 Copyright (c) 1999-2006: Cortex Software GmbH, Berlin\n
 
 Distributed under the Boost Software License, Version 1.0.\n
@@ -25,26 +25,29 @@
 
 \section overview_sec Overview
 
-The <b>Boost Interval Container Library (ITL+)</b> is a collection of
+The <b>Interval Container Library (ICL+)</b>
+formerly known as <b>Interval Template Library (ITL)</b>
+is a collection of
 generic c++ class templates for computations on intervals,
 interval containers, large bitsets and generalized crosstables or cubes.
 
 The complete library constists of three parts.
 
 <ul>
-<li><b>Core library (itl):</b> Interval containers.
+<li><b>Core library (Boost.Icl):</b> Interval containers.
+
+The <b>core library</b> is accepted into the
+Boost c++ Libraries Collection
+as <b>Interval Container Library Boost.Icl</b>.
+A <b>detailed boost book documentation</b> for Boost.Icl is
+<a href="http://www.herold-faulhaber.de/boost_icl/doc/libs/icl/doc/html/index.html">
 
-The <b>core library (ITL)</b> is currently submitted for review at the
-Boost c++ Libraries Collection
-as Boost.IntervalContainer Library.
-A <b>detailed boost book documentation</b> for Boost.IntervalContainers is
-<a href="http://www.herold-faulhaber.de/boost_itl/doc/libs/icl/doc/html/index.html">
 online available here</a>.
 We recommend to refer to this documentation for all informations related
 to interval containers. The boost book documentation also ships with
 this release and can be found at "<boost_root>/libs/icl/doc/html/index.html".
 
-<li><b>Extended library (itl_xt):</b>
+<li><b>Extended library (icl_xt):</b>
 
 The extended part contains class templates interval_bitset, product_history, and tupel_computer
 (cubes). Those parts are not or not yet intended to be proposed for boost.
@@ -53,14 +56,14 @@
 
 The Law Based Test Automaton (also refered to as \b \i LaBatea) is a tool for an
 automated teststing of code on the basis of laws or axioms.
-\b LaBatea has been used to validate the core library (itl)
+\b LaBatea has been used to validate the core library (icl)
 for a number of laws.
 
 </ul>
 
 
 <b>This doxygen generated documentation</b> is provided for the
-additional library parts \b itl_xt and \b validate
+additional library parts \b icl_xt and \b validate
 that are not yet covered by a proper boost book documentation.
 \n \n
 
@@ -68,14 +71,47 @@
 
 <ul>
 
+<li>Changes after the review
+
+A number of changes have been done after the review as a result of the
+reviews and the related discussion.
+
+<ul>
+
+<li>New library name
+
+The library's name has been changed form <b>Interval Template Library</b>
+to <b>Interval Container Library</b>.
+
+<li>Customizability
+
+The library is now customizable for user defined interval types. A user
+defined type can be registered and adapted by
+<a href="http://www.herold-faulhaber.de/boost_icl/doc/libs/icl/doc/html/boost_icl/examples/custom_interval.html">
+partially instantiating a small interval_traits class.</a>
+
+<li>Intervals with static bounds
+
+Intervals with static or fixed bounds can now be used with the library.
+Statically bounded intervals use less memory and perform 25% faster on average
+than dynamically bounded intervals.
+
+<li> Extraction of algorithms to concepts.
+
+Most of the class templates member functions have been extracted to sets of namespace
+global functions that build <b>concepts</b>. Some functions have been have been renamed to
+conform existing standards.
+
+</ul>
+
 <li>Interval_bitset.
 
-The lastest addition to the library are interval_bitsets.
+The lastest addition of a container class template to the library is interval_bitsets.
 Interval_bitsets use interval compression and bitset compression
 to achieve a very efficient and compact representation of large
 bitsets. The idea and implementation of interval_bitsets is
 explained in the
-<a href="http://www.herold-faulhaber.de/boost_itl/doc/libs/icl/doc/html/boost_itl/projects.html#boost_itl.projects.large_bitset">
+<a href="http://www.herold-faulhaber.de/boost_icl/doc/libs/icl/doc/html/boost_icl/projects.html#boost_icl.projects.large_bitset">
 project section</a>
 of the boost book documentation.
 
@@ -84,9 +120,9 @@
 To copy or tranform data from std::containers of intervals or segments into
 interval containers you can use an icl::insert_iterator or an icl::add_iterator.
 See examples
-<a href="http://www.herold-faulhaber.de/boost_itl/doc/libs/icl/doc/html/boost_itl/examples/std_copy.html">
+<a href="http://www.herold-faulhaber.de/boost_icl/doc/libs/icl/doc/html/boost_icl/examples/std_copy.html">
 std_copy</a> and
-<a href="http://www.herold-faulhaber.de/boost_itl/doc/libs/icl/doc/html/boost_itl/examples/std_transform.html">
+<a href="http://www.herold-faulhaber.de/boost_icl/doc/libs/icl/doc/html/boost_icl/examples/std_transform.html">
 std_transform.</a>
 
 <li>Element iteration.
@@ -103,27 +139,27 @@
 characteristics of the class templates offered by the library. To get an instant
 impression you may browse these examples first.
 
-\subsection examples_itl_subsec Examples on Interval Containers (core library itl)
+\subsection examples_icl_subsec Examples on Interval Containers (core library icl)
 
 <ul>
 <li>A <b>collection of examples</b> on interval containers is
 included in the
-<a href="http://www.herold-faulhaber.de/boost_itl/doc/libs/icl/doc/html/boost_itl/examples.html">
+<a href="http://www.herold-faulhaber.de/boost_icl/doc/libs/icl/doc/html/boost_icl/examples.html">
 boost book documentation</a>.
 </ul>
 \n \n
 
 
-\subsection examples_itl_xt_subsec Examples for the extended library (itl_xt)
+\subsection examples_icl_xt_subsec Examples for the extended library (icl_xt)
 
 <ul>
 <li> <b>Interval Bitset</b>
 
 A minimal implementation of \ref interval_bitset together with
 sample applications is included in the boost book documentation in the
-<a href="http://www.herold-faulhaber.de/boost_itl/doc/libs/icl/doc/html/boost_itl/projects.html#boost_itl.projects.large_bitset">
+<a href="http://www.herold-faulhaber.de/boost_icl/doc/libs/icl/doc/html/boost_icl/projects.html#boost_icl.projects.large_bitset">
 project section</a>. The full implementation of \ref interval_bitset is
-not yet part of the core library (itl). It's in the extended part (itl_xt)
+not yet part of the core library (icl). It's in the extended part (icl_xt)
 but it's integration into the core is intended.
 
 
@@ -137,7 +173,7 @@
 <li> <b>Amount Cube</b>
 
 Cubes or tuple computers allow to perform computations on values associated
-to tuples. A ITL tuple computer works similar to pivot tables (in spreadsheet programs)
+to tuples. A ICL tuple computer works similar to pivot tables (in spreadsheet programs)
 olap cubes (online analytic processing) or crosstables (in statistical programs).
 Sample amount_cube.cpp presents an application where values are \e 'amounts',
 which is the simplest instance.

Added: sandbox/icl/libs/icl/prj_home/index.html
==============================================================================
--- (empty file)
+++ sandbox/icl/libs/icl/prj_home/index.html 2010-11-04 06:27:04 EDT (Thu, 04 Nov 2010)
@@ -0,0 +1,378 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>interval container library: The Interval Container Library</title>
+</head>
+
+<body>
+
+<FONT FACE=verdana SIZE=+1 COLOR=#000081>
+
+<table>
+ <tr>
+ <td width="34%">
+ <FONT FACE=verdana SIZE=+1 COLOR=#000081>
+ <i>Welcome to the homepage of <br><br>
+
+ <FONT FACE=verdana SIZE=+2 COLOR=#000081>
+ Joachim Faulhaber <br>
+ <FONT FACE=verdana SIZE=+1 COLOR=#000081>
+ and the </i><br>
+ <FONT FACE=verdana SIZE=+2 COLOR=#339999>
+ <i>Interval Container Library</i><br>
+ <FONT FACE=verdana SIZE=+1 COLOR=#339999>
+ <i>(aka. Interval Template Library)</i>
+ <br><br>
+ </td>
+
+ <td></td>
+
+ <td align="right" aligh="top">
+ <FONT FACE=verdana SIZE=-1>
+ <p>&ldquo;This can be a really useful class of data structures.
+ I support continued work on getting this into Boost.&rdquo;<br>
+ &mdash;
+ Dave Abrahams
+ <!-- a HREF="http://en.wikipedia.org/wiki/David_Abrahams_(computer_programmer)">Dave Abrahams</a-->
+ </p>
+
+ <p>&ldquo;A brief reading of this shows the code and documentation to be in mature shape with
+ some interesting examples, that I feel sure will find application elsewhere.
+ Personally, I think this would be a useful addition to Boost.&rdquo;
+ <br>&mdash; Paul A. Bristow, coauthor of
+ <a HREF="http://www.boost.org/doc/libs/1_42_0/libs/math/doc/html/index.html">
+ Boost.Math</a>
+ </p>
+
+ <p>
+ &ldquo;So I love ITL &mdash; it really solved the visualization problem I was
+ having. [...] Visualizing that amount of data, in real time, is quite a challenge. I'm
+ using ITL to track pre-rendered regions of this time series data. It
+ does exactly what I want.&rdquo;
+
+ <br>&mdash; Eric M. Jonas, coauthor of
+ The Soma Project
+ </p>
+ </td>
+ </tr>
+</table>
+
+
+<table cellspacing=12 cellpadding=6 width=100% >
+ <FONT FACE=verdana SIZE=+0 COLOR=#000081>
+ <tr>
+ <!-- td bgcolor=#E2E7FF more plummy (red) -->
+ <td bgcolor=#CEE3F6> <!-- Light grey blue -->
+ <FONT FACE=verdana SIZE=+0>
+ The
+ <FONT COLOR=#339999><b>Interval Container Library</b></font>
+ is an STL based generic c++ library for computations on intervals, interval containers, cubes and more.
+ </tr>
+</table>
+
+
+
+<table>
+ <FONT FACE=verdana SIZE=+0 COLOR=#000081>
+ <tr>
+ <td width=50%>
+ <FONT FACE=verdana SIZE=+0 COLOR=#000081>
+ <ul>
+ <li>The core library
+ <FONT COLOR=#339999><b>ICL</b></font>
+ provides generic intervals, interval sets and interval maps.
+ <li>The extended library
+ <FONT COLOR=#339999><b>ICL+</b></font>
+ includes the core library and implements interval bitsets, cubes, histories,
+ and law based testing in addition.
+ <ul>
+ </td>
+
+ <td>
+ <FONT FACE=verdana SIZE=+0 COLOR=#000081>
+ <ul>
+ <li>Efficient stl compatible interval_sets and interval_maps
+ <li>Aggregation of associated values on overlap for interval_maps
+ <li>Set theoretic operations as infix and inplace operators
+ <li>Iterator support on the level of intervals and elements
+ <li>An interval_bitset for very large compressed bitsets
+ </ul>
+ </td>
+ </tr>
+</table>
+
+
+<table cellspacing=12 cellpadding=6>
+ <FONT FACE=verdana SIZE=+0 COLOR=#000081>
+<tr>
+ <td bgcolor=#CEE3F6><FONT FACE="courier new">News</td>
+ <td colspan=3 bgcolor=#CEE3F6>
+ <FONT FACE="courier new">
+ The ICL library has been accepted into boost!
+ Many thanks to all the reviewers and review manager Hartmut Kaiser.
+ The library has been renamed and some changes proposed during the review
+ are now implemented.
+ The ICL is now prepared for inclusion into the boost release 1.46.0.
+ </td>
+</tr>
+
+<tr>
+ <td></td>
+ <td colspan=2 bgcolor=#E2F3FF>
+ Read the formal review results
+ by review manager Hartmut Kaiser from April 18, 2010.
+ </td>
+</tr>
+
+<tr>
+ <td></td>
+ <td colspan=2 bgcolor=#E2F3FF>
+ Read the review
+ authored by Eric M. Jonas, PhD Candidate, MIT Brain and Cognitive Sciences.
+ </td>
+</tr>
+
+<tr>
+ <td></td>
+ <td></td>
+ <td></td>
+</tr>
+
+<tr>
+ <td bgcolor=#CEE3F6>Documentation</td>
+ <td bgcolor=#CEEDFF>
+ <a HREF="boost_icl/doc/icl.html">
+ <FONT FACE=verdana SIZE=+0 COLOR=#339999>ICL</a>
+ </td>
+ <td bgcolor=#CEE3F6>A detailed boost book documentation of the core library of interval containers.
+ The core library is submitted for review at the boost library collection.</td>
+
+ <td rowspan=6 align="center">
+ <!-- FONT FACE=verdana SIZE=+0 COLOR=#339999><b><i>P O W E R E D B Y</i></b></font>
+ <br>
+ <br -->
+ <a href="http://www.boost.org/">
+ <img src="boost_powered_by.png"
+ width="210" height="62" border="0" alt="Boost.org Logo" />
+ </a>
+ <br>
+ <br>
+ <br>
+ <a href="http://www.cortex-software.de/desktopdefault.aspx">
+ <img src="logo_cortex.png"
+ border="0" alt="Cortex Logo" />
+ </a>
+ <br>
+ <br>
+ <br>
+ <a href="http://sourceforge.net">
+ <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=199644&amp;type=5"
+ width="210" height="62" border="0" alt="SourceForge.net Logo" />
+ </a>
+ </td>
+
+ </tr>
+<tr>
+ <td> </td>
+ <td bgcolor=#CEEDFF>
+ <a HREF="icl/index.html">
+ <FONT FACE=verdana SIZE=+0 COLOR=#339999>ICL+</a>
+ </td>
+ <td bgcolor=#CEE3F6>A doxygen generated documentation of the extended library of interval containers,
+ histories, cubes and the law based test tool LaBatea.</td>
+</tr>
+<tr>
+ <td bgcolor=#E2F3FF>Download</td>
+ <td bgcolor=#CEEDFF>
+ <a HREF="http://www.boostpro.com/vault/index.php?&direction=0&order=&directory=Containers">
+ <FONT FACE=verdana SIZE=+0 COLOR=#339999>ICL</a>
+ </td>
+ <td bgcolor=#DDF3FF>
+ <!-- FONT FACE=verdana SIZE=+0 COLOR=#B4045F><i>Currently unavailabe!</i></font -->
+ The core library from the boost vault.
+ <i>Review version.</i>
+ </td>
+</tr>
+<tr>
+ <td> </td>
+ <td bgcolor=#CEEDFF>
+ <a HREF="http://sourceforge.net/projects/itl/">
+ <FONT FACE=verdana SIZE=+0 COLOR=#339999>ICL+</a>
+ </td>
+ <td bgcolor=#DDF3FF>The extended library from sourceforge, that also contains the <i>Review version.</i></td>
+</tr>
+</table>
+
+<br>
+
+<!-- ========================================================================== -->
+<table cellspacing=12 cellpadding=6>
+<tr>
+ <td bgcolor=#CEE3F6 colspan=3>Revision History</td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 4.0.0
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2010-11-04
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ <!-- b>Inclusion Version, update 2:</b -->
+ Version for inclusion into boost 1.46.0. The library's name was changed to Interval Container Library (ICL).
+ Addition of statically bounded intervals. Addition of an interval concept and an interval traits class.
+ Made user defined intervals customizable. Extracted memberfunctions to sets of namespace global
+ functions that build an interval_set and interval_map concept. Renamed some functions to conform
+ existing standards (ISO/OGC) and notions (identity_element, unit_element).
+ </td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 3.2.1
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2010-01-16
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ <!-- b>Review Version, update 2:</b -->
+ Addition of doxygen generated documentation for extended library parts.
+ Basic documentation and example for law based testing.
+ </td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 3.2.0
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2009-12-08
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ <!-- b>Review Version, update 1:</b -->
+ Implementation of element iterators for all interval containers.
+ Implementation of bit iterators for interval bitsets.
+ Added a commented example implementation
+ "large bitset" to the quickbook documentation.
+ Implementation of large interval_bitset including bit iterators.
+ Added itl::insert_iterator itl::add_iterator to fill interval
+ containers from stl containers of intervals.
+ Implemented boost warning policy.
+ Law based tests of element iteration, bit iteration and
+ applicability of stl algorithms
+ (SortedAssociativeContainer properties).
+ </td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 3.1.0
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2009-09-18
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ <!-- b>Review Version:</b -->
+ Algorithms are being refactored
+ to improve efficiency.
+ Documentation of complexity guarantees.
+ Completion of quickbook documentation.
+ Added time measurement to law based tests.
+ Addition of law based tests to test suites.
+ </td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 3.0.0
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2009-03-04
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ <!-- b>BoostCon09 version:</b -->
+ The library files are reorganized to comply the boost centric project structure.
+ All set theoretic functions are implemented as namspace global operators in an
+ assigning o= and an infix variant. Overloads within and between interval
+ containers and for elements and segments are implemented. Intersection
+ operator changed form (*=, *) to (&=, &).
+ The library has been validated for a number of semantical constraints
+ using a law based tester. The results of these tests is documented in the
+ boost quickbook documentation in section <i>semantics</i>.
+ Added a test suite using Boost.Test. Tests for interoperability with
+ Boost.Date_Time and Boost.Rational.
+ </td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2.0.1
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2008-07-28
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ <!-- http://old.nabble.com/proposal:-interval-containers--boost-examples-and-more-td18706482.html -->
+ Redesign of all interval container class templates according to
+ boost standards. Replacing virtual functions by means of static
+ polymorphism using the CRT pattern. Adding the self minimizing
+ interval_map and the separating separate_interval_set. Separation
+ of add/subtract from insert/erase semantics. Starting to develop
+ the law based tester and performing law based tests.
+ Improvement of the doxygen generated documentation. Improved
+ and new examples that use boost code particularly boost date and
+ time classes.
+ </td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2.0.0
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2008-05-11
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ <!-- http://lists.boost.org/Archives/boost/2008/05/137301.php -->
+ This version is refactored from the initial version for some basic
+ boost standards, like naming conventions, third library
+ dependencies and basic portability. This version has been used for
+ the first proposal on the boost developers list.
+ Improving doxygen generated documentation and examples.
+ </td>
+</tr>
+<tr>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 1.0.0
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ 2007-05-17
+ </td>
+ <td>
+ <FONT FACE=verdana SIZE=-1>
+ Initial version. Refactored version of the code released as open source by Cortex Software GmbH in 2006.
+ Removed some dangling dependencies. Added initial doxygen generated documentation and some examples.
+ </td>
+</tr>
+</table>
+
+
+
+</body>
+</html>


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