From 717727ce3d99142b7197730a45e4640191d99c84 Mon Sep 17 00:00:00 2001 From: shaan Date: Thu, 2 Jul 2009 18:15:09 +0200 Subject: Module for Rasodmg --- rasodmg/alignedtiling.hh | 6 ++++++ rasodmg/collection.hh | 3 +++ rasodmg/database.hh | 3 +++ rasodmg/dirdecompose.hh | 3 +++ rasodmg/dirtiling.hh | 3 +++ rasodmg/gmarray.hh | 5 ++++- rasodmg/interesttiling.hh | 3 +++ rasodmg/iterator.hh | 3 +++ rasodmg/marray.hh | 5 ++++- rasodmg/object.hh | 3 +++ rasodmg/oqlquery.hh | 3 +++ rasodmg/partinsert.hh | 3 +++ rasodmg/polycutout.hh | 9 +++++++++ rasodmg/polygon.hh | 12 ++++++++++++ rasodmg/ref.hh | 6 ++++++ rasodmg/set.hh | 3 +++ rasodmg/stattiling.hh | 6 ++++++ rasodmg/storagelayout.hh | 3 +++ rasodmg/tiling.hh | 12 ++++++++++++ rasodmg/transaction.hh | 3 +++ 20 files changed, 95 insertions(+), 2 deletions(-) (limited to 'rasodmg') diff --git a/rasodmg/alignedtiling.hh b/rasodmg/alignedtiling.hh index ba8c2a4..5cde101 100644 --- a/rasodmg/alignedtiling.hh +++ b/rasodmg/alignedtiling.hh @@ -105,7 +105,13 @@ class r_Aligned_Tiling; with the option notiling. In that case, no tiling is done, independently of the storage layout chosen. */ +/** + * \defgroup Rasodmgs Rasodmg Classes + */ +/** + * \ingroup Rasodmgs + */ class r_Aligned_Tiling : public r_Dimension_Tiling { public: diff --git a/rasodmg/collection.hh b/rasodmg/collection.hh index d90eb39..1d2d2d3 100644 --- a/rasodmg/collection.hh +++ b/rasodmg/collection.hh @@ -50,6 +50,9 @@ class r_Iterator; */ +/** + * \ingroup Rasodmgs + */ template class r_Collection : public r_Object { diff --git a/rasodmg/database.hh b/rasodmg/database.hh index 7491eb0..de62b72 100644 --- a/rasodmg/database.hh +++ b/rasodmg/database.hh @@ -54,6 +54,9 @@ class r_Ref_Any; */ +/** + * \ingroup Rasodmgs + */ class r_Database { public: diff --git a/rasodmg/dirdecompose.hh b/rasodmg/dirdecompose.hh index 96d4bb0..10d2ecf 100644 --- a/rasodmg/dirdecompose.hh +++ b/rasodmg/dirdecompose.hh @@ -65,6 +65,9 @@ using std::vector; entered. */ +/** + * \ingroup Rasodmgs + */ class r_Dir_Decompose { public: diff --git a/rasodmg/dirtiling.hh b/rasodmg/dirtiling.hh index 9495571..53e77d4 100644 --- a/rasodmg/dirtiling.hh +++ b/rasodmg/dirtiling.hh @@ -50,6 +50,9 @@ class r_Dir_Tiling; the system on how the decomposition is done in each dimension. */ +/** + * \ingroup Rasodmgs + */ class r_Dir_Tiling : public r_Dimension_Tiling { // ******************* PUBLIC SECTION ******************* diff --git a/rasodmg/gmarray.hh b/rasodmg/gmarray.hh index 2274e74..4cc6413 100644 --- a/rasodmg/gmarray.hh +++ b/rasodmg/gmarray.hh @@ -59,7 +59,10 @@ class r_Storage_Layout; Class \Ref{r_Marray} provides a constructor to convert to the base type specific class. */ - + +/** + * \ingroup Rasodmgs + */ class r_GMarray : public r_Object { public: diff --git a/rasodmg/interesttiling.hh b/rasodmg/interesttiling.hh index 944ada8..37d6eca 100644 --- a/rasodmg/interesttiling.hh +++ b/rasodmg/interesttiling.hh @@ -70,6 +70,9 @@ class r_Interest_Tiling; ... */ +/** + * \ingroup Rasodmgs + */ class r_Interest_Tiling : public r_Dimension_Tiling { public: diff --git a/rasodmg/iterator.hh b/rasodmg/iterator.hh index 995e7b6..d5f459e 100644 --- a/rasodmg/iterator.hh +++ b/rasodmg/iterator.hh @@ -58,6 +58,9 @@ template class r_Collection; is one. */ +/** + * \ingroup Rasodmgs + */ template class r_Iterator { diff --git a/rasodmg/marray.hh b/rasodmg/marray.hh index 8b5e5ea..18d4385 100644 --- a/rasodmg/marray.hh +++ b/rasodmg/marray.hh @@ -50,7 +50,10 @@ using namespace std; a normal C or C++ array from the programmers point of view. */ - + +/** + * \ingroup Rasodmgs + */ template class r_Marray : public r_GMarray { diff --git a/rasodmg/object.hh b/rasodmg/object.hh index d5fcbeb..3a440c9 100644 --- a/rasodmg/object.hh +++ b/rasodmg/object.hh @@ -58,6 +58,9 @@ class r_Type; */ +/** + * \ingroup Rasodmgs + */ class r_Object { public: diff --git a/rasodmg/oqlquery.hh b/rasodmg/oqlquery.hh index 8da0935..1b88232 100644 --- a/rasodmg/oqlquery.hh +++ b/rasodmg/oqlquery.hh @@ -75,6 +75,9 @@ class r_Ref_Any; */ +/** + * \ingroup Rasodmgs + */ class r_OQL_Query { public: diff --git a/rasodmg/partinsert.hh b/rasodmg/partinsert.hh index 013124c..04451e6 100644 --- a/rasodmg/partinsert.hh +++ b/rasodmg/partinsert.hh @@ -52,6 +52,9 @@ class r_Database; our insert tools. */ +/** + * \ingroup Rasodmgs + */ class r_Partial_Insert { public: diff --git a/rasodmg/polycutout.hh b/rasodmg/polycutout.hh index fc2e258..435503b 100644 --- a/rasodmg/polycutout.hh +++ b/rasodmg/polycutout.hh @@ -66,6 +66,9 @@ using std::ostream; //@ManMemo: Module: {\bf rasodmg} +/** + * \ingroup Rasodmgs + */ class r_SegmentIterator { public: @@ -87,6 +90,9 @@ class r_SegmentIterator int beta; }; +/** + * \ingroup Rasodmgs + */ class r_Line { public: @@ -103,6 +109,9 @@ class r_Line }; +/** + * \ingroup Rasodmgs + */ class r_PolygonCutOut { public: diff --git a/rasodmg/polygon.hh b/rasodmg/polygon.hh index ebed9ea..76aa32d 100644 --- a/rasodmg/polygon.hh +++ b/rasodmg/polygon.hh @@ -53,6 +53,9 @@ class r_GMarray; */ +/** + * \ingroup Rasodmgs + */ class r_Edge { public: @@ -106,6 +109,9 @@ private: */ +/** + * \ingroup Rasodmgs + */ class r_Polygon { public: @@ -262,6 +268,9 @@ extern std::ostream& operator<<( std::ostream& s, const r_Polygon& d ); // sorted collection of r_Edge. In the current implementation only the first // one is needed. +/** + * \ingroup Rasodmgs + */ class EdgeSortCriterion { public: @@ -273,6 +282,9 @@ public: } }; +/** + * \ingroup Rasodmgs + */ class ActiveEdgeSortCriterion { public: diff --git a/rasodmg/ref.hh b/rasodmg/ref.hh index 2b5678e..9531729 100644 --- a/rasodmg/ref.hh +++ b/rasodmg/ref.hh @@ -59,6 +59,9 @@ class r_Structure; \Ref{r_Ref_Any}. */ +/** + * \ingroup Rasodmgs + */ class r_Ref_Any { public: @@ -187,6 +190,9 @@ class r_Ref_Any memory pointer is given back. */ +/** + * \ingroup Rasodmgs + */ template class r_Ref { diff --git a/rasodmg/set.hh b/rasodmg/set.hh index b9f4915..c44edcd 100644 --- a/rasodmg/set.hh +++ b/rasodmg/set.hh @@ -45,6 +45,9 @@ rasdaman GmbH. */ +/** + * \ingroup Rasodmgs + */ template class r_Set : public r_Collection { diff --git a/rasodmg/stattiling.hh b/rasodmg/stattiling.hh index 415b919..3577c83 100644 --- a/rasodmg/stattiling.hh +++ b/rasodmg/stattiling.hh @@ -47,6 +47,9 @@ class r_Stat_Tiling; an appropriate tiling can be defined. */ +/** + * \ingroup Rasodmgs + */ class r_Access { public: @@ -121,6 +124,9 @@ extern std::ostream& operator<<(std::ostream& os, const r_Access& access); can be updated and the tiling operation prepared. */ +/** + * \ingroup Rasodmgs + */ class r_Stat_Tiling : public r_Dimension_Tiling { // ******************* PUBLIC SECTION ******************* diff --git a/rasodmg/storagelayout.hh b/rasodmg/storagelayout.hh index decb1a0..8cde8ad 100644 --- a/rasodmg/storagelayout.hh +++ b/rasodmg/storagelayout.hh @@ -64,6 +64,9 @@ class r_Minterval; For the time being, compression does not work. */ +/** + * \ingroup Rasodmgs + */ class r_Storage_Layout { public: diff --git a/rasodmg/tiling.hh b/rasodmg/tiling.hh index d78ecbe..df78d3e 100644 --- a/rasodmg/tiling.hh +++ b/rasodmg/tiling.hh @@ -61,6 +61,9 @@ using std::cout; implements a diferent decomposition method. */ +/** + * \ingroup Rasodmgs + */ class r_Tiling { public: @@ -105,6 +108,9 @@ class r_Tiling static const long DefaultBase; }; +/** + * \ingroup Rasodmgs + */ class r_Size_Tiling : public r_Tiling { public: @@ -141,6 +147,9 @@ class r_Size_Tiling : public r_Tiling }; +/** + * \ingroup Rasodmgs + */ class r_Dimension_Tiling : public r_Size_Tiling { public: @@ -169,6 +178,9 @@ class r_Dimension_Tiling : public r_Size_Tiling }; +/** + * \ingroup Rasodmgs + */ class r_No_Tiling : public r_Tiling { public: diff --git a/rasodmg/transaction.hh b/rasodmg/transaction.hh index 443855a..06d2ff4 100644 --- a/rasodmg/transaction.hh +++ b/rasodmg/transaction.hh @@ -52,6 +52,9 @@ class r_Object; */ +/** + * \ingroup Rasodmgs + */ class r_Transaction { public: -- cgit