ucx/list.h

changeset 146
aa376dba1ba8
parent 129
61edec666928
child 172
7084e8e8433c
     1.1 --- a/ucx/list.h	Wed Aug 14 16:07:49 2013 +0200
     1.2 +++ b/ucx/list.h	Fri Aug 16 13:40:10 2013 +0200
     1.3 @@ -64,6 +64,7 @@
     1.4   * @see UcxList
     1.5   */
     1.6  typedef struct UcxList UcxList;
     1.7 +
     1.8  /**
     1.9   * UCX list structure.
    1.10   */
    1.11 @@ -99,6 +100,7 @@
    1.12   * @return a pointer to the copy
    1.13   */
    1.14  UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data);
    1.15 +
    1.16  /**
    1.17   * Creates an element-wise copy of a list using an UcxAllocator.
    1.18   * 
    1.19 @@ -152,6 +154,7 @@
    1.20   * @param list the list to free
    1.21   */
    1.22  void ucx_list_free(UcxList *list);
    1.23 +
    1.24  /**
    1.25   * Destroys the entire list using an UcxAllocator.
    1.26   * 
    1.27 @@ -162,6 +165,7 @@
    1.28   * @see ucx_list_free()
    1.29   */
    1.30  void ucx_list_free_a(UcxAllocator *allocator, UcxList *list);
    1.31 +
    1.32  /**
    1.33   * Inserts an element at the end of the list.
    1.34   * 
    1.35 @@ -175,6 +179,7 @@
    1.36   * the newly created list otherwise
    1.37   */
    1.38  UcxList *ucx_list_append(UcxList *list, void *data);
    1.39 +
    1.40  /**
    1.41   * Inserts an element at the end of the list using an UcxAllocator.
    1.42   * 
    1.43 @@ -189,6 +194,7 @@
    1.44   * @see ucx_list_append()
    1.45   */
    1.46  UcxList *ucx_list_append_a(UcxAllocator *allocator, UcxList *list, void *data);
    1.47 +
    1.48  /**
    1.49   * Inserts an element at the beginning of the list.
    1.50   * 
    1.51 @@ -204,6 +210,7 @@
    1.52   * @return a pointer to the new list head
    1.53   */
    1.54  UcxList *ucx_list_prepend(UcxList *list, void *data);
    1.55 +
    1.56  /**
    1.57   * Inserts an element at the beginning of the list using an UcxAllocator.
    1.58   * 
    1.59 @@ -217,6 +224,7 @@
    1.60   * @see ucx_list_prepend()
    1.61   */
    1.62  UcxList *ucx_list_prepend_a(UcxAllocator *allocator, UcxList *list, void *data);
    1.63 +
    1.64  /**
    1.65   * Concatenates two lists.
    1.66   * 
    1.67 @@ -232,6 +240,7 @@
    1.68   * returned, otherwise <code>list1</code> is returned
    1.69   */
    1.70  UcxList *ucx_list_concat(UcxList *list1, UcxList *list2);
    1.71 +
    1.72  /**
    1.73   * Returns the first element of a list.
    1.74   * 
    1.75 @@ -243,6 +252,7 @@
    1.76   * @return the first element of the list, the specified element is a member of
    1.77   */
    1.78  UcxList *ucx_list_first(const UcxList *elem);
    1.79 +
    1.80  /**
    1.81   * Returns the last element of a list.
    1.82   * 
    1.83 @@ -254,6 +264,7 @@
    1.84   * @return the last element of the list, the specified element is a member of
    1.85   */
    1.86  UcxList *ucx_list_last(const UcxList *elem);
    1.87 +
    1.88  /**
    1.89   * Returns the list element at the specified index.
    1.90   * 
    1.91 @@ -263,6 +274,7 @@
    1.92   * index is greater than the list size
    1.93   */
    1.94  UcxList *ucx_list_get(const UcxList *list, int index);
    1.95 +
    1.96  /**
    1.97   * Returns the index of an element.
    1.98   * 
    1.99 @@ -272,6 +284,7 @@
   1.100   * element
   1.101   */
   1.102  ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem);
   1.103 +
   1.104  /**
   1.105   * Returns the element count of the list.
   1.106   * 
   1.107 @@ -279,6 +292,7 @@
   1.108   * @return the element count
   1.109   */
   1.110  size_t ucx_list_size(const UcxList *list);
   1.111 +
   1.112  /**
   1.113   * Returns the index of an element containing the specified data.
   1.114   *
   1.115 @@ -297,6 +311,7 @@
   1.116   * data is not found in this list
   1.117   */
   1.118  ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
   1.119 +
   1.120  /**
   1.121   * Checks, if a list contains a specific element.
   1.122   * 
   1.123 @@ -340,6 +355,7 @@
   1.124   * is now empty
   1.125   */
   1.126  UcxList *ucx_list_remove(UcxList *list, UcxList *element);
   1.127 +
   1.128  /**
   1.129   * Removes an element from the list using an UcxAllocator.
   1.130   * 

mercurial