[Olena-patches] 2435: * mln/topo/complex.hh: Add some more documentation.

--- milena/ChangeLog | 4 +++ milena/mln/topo/complex.hh | 54 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 0 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index f7bf9f4..f0cf69b 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2008-09-30 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + * mln/topo/complex.hh: Add some more documentation. + +2008-09-30 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + * mln/topo/complex.hh: Add missing `inline' keywords. 2008-09-29 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; diff --git a/milena/mln/topo/complex.hh b/milena/mln/topo/complex.hh index 303c3f8..643285c 100644 --- a/milena/mln/topo/complex.hh +++ b/milena/mln/topo/complex.hh @@ -231,6 +231,59 @@ namespace mln | Complex data. | `---------------*/ + /** \brief Complex data. + + Data is aggregated as follows in an mln::topo::complex<D>: + + \verbatim + + ,-----------> lower_dim_faces_set_mixin<D, D> + | + faces_set_mixin<0, D> + ^ + | + | ,-----------> higher_dim_faces_set_mixin<1, D> + | | ,---------> lower_dim_faces_set_mixin<1, D> + | | | + faces_set_mixin<1, D> + ^ + | + | + + ... + + ^ + | + | ,-----------> higher_dim_faces_set_mixin<D - 1, D> + | | ,---------> lower_dim_faces_set_mixin<D - 1, D> + | | | + faces_set_mixin<D - 1, D> + ^ + | + | ,---------> lower_dim_faces_set_mixin<D, D> + | | + faces_set_mixin<D, D> + ^ + | + | + complex_data<D> ----. (shared data) + | + | + ,--------------' + | + | + `----<> tracked_ptr< complex_data<D> > ----<> complex<D> + + \endverbatim + + + An instance of mln::topo::internal::faces_set_mixin<N, D> + stores the \p N-faces of a \p D-complex. + + Classes mln::topo::internal::lower_dim_faces_set_mixin<N, D> + are implementation classes factoring services related to + complex data. */ + /// \{ namespace internal { // Forward declarations. @@ -245,6 +298,7 @@ namespace mln }; } // end of namespace mln::topo::internal + /// \} /*---------------------. -- 1.6.0.1