X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6de03ecc4e630732984a0673512a5d15fd75e270..3297da9f47ce18371941b2b48a2f4018b4793ced:/include/xbt/parmap.h diff --git a/include/xbt/parmap.h b/include/xbt/parmap.h index 51e5cc6ea7..69cac53e61 100644 --- a/include/xbt/parmap.h +++ b/include/xbt/parmap.h @@ -1,41 +1,28 @@ /* A thread pool. */ -/* Copyright (c) 2007, 2009-2014. The SimGrid Team. +/* Copyright (c) 2007-2018. The SimGrid Team. * 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. */ -#ifndef _XBT_PARMAP_H -#define _XBT_PARMAP_H - -#include "xbt/misc.h" /* SG_BEGIN_DECL */ -#include "xbt/function_types.h" -#include "xbt/dynar.h" - -SG_BEGIN_DECL() - -/** \addtogroup XBT_parmap - * \ingroup XBT_misc - * \brief Parallel map. - * - * A function is applied to all elements of a dynar in parallel with n worker - * threads. - * The worker threads are persistent until the destruction of the parmap. - * - * If there are more than n elements in the dynar, the worker threads are - * allowed to fetch themselves remaining work with xbt_parmap_next() and - * execute it. - * - * \{ - */ - -/** \brief Parallel map data type (opaque type) */ -typedef struct s_xbt_parmap *xbt_parmap_t; - -/** - * \brief Synchronization mode of the worker threads of a parmap. +#ifndef XBT_PARMAP_H +#define XBT_PARMAP_H + +/** @addtogroup XBT_parmap + * @ingroup XBT_misc + * @brief Parallel map. + * + * A function is applied to all elements of a std::vector in parallel with n worker threads. The worker threads are + * persistent until the destruction of the parmap. + * + * If there are more than n elements in the vector, the worker threads are allowed to fetch themselves remaining work + * with method next() and execute it. + * + * @{ */ + +/** @brief Synchronization mode of the worker threads of a parmap. */ typedef enum { XBT_PARMAP_POSIX, /**< use POSIX synchronization primitives */ XBT_PARMAP_FUTEX, /**< use Linux futex system call */ @@ -43,27 +30,6 @@ typedef enum { XBT_PARMAP_DEFAULT /**< futex if available, posix otherwise */ } e_xbt_parmap_mode_t; -XBT_PUBLIC(xbt_parmap_t) xbt_parmap_new(unsigned int num_workers, - e_xbt_parmap_mode_t mode); -XBT_PUBLIC(void) xbt_parmap_destroy(xbt_parmap_t parmap); - -XBT_PUBLIC(void) xbt_parmap_apply(xbt_parmap_t parmap, - void_f_pvoid_t fun, - xbt_dynar_t data); -XBT_PUBLIC(void*) xbt_parmap_next(xbt_parmap_t parmap); - -#ifdef HAVE_MC -XBT_PUBLIC(xbt_parmap_t) xbt_parmap_mc_new(unsigned int num_workers, - e_xbt_parmap_mode_t mode); - -XBT_PUBLIC(int) xbt_parmap_mc_apply(xbt_parmap_t parmap, - int_f_pvoid_pvoid_t fun, - void *data, - unsigned int length, - void* ref_snapshot); -#endif -/** \} */ - -SG_END_DECL() +/** @} */ #endif