1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
26 /** @defgroup XBT_grounding Grounding features */
27 /** @defgroup XBT_adt Usual data structures */
28 /** @defgroup XBT_misc Miscellaneous */
32 ########################################################################
35 /** @addtogroup XBT_grounding
37 Grounding features are the basement of SimGrid. You'll find portable (and
38 secure) wrappers to the malloc-like functions, logging support, error
39 reporting features, etc.
43 /** @defgroup XBT_syscall Malloc and friends */
44 /** @defgroup XBT_str String related functions */
45 /** @defgroup XBT_ex Exception support (C++) */
46 /** @defgroup XBT_ex_c Exception support (C) */
47 /** @defgroup XBT_log Logging support */
48 /** @defgroup XBT_error Assert macro familly */
49 /** @defgroup XBT_config Configuration support */
50 /** @defgroup XBT_mallocator Mallocators */
51 /** @defgroup XBT_cunit Unit testing support */
57 ########################################################################
59 /** @addtogroup XBT_adt
61 Here are the basic data containers that every C programmer rewrites one day.
62 You won't need to do so yourself, you lucky one, because we did it for you.
63 However, if you are programming in C++ you might want to use C++ containers
67 /** @defgroup XBT_dynar Dynar: generic dynamic array */
68 /** @defgroup XBT_dict Dict: generic dictionnary */
69 /** @defgroup XBT_swag Swag: O(1) set datatype */
70 /** @defgroup XBT_heap Heap: generic heap data structure */
74 ########################################################################
76 /** @addtogroup XBT_misc
78 Here are several general purposes library components designed specially
79 for you, you lucky one.
83 /** @defgroup XBT_graph General purpose graph library */
84 /** @defgroup XBT_parmap Parallel map */
85 /** @defgroup XBT_synchro Simulated Synchronization */
86 /** @defgroup XBT_thread Thread stuff */
87 /** @defgroup XBT_context Portable context implementation */
88 /** @defgroup XBT_replay Replay */
91 /* ************************* *
92 * * PORTABILITY-INTERNALS * * (not included in documentation)
93 * ************************* */
95 /** \addtogroup XBT_context Portable context implementation
96 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
97 * for non-preemptible threads.
99 * You shouldn't use it directly since it is merely intended to ease the
100 * implementation of the several programmation environment of the
101 * SimGrid toolkit (namely, \ref MSG_API and \ref SMPI_API).
103 * You should use those environments instead.