Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rewrite without goto going backward.
[simgrid.git] / include / xbt / heap.h
index 8ab5753..27c2a81 100644 (file)
@@ -1,11 +1,11 @@
-/* Copyright (c) 2004-2007, 2009-2011, 2013-2015. The SimGrid Team.
+/* Copyright (c) 2004-2007, 2009-2011, 2013-2017. 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_HEAP_H
-#define _XBT_HEAP_H
+#ifndef XBT_HEAP_H
+#define XBT_HEAP_H
 
 #include "xbt/misc.h"
 #include "xbt/dynar.h"          /* void_f_pvoid_t */
@@ -15,6 +15,9 @@ SG_BEGIN_DECL()
 /** @addtogroup XBT_heap
  *  @brief This section describes the API to generic heap with O(log(n)) access.
  *
+ *  @deprecated If you are using C++ you might want to use `std::priority_queue`
+ *  instead.
+ *
  *  @{
  */
 /* @brief heap datatype */
@@ -26,7 +29,7 @@ XBT_PUBLIC(int) xbt_heap_size(xbt_heap_t H);
 
 XBT_PUBLIC(void) xbt_heap_push(xbt_heap_t H, void *content, double key);
 XBT_PUBLIC(void *) xbt_heap_pop(xbt_heap_t H);
-XBT_PUBLIC(void) xbt_heap_rm_elm(xbt_heap_t H, void *content, double key);
+XBT_PUBLIC(void *) xbt_heap_rm_elm(xbt_heap_t H, void *content, double key);
 
 XBT_PUBLIC(double) xbt_heap_maxkey(xbt_heap_t H);
 XBT_PUBLIC(void *) xbt_heap_maxcontent(xbt_heap_t H);
@@ -37,15 +40,4 @@ XBT_PUBLIC(void ) xbt_heap_update(xbt_heap_t H, int i, double key);
 /* @} */
 SG_END_DECL()
 
-#ifdef __cplusplus
-namespace simgrid {
-namespace xbt {
-  inline void destroy(xbt_heap_t h)
-  {
-    xbt_heap_free(h);
-  }
-}
-}
-#endif
-
 #endif                          /* _XBT_HEAP_H */