/* a generic DYNamic ARray implementation. */
-/* Copyright (c) 2004-2020. The SimGrid Team.
+/* Copyright (c) 2004-2022. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
static inline void* _xbt_dynar_elm(const_xbt_dynar_t dynar, unsigned long idx)
{
- char *const data = (char *) dynar->data;
+ auto* const data = static_cast<char*>(dynar->data);
const unsigned long elmsize = dynar->elmsize;
return data + idx * elmsize;
memcpy(dst, elm, dynar->elmsize);
}
-/** @brief Constructor
+/**
+ * Creates a new dynar. If a @c free_f is provided, the elements have to be pointer of pointer. That is to say that
+ * dynars can contain either base types (int, char, double, etc) or pointer of pointers (struct **).
*
* @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 nullptr 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 types (int, char, double, etc) or pointer of pointers (struct **).
*/
xbt_dynar_t xbt_dynar_new(const unsigned long elmsize, void_f_pvoid_t free_f)
{
- xbt_dynar_t dynar = xbt_new0(s_xbt_dynar_t, 1);
+ auto* dynar = xbt_new0(s_xbt_dynar_t, 1);
dynar->size = 0;
dynar->used = 0;
return dynar;
}
-/** @brief Destructor of the structure not touching to the content
+/** Destructor of the structure leaving the content unmodified. Ie, the array is freed, but the content is not touched
+ * (the @a free_f function is not used).
*
* @param dynar poor victim
- *
- * kilkil a dynar BUT NOT its content. Ie, the array is freed, but the content is not touched (the @a free_f function
- * is not used)
*/
void xbt_dynar_free_container(xbt_dynar_t* dynar)
{
}
}
-/** @brief Frees the content and set the size to 0
- *
- * @param dynar who to squeeze
- */
+/** @brief Frees the content and set the size to 0 */
void xbt_dynar_reset(xbt_dynar_t dynar)
{
_sanity_check_dynar(dynar);
dynar->used = 0;
}
-/**
- * @brief Shrink the dynar by removing empty slots at the end of the internal array
- * @param dynar a dynar
- * @param empty_slots_wanted number of empty slots you want to keep at the end of the internal array for further
- * insertions
- *
- * Reduces the internal array size of the dynar to the number of elements plus @a empty_slots_wanted.
- * After removing elements from the dynar, you can call this function to make the dynar use less memory.
- * Set @a empty_slots_wanted to zero to reduce the dynar internal array as much as possible.
- * Note that if @a empty_slots_wanted is greater than the array size, the internal array is expanded instead of shrunk.
- */
-void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots_wanted)
-{
- _xbt_dynar_resize(dynar, dynar->used + empty_slots_wanted);
-}
-
-/** @brief Destructor
- *
- * @param dynar poor victim
- *
- * kilkil a dynar and its content
- */
+/** @brief Destructor: kilkil a dynar and its content. */
void xbt_dynar_free(xbt_dynar_t* dynar)
{
if (dynar && *dynar) {
}
}
-/** @brief Count of dynar's elements
- *
- * @param dynar the dynar we want to measure
- */
+/** @brief Count of dynar's elements */
unsigned long xbt_dynar_length(const_xbt_dynar_t dynar)
{
- return (dynar ? (unsigned long) dynar->used : (unsigned long) 0);
+ return (dynar ? dynar->used : 0UL);
}
-/**@brief check if a dynar is empty
- *
- *@param dynar the dynat we want to check
- */
+/**@brief check if a dynar is empty */
int xbt_dynar_is_empty(const_xbt_dynar_t dynar)
{
return (xbt_dynar_length(dynar) == 0);
/** @brief Retrieve a pointer to the Nth element of a dynar.
*
- * @param dynar information dealer
- * @param idx index of the slot we want to retrieve
- * @return the @a idx-th element of @a dynar.
- *
- * @warning The returned value is the actual content of the dynar.
+ * Note that the returned value is the actual content of the dynar.
* Make a copy before fooling with it.
*/
void* xbt_dynar_get_ptr(const_xbt_dynar_t dynar, unsigned long idx)
void *res;
unsigned long old_used;
unsigned long new_used;
- long nb_shift;
_sanity_check_dynar(dynar);
_sanity_check_idx(idx);
_xbt_dynar_expand(dynar, new_used);
- nb_shift = old_used - idx;
-
- if (nb_shift>0) {
+ if (long nb_shift = old_used - idx; nb_shift > 0) {
memmove(_xbt_dynar_elm(dynar, idx + 1), _xbt_dynar_elm(dynar, idx), nb_shift * dynar->elmsize);
}
memcpy(xbt_dynar_insert_at_ptr(dynar, idx), src, dynar->elmsize);
}
-/** @brief Remove the Nth dynar's element, sliding the previous values to the left
+/** @brief Remove the Nth element, sliding other values to the left
*
* Get the Nth element of a dynar, removing it from the dynar and moving all subsequent values to one position left in
* the dynar.
dynar->used--;
}
-/** @brief Returns the position of the element in the dynar (or -1 if not found)
- *
- * Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
- * what you want. Check the documentation of xbt_dynar_search() for more info.
- *
- * Note that usually, the dynar indices are unsigned integers. If you have more than 2 million elements in your dynar,
- * this very function will not work (but the other will).
- */
-signed int xbt_dynar_search_or_negative(const_xbt_dynar_t dynar, const void* elem)
-{
- unsigned long it;
-
- for (it = 0; it < dynar->used; it++)
- if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
- return it;
- }
-
- return -1;
-}
-
/** @brief Returns a boolean indicating whether the element is part of the dynar
*
* Beware that if your dynar contains pointed values (such as strings) instead of scalar, this function is probably not
- * what you want. Check the documentation of xbt_dynar_search() for more info.
+ * what you want. It would compare the pointer values, not the pointed elements.
*/
int xbt_dynar_member(const_xbt_dynar_t dynar, const void* elem)
{
- unsigned long it;
-
- for (it = 0; it < dynar->used; it++)
+ for (unsigned long it = 0; it < dynar->used; it++)
if (not memcmp(_xbt_dynar_elm(dynar, it), elem, dynar->elmsize)) {
return 1;
}
*/
void xbt_dynar_map(const_xbt_dynar_t dynar, void_f_pvoid_t op)
{
- char *const data = (char *) dynar->data;
+ auto* const data = static_cast<char*>(dynar->data);
const unsigned long elmsize = dynar->elmsize;
const unsigned long used = dynar->used;
- unsigned long i;
_sanity_check_dynar(dynar);
- for (i = 0; i < used; i++) {
- char* elm = (char*) data + i * elmsize;
+ for (unsigned long i = 0; i < used; i++) {
+ char* elm = data + i * elmsize;
op(elm);
}
}
-/** @brief Removes and free the entry pointed by the cursor
- *
- * This function can be used while traversing without problem.
- */
-void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* cursor)
-{
- xbt_dynar_remove_at(dynar, *cursor, nullptr);
- *cursor -= 1;
-}
-
/** @brief Sorts a dynar according to the function <tt>compar_fn</tt>
*
* This function simply apply the classical qsort(3) function to the data stored in the dynar.
* a comparison function. Here is a quick example if you have integers in your dynar:
*
* @verbatim
- * int cmpfunc (const void * a, const void * b) {
- * int intA = *(int*)a;
- * int intB = *(int*)b;
- * return intA - intB;
- * }
- * @endverbatim
- *
- * and now to sort a dynar of MSG hosts depending on their speed:
+ int cmpfunc (const void * a, const void * b) {
+ int intA = *(int*)a;
+ int intB = *(int*)b;
+ return intA - intB;
+ }
+ @endverbatim
+ *
+ * And now, a function to sort a dynar of MSG hosts depending on their speed:
* @verbatim
- * int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
- * MSG_host_t hostA = *(MSG_host_t*)a;
- * MSG_host_t hostB = *(MSG_host_t*)b;
- * return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
- * }
- * @endverbatim
+ int cmpfunc(const MSG_host_t a, const MSG_host_t b) {
+ MSG_host_t hostA = *(MSG_host_t*)a;
+ MSG_host_t hostB = *(MSG_host_t*)b;
+ return MSG_host_get_speed(hostA) - MSG_host_get_speed(hostB);
+ }
+ @endverbatim
*
* @param dynar the dynar to sort
* @param compar_fn comparison function of type (int (compar_fn*) (const void*) (const void*)).
if (dynar->data != nullptr)
qsort(dynar->data, dynar->used, dynar->elmsize, compar_fn);
}
-
-/** @brief Transform a dynar into a nullptr terminated array.
- *
- * @param dynar the dynar to transform
- * @return pointer to the first element of the array
- *
- * Note: The dynar won't be usable afterwards.
- */
-void* xbt_dynar_to_array(xbt_dynar_t dynar)
-{
- void *res;
- xbt_dynar_shrink(dynar, 1);
- memset(xbt_dynar_push_ptr(dynar), 0, dynar->elmsize);
- res = dynar->data;
- xbt_free(dynar);
- return res;
-}
