Browse Source

doc: add missing parts

Nathalie Furmento 11 years ago
parent
commit
b9cde71138
2 changed files with 113 additions and 0 deletions
  1. 67 0
      doc/doxygen/chapters/api/bitmap.doxy
  2. 46 0
      doc/doxygen/chapters/api/tree.doxy

+ 67 - 0
doc/doxygen/chapters/api/bitmap.doxy

@@ -0,0 +1,67 @@
+/*
+ * This file is part of the StarPU Handbook.
+ * Copyright (C) 2014  Centre National de la Recherche Scientifique
+ * See the file version.doxy for copying conditions.
+ */
+
+/*! \defgroup API_Bitmap  Bitmap
+
+\brief This section describes the bitmap facilities provided by StarPU.
+
+\fn struct starpu_bitmap *starpu_bitmap_create(void)
+\ingroup API_Bitmap
+todo
+
+\fn void starpu_bitmap_destroy(struct starpu_bitmap *b)
+\ingroup API_Bitmap
+todo
+
+\fn void starpu_bitmap_set(struct starpu_bitmap *b, int e)
+\ingroup API_Bitmap
+todo
+
+\fn void starpu_bitmap_unset(struct starpu_bitmap *b, int e)
+\ingroup API_Bitmap
+todo
+
+\fn void starpu_bitmap_unset_all(struct starpu_bitmap *b)
+\ingroup API_Bitmap
+todo
+
+\fn int starpu_bitmap_get(struct starpu_bitmap *b, int e)
+\ingroup API_Bitmap
+todo
+
+\fn void starpu_bitmap_unset_and(struct starpu_bitmap *a, struct starpu_bitmap *b, struct starpu_bitmap *c)
+\ingroup API_Bitmap
+Basically compute starpu_bitmap_unset_all(a) ; a = b & c;
+
+\fn void starpu_bitmap_or(struct starpu_bitmap *a, struct starpu_bitmap *b)
+\ingroup API_Bitmap
+Basically compute a |= b
+
+\fn int starpu_bitmap_and_get(struct starpu_bitmap *b1, struct starpu_bitmap *b2, int e)
+\ingroup API_Bitmap
+return 1 iff e set in b1 AND e set in b2
+
+\fn int starpu_bitmap_cardinal(struct starpu_bitmap *b)
+\ingroup API_Bitmap
+todo
+
+\fn int starpu_bitmap_first(struct starpu_bitmap *b)
+\ingroup API_Bitmap
+return the index of first bit, -1 if none
+
+\fn int starpu_bitmap_last(struct starpu_bitmap *b)
+\ingroup API_Bitmap
+todo
+
+\fn int starpu_bitmap_next(struct starpu_bitmap *b, int e)
+\ingroup API_Bitmap
+return the index of bit right after e, -1 if none
+
+\fn int starpu_bitmap_has_next(struct starpu_bitmap *b, int e)
+\ingroup API_Bitmap
+todo
+
+*/

+ 46 - 0
doc/doxygen/chapters/api/tree.doxy

@@ -0,0 +1,46 @@
+/*
+ * This file is part of the StarPU Handbook.
+ * Copyright (C) 2014  Centre National de la Recherche Scientifique
+ * See the file version.doxy for copying conditions.
+ */
+
+/*! \defgroup API_Tree Tree
+
+\brief This section describes the tree facilities provided by StarPU.
+
+\struct starpu_tree
+\ingroup API_Tree
+\var starpu_tree::nodes
+todo
+\var starpu_tree::father
+todo
+\var starpu_tree::arity
+todo
+\var starpu_tree::id
+todo
+\var starpu_tree::level
+todo
+\var starpu_tree::is_pu
+todo
+
+\fn void starpu_tree_reset_visited(struct starpu_tree *tree, int *visited)
+\ingroup API_Tree
+todo
+
+\fn void starpu_tree_insert(struct starpu_tree *tree, int id, int level, int is_pu, int arity, struct starpu_tree *father)
+\ingroup API_Tree
+todo
+
+\fn struct starpu_tree *starpu_tree_get(struct starpu_tree *tree, int id)
+\ingroup API_Tree
+todo
+
+\fn struct starpu_tree *starpu_tree_get_neighbour(struct starpu_tree *tree, struct starpu_tree *node, int *visited, int *present)
+\ingroup API_Tree
+todo
+
+\fn int starpu_tree_free(struct starpu_tree *tree)
+\ingroup API_Tree
+todo
+
+*/