1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
20 Data are associated to both an ID (0(1) search) and a name
29 /** @defgroup XBT_grounding Grounding features */
30 /** @defgroup XBT_adt Usual data structures */
31 /** @defgroup XBT_misc Miscellaneous */
35 ########################################################################
38 /** @addtogroup XBT_grounding
40 Grounding features are the basement of SimGrid. You'll find portable (and
41 secure) wrappers to the malloc-like functions, logging support, error
42 reporting features, etc.
46 /** @defgroup XBT_syscall Malloc and friends */
47 /** @defgroup XBT_str String related functions */
48 /** @defgroup XBT_ex Exception support (C++) */
49 /** @defgroup XBT_ex_c Exception support (C) */
50 /** @defgroup XBT_log Logging support */
51 /** @defgroup XBT_error Assert macro familly */
52 /** @defgroup XBT_config Configuration support */
53 /** @defgroup XBT_mallocator Mallocators */
54 /** @defgroup XBT_cunit Unit testing support */
60 ########################################################################
62 /** @addtogroup XBT_adt
64 Here are the basic data containers that every C programmer rewrites one day.
65 You won't need to do so yourself, you lucky one, because we did it for you.
66 However, if you are programming in C++ you might want to use C++ containers
70 /** @defgroup XBT_dynar Dynar: generic dynamic array */
71 /** @defgroup XBT_dict Dict: generic dictionnary */
72 /** @defgroup XBT_fifo Fifo: generic workqueue */
73 /** @defgroup XBT_swag Swag: O(1) set datatype */
74 /** @defgroup XBT_heap Heap: generic heap data structure */
78 ########################################################################
80 /** @addtogroup XBT_misc
82 Here are several general purposes library components designed specially
83 for you, you lucky one.
87 /** @defgroup XBT_graph General purpose graph library */
88 /** @defgroup XBT_parmap Parallel map */
89 /** @defgroup XBT_synchro Simulated Synchronization */
90 /** @defgroup XBT_thread Thread stuff */
91 /** @defgroup XBT_context Portable context implementation */
92 /** @defgroup XBT_replay Replay */
95 /* ************************* *
96 * * PORTABILITY-INTERNALS * * (not included in documentation)
97 * ************************* */
99 /** \addtogroup XBT_context Portable context implementation
100 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
101 * for non-preemptible threads.
103 * You shouldn't use it directly since it is merely intended to ease the
104 * implementation of the several programmation environment of the
105 * SimGrid toolkit (namely, \ref MSG_API and \ref SMPI_API).
107 * You should use those environments instead.