Module: ppl/ppl Branch: master Commit: 609f96793392774847c032d06ac3898e62995d4f URL: http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=609f967933927...

Author: Enea Zaffanella zaffanella@cs.unipr.it Date: Sat Feb 25 23:55:53 2012 +0100

Remove docs for a few implementation classes from the user manual.

---

src/CO_Tree.defs.hh | 6 +++--- src/Checked_Number.defs.hh | 6 ++++++ src/Dense_Row.defs.hh | 4 ++++ src/Sparse_Matrix.defs.hh | 4 +++- src/Sparse_Row.defs.hh | 8 ++++++-- src/Sparse_Row.inlines.hh | 3 +++ src/intervals.defs.hh | 2 -- 7 files changed, 25 insertions(+), 8 deletions(-)

diff --git a/src/CO_Tree.defs.hh b/src/CO_Tree.defs.hh index 61c8556..0a84211 100644 --- a/src/CO_Tree.defs.hh +++ b/src/CO_Tree.defs.hh @@ -52,11 +52,11 @@ site: http://bugseng.com/products/ppl/ . */ namespace Parma_Polyhedra_Library {

//! A cache-oblivious binary search tree of pairs. -/*! +/*! \ingroup PPL_CXX_interface This class implements a binary search tree with keys of dimension_type type and data of Coefficient type, laid out in a dynamically-sized array.

- The array-based layout saves calls to new/delete (to insert n elements + The array-based layout saves calls to new/delete (to insert \f$n\f$ elements only \f$O(\log n)\f$ allocations are performed) and, more importantly, is much more cache-friendly than a standard (pointer-based) tree, because the elements are stored sequentially in memory (leaving some holes to allow @@ -94,7 +94,7 @@ namespace Parma_Polyhedra_Library { The indexes and values are stored in different arrays to reduce cache-misses during key queries.

- The tree can store up to (-(dimension_type)1)/100 elements. + The tree can store up to \f$(-(dimension_type)1)/100\f$ elements. This limit allows faster density computations, but can be removed if needed. */ class CO_Tree { diff --git a/src/Checked_Number.defs.hh b/src/Checked_Number.defs.hh index d7bad52..390f7f6 100644 --- a/src/Checked_Number.defs.hh +++ b/src/Checked_Number.defs.hh @@ -139,15 +139,21 @@ struct Native_Checked_To_Wrapper<Checked_Number<T, P> > { } };

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS /*! \ingroup PPL_CXX_interface */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) template <typename T> struct Is_Checked : public False { };

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS /*! \ingroup PPL_CXX_interface */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) template <typename T, typename P> struct Is_Checked<Checked_Number<T, P> > : public True { };

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS /*! \ingroup PPL_CXX_interface */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) template <typename T> struct Is_Native_Or_Checked : public Bool<Is_Native<T>::value || Is_Checked<T>::value> { }; diff --git a/src/Dense_Row.defs.hh b/src/Dense_Row.defs.hh index 0bcbd50..0e95e77 100644 --- a/src/Dense_Row.defs.hh +++ b/src/Dense_Row.defs.hh @@ -504,12 +504,16 @@ void swap(Dense_Row& x, Dense_Row& y); void iter_swap(std::vector<Dense_Row>::iterator x, std::vector<Dense_Row>::iterator y);

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS //! Returns <CODE>true</CODE> if and only if \p x and \p y are equal. /*! \relates Dense_Row */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) bool operator==(const Dense_Row& x, const Dense_Row& y);

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS //! Returns <CODE>true</CODE> if and only if \p x and \p y are different. /*! \relates Dense_Row */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) bool operator!=(const Dense_Row& x, const Dense_Row& y);

} // namespace Parma_Polyhedra_Library diff --git a/src/Sparse_Matrix.defs.hh b/src/Sparse_Matrix.defs.hh index a8dc341..310f95f 100644 --- a/src/Sparse_Matrix.defs.hh +++ b/src/Sparse_Matrix.defs.hh @@ -29,8 +29,9 @@ site: http://bugseng.com/products/ppl/ . */ #include "globals.types.hh" #include <vector>

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS //! A sparse matrix of Coefficient. -/*! +/*! \ingroup PPL_CXX_interface This class is a drop-in replacement of Dense_Matrix, meaning that code using Dense_Matrix can be ported to Sparse_Matrix changing only references to Dense_Matrix and Dense_Row into references to Sparse_Matrix and @@ -52,6 +53,7 @@ site: http://bugseng.com/products/ppl/ . */

\see Sparse_Row */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) class Parma_Polyhedra_Library::Sparse_Matrix {

public: diff --git a/src/Sparse_Row.defs.hh b/src/Sparse_Row.defs.hh index 555bf4b..180a2d1 100644 --- a/src/Sparse_Row.defs.hh +++ b/src/Sparse_Row.defs.hh @@ -34,7 +34,7 @@ site: http://bugseng.com/products/ppl/ . */ namespace Parma_Polyhedra_Library {

//! A finite sparse sequence of coefficients. -/*! +/*! \ingroup PPL_CXX_interface This class is implemented using a CO_Tree. See the documentation of CO_Tree for details on the implementation and the performance.

@@ -75,7 +75,7 @@ public: \see CO_Tree::const_iterator */ typedef CO_Tree::const_iterator const_iterator; - + explicit Sparse_Row(Flags flags);

//! Constructs a row with the specified size. @@ -821,12 +821,16 @@ namespace Parma_Polyhedra_Library { #endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) void swap(Sparse_Row& x, Sparse_Row& y);

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS //! Returns <CODE>true</CODE> if and only if \p x and \p y are equal. /*! \relates Sparse_Row */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) bool operator==(const Sparse_Row& x, const Sparse_Row& y);

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS //! Returns <CODE>true</CODE> if and only if \p x and \p y are different. /*! \relates Sparse_Row */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) bool operator!=(const Sparse_Row& x, const Sparse_Row& y);

} // namespace Parma_Polyhedra_Library diff --git a/src/Sparse_Row.inlines.hh b/src/Sparse_Row.inlines.hh index 703cf0b..0e076f1 100644 --- a/src/Sparse_Row.inlines.hh +++ b/src/Sparse_Row.inlines.hh @@ -371,6 +371,9 @@ Sparse_Row::total_memory_in_bytes(dimension_type /* capacity */) const { return total_memory_in_bytes(); }

+#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS +/*! \relates Sparse_Row */ +#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) inline void swap(Sparse_Row& x, Sparse_Row& y) { x.m_swap(y); diff --git a/src/intervals.defs.hh b/src/intervals.defs.hh index b9193b4..50993d8 100644 --- a/src/intervals.defs.hh +++ b/src/intervals.defs.hh @@ -31,10 +31,8 @@ site: http://bugseng.com/products/ppl/ . */

namespace Parma_Polyhedra_Library {

-#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS //! The result of an operation on intervals. /*! \ingroup PPL_CXX_interface */ -#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS) enum I_Result { //! \hideinitializer Result may be empty. I_EMPTY = 1U,