/* $Id$ */
-/* a generic DYNamic ARray */
+/* a generic DYNamic ARray implementation. */
-/* Authors: Martin Quinson */
-/* Copyright (C) 2003 the OURAGAN project. */
+/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
- under the terms of the license (GNU LGPL) which comes with this package. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
#include "xbt/misc.h"
#include "xbt/sysdep.h"
#include "xbt/dynar.h"
#include <sys/types.h>
+/** \defgroup XBT_dynar A generic dynamic array
+ * \brief This section describes the API to generic dynamic array (vector).
+ */
+
+
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(dynar,xbt,"Dynamic arrays");
typedef struct xbt_dynar_s {
}
/**
- * xbt_dynar_new:
- * @elm_size: size of each element in the dynar
- * @free_func: function to call each time we want to get rid of an element (or NULL if nothing to do).
+ * \ingroup XBT_dynar
+ * \param elmsize size of each element in the dynar
+ * \param free_f function to call each time we want to get rid of an element (or NULL if nothing to do).
*
* Creates a new dynar. If a free_func is provided, the elements have to be
* pointer of pointer. That is to say that dynars can contain either base
}
/**
- * xbt_dynar_free_container:
- * @dynar: poor victim
+ * \ingroup XBT_dynar
+ * \param dynar poor victim
*
* kilkil a dynar BUT NOT its content. Ie, the array is freed, but not what
* its contain points to.
}
/**
- * xbt_dynar_reset:
- * @dynar: who to squeeze
+ * \ingroup XBT_dynar
+ * \param dynar who to squeeze
*
* Frees the content and set the size to 0
*/
}
/**
- * xbt_dynar_free:
- * @dynar: poor victim
+ * \ingroup XBT_dynar
+ * \param dynar poor victim
*
* kilkil a dynar and its content
*/
}
/**
- * xbt_dynar_length:
- * @dynar: the dynar we want to mesure
+ * \ingroup XBT_dynar
+ * \param dynar the dynar we want to mesure
*
* Returns the count of elements in a dynar
*/
}
/**
- * xbt_dynar_get_cpy:
- * @dynar: information dealer
- * @idx: index of the slot we want to retrive
- * @dst: where to pu the result to.
+ * \ingroup XBT_dynar
+ * \param dynar information dealer
+ * \param idx index of the slot we want to retrive
+ * \param[out] dst where to put the result to.
*
* Retrieve a copy of the Nth element of a dynar.
*/
}
/**
- * xbt_dynar_get_ptr:
- * @dynar: information dealer
- * @idx: index of the slot we want to retrive
- * @dst: where to pu the result to.
+ * \ingroup XBT_dynar
+ * \param dynar information dealer
+ * \param idx index of the slot we want to retrieve
+ * \return the #idx-th element of #dynar.
*
* Retrieve the Nth element of a dynar. Warning, the returned value is the actual content of
* the dynar. Make a copy before fooling with it.
}
/**
- * xbt_dynar_set:
- * @dynar:
- * @idx:
- * @src: What will be feeded to the dynar
+ * \ingroup XBT_dynar
+ * \param dynar information dealer
+ * \param idx index of the slot we want to modify
+ * \param src What will be feeded to the dynar
*
* Set the Nth element of a dynar, expanding the dynar if needed, BUT NOT freeing
* the previous value at this position. If you want to free the previous content,
}
/**
- * xbt_dynar_replace:
- * @dynar:
- * @idx:
- * @object:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param idx
+ * \param object
*
* Set the Nth element of a dynar, expanding the dynar if needed, AND DO
* free the previous value at this position. If you don't want to free the
}
/**
- * xbt_dynar_insert_at_ptr:
+ * \ingroup XBT_dynar
*
* Make room for a new element in the dynar, and return a pointer to
* its position. You can then use regular affectation to set its value
}
/**
- * xbt_dynar_insert_at:
- * @dynar:
- * @idx:
- * @src: What will be feeded to the dynar
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param idx
+ * \param src What will be feeded to the dynar
*
* Set the Nth element of a dynar, expanding the dynar if needed, and
* moving the previously existing value and all subsequent ones to one
}
/**
- * xbt_dynar_remove_at:
- * @dynar:
- * @idx:
- * @object:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param idx
+ * \param object
*
* Get the Nth element of a dynar, removing it from the dynar and moving
* all subsequent values to one position left in the dynar.
}
/**
- * xbt_dynar_push_ptr:
+ * \ingroup XBT_dynar
*
* Make room at the end of the dynar for a new element, and return a pointer to it
*/
}
/**
- * xbt_dynar_push:
- * @dynar:
- * @src:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param src
*
* Add an element at the end of the dynar
*/
}
/**
- * xbt_dynar_pop_ptr:
- * @dynar:
- * @dst:
+ * \param dynar
+ * \param dst
*
* Make the last element of the dynar as unused and return a pointer to it.
*/
}
/**
- * xbt_dynar_pop:
- * @dynar:
- * @dst:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param[out] dst
*
* Get and remove the last element of the dynar
*/
}
/**
- * xbt_dynar_unshift:
- * @dynar:
- * @src:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param src
*
* Add an element at the begining of the dynar (rather long, Use
* xbt_dynar_push() when possible)
}
/**
- * xbt_dynar_shift:
- * @dynar:
- * @dst:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param[out] dst
*
* Get and remove the first element of the dynar (rather long, Use
* xbt_dynar_pop() when possible)
}
/**
- * xbt_dynar_map:
- * @dynar:
- * @operator:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param operator
*
* Apply a function to each member of a dynar (this function may change the
* value of the element itself, but should not mess with the dynar).
}
/**
- * xbt_dynar_cursor_first:
+ * \ingroup XBT_dynar
*
* Put the cursor at the begining of the dynar. (actually, one step before
* the begining, so that you can iterate over the dynar with a for loop).
}
/**
- * xbt_dynar_cursor_step:
+ * \ingroup XBT_dynar
*
* Move the cursor to the next value (and return true), or return false.
*/
}
/**
- * xbt_dynar_cursor_get:
+ * \ingroup XBT_dynar
*
* Get the current value of the cursor
*/
}
/**
- * xbt_dynar_cursor_rm:
- * @dynar:
- * @cursor:
+ * \ingroup XBT_dynar
+ * \param dynar
+ * \param cursor
*
* Remove (free) the entry pointed by the cursor, for use in the middle of a foreach
*/
