ucx: comparison ucx/list.h

-:5418bda21896
+:b79b1ce438dd
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 /**
-* Double linked list implementation.
+* Doubly linked list implementation.
 *
 * @file   list.h
 * @author Mike Becker
 * @author Olaf Wintermann
 */
 * the first element.
 */
 UcxList *prev;
 };
+/**
+* Creates an element-wise copy of a list.
+*
+* This function clones the specified list by creating new list elements and
+* copying the data with the specified copy_func(). If no copy_func() is
+* specified, a shallow copy is created and the new list will reference the
+* same data as the source list.
+*
+* @param list the list to copy
+* @param cpyfnc a pointer to the function that shall copy an element (may be
+* <code>NULL</code>)
+* @param data additional data for the copy_func()
+* @return a pointer to the copy
+*/
 UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data);
+/**
+* Creates an element-wise copy of a list using an UcxAllocator.
+*
+* See ucx_list_clone() for details.
+*
+* Keep in mind, that you might want to pass the allocator as an (part of the)
+* argument for the <code>data</code> parameter, if you want the copy_func() to
+* make use of the allocator.
+*
+* @param list the list to copy
+* @param cpyfnc a pointer to the function that shall copy an element (may be
+* <code>NULL</code>)
+* @param data additional data for the copy_func()
+* @return a pointer to the copy
+* @see ucx_list_clone()
+*/
 UcxList *ucx_list_clone_a(UcxAllocator *allocator, UcxList *list,
 copy_func cpyfnc, void* data);
 /**
 * Compares two UCX lists element-wise by using a compare function.
 * otherwise referenced or a memory leak will occur.
 *
 * <b>Caution:</b> the argument <b>MUST</b> denote an entire list (i.e. a call
 * to ucx_list_first() on the argument must return the argument itself)
 *
-* @param list The list to free.
+* @param list the list to free
 */
 void ucx_list_free(UcxList *list);
+/**
+* Destroys the entire list using an UcxAllocator.
+*
+* See ucx_list_free() for details.
+*
+* @param allocator the allocator to use
+* @param list the list to free
+* @see ucx_list_free()
+*/
 void ucx_list_free_a(UcxAllocator *allocator, UcxList *list);
+/**
+* Inserts an element at the end of the list.
+*
+* This is generally an O(n) operation, as the end of the list is seeked with
+* ucx_list_last().
+*
+* @param list the list where to append the data, or <code>NULL</code> to
+* create a new list
+* @param data the data to insert
+* @return <code>list</code>, if it is not <code>NULL</code> or a pointer to
+* the newly created list otherwise
+*/
 UcxList *ucx_list_append(UcxList *list, void *data);
+/**
+* Inserts an element at the end of the list using an UcxAllocator.
+*
+* See ucx_list_append() for details.
+*
+* @param allocator the allocator to use
+* @param list the list where to append the data, or <code>NULL</code> to
+* create a new list
+* @param data the data to insert
+* @return <code>list</code>, if it is not <code>NULL</code> or a pointer to
+* the newly created list otherwise
+* @see ucx_list_append()
+*/
 UcxList *ucx_list_append_a(UcxAllocator *allocator, UcxList *list, void *data);
+/**
+* Inserts an element at the beginning of the list.
+*
+* You <i>should</i> overwrite the old list pointer by calling
+* <code>mylist = ucx_list_prepend(mylist, mydata);</code>. However, you may
+* also perform successive calls of ucx_list_prepend() on the same list pointer,
+* as this function always searchs for the head of the list with
+* ucx_list_first().
+*
+* @param list the list where to insert the data or <code>NULL</code> to create
+* a new list
+* @param data the data to insert
+* @return a pointer to the new list head
+*/
 UcxList *ucx_list_prepend(UcxList *list, void *data);
+/**
+* Inserts an element at the beginning of the list using an UcxAllocator.
+*
+* See ucx_list_prepend() for details.
+*
+* @param allocator the allocator to use
+* @param list the list where to insert the data or <code>NULL</code> to create
+* a new list
+* @param data the data to insert
+* @return a pointer to the new list head
+* @see ucx_list_prepend()
+*/
 UcxList *ucx_list_prepend_a(UcxAllocator *allocator, UcxList *list, void *data);
+/**
+* Concatenates two lists.
+*
+* Either of the two arguments may be <code>NULL</code>.
+*
+* This function modifies the references to the next/previous element of
+* the last/first element of <code>list1</code>/<code>
+* list2</code>.
+*
+* @param list1 first list
+* @param list2 second list
+* @return if <code>list1</code> is <code>NULL</code>, <code>list2</code> is
+* returned, otherwise <code>list1</code> is returned
+*/
 UcxList *ucx_list_concat(UcxList *list1, UcxList *list2);
 /**
 * Returns the first element of a list.
 *
 * If the argument is the list pointer, it is directly returned. Otherwise
 *
 * @param elem one element of the list
 * @return the last element of the list, the specified element is a member of
 */
 UcxList *ucx_list_last(const UcxList *elem);
+/**
+* Returns the list element at the specified index.
+*
+* @param list the list to retrieve the element from
+* @param index index of the element to return
+* @return the element at the specified index or <code>NULL</code>, if the
+* index is greater than the list size
+*/
 UcxList *ucx_list_get(const UcxList *list, int index);
+/**
+* Returns the index of an element.
+*
+* @param list the list where to search for the element
+* @param elem the element to find
+* @return the index of the element or -1 if the list does not contain the
+* element
+*/
 ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem);
+/**
+* Returns the element count of the list.
+*
+* @param list the list whose elements are counted
+* @return the element count
+*/
 size_t ucx_list_size(const UcxList *list);
+/**
+* Returns the index of an element containing the specified data.
+*
+* This function uses a cmp_func() to compare the data of each list element
+* with the specified data. If no cmp_func is provided, the pointers are
+* compared.
+*
+* If the list contains the data more than once, the index of the first
+* occurrence is returned.
+*
+* @param list the list where to search for the data
+* @param elem the element data
+* @param cmpfnc the compare function
+* @param data additional data for the compare function
+* @return the index of the element containing the specified data or -1 if the
+* data is not found in this list
+*/
 ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
+/**
+* Checks, if a list contains a specific element.
+*
+* An element is found, if ucx_list_find() returns a value greater than -1.
+*
+* @param list the list where to search for the data
+* @param elem the element data
+* @param cmpfnc the compare function
+* @param data additional data for the compare function
+* @return 1, if and only if the list contains the specified element data
+* @see ucx_list_find()
+*/
 int ucx_list_contains(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
+/**
+* Sorts an UcxList with natural merge sort.
+*
+* This function uses O(n) additional temporary memory for merge operations
+* that is automatically freed after each merge.
+*
+* As the head of the list might change, you <b>MUST</b> call this function
+* as follows: <code>mylist = ucx_list_sort(mylist, mycmpfnc, mydata);</code>.
+*
+* @param list the list to sort
+* @param cmpfnc the function that shall be used to compare the element data
+* @param data additional data for the cmp_func()
+* @return the sorted list
+*/
 UcxList *ucx_list_sort(UcxList *list, cmp_func cmpfnc, void *data);
 /**
 * Removes an element from the list.
 *
 * @param element the element to removed
 * @return returns the updated list pointer or <code>NULL</code>, if the list
 * is now empty
 */
 UcxList *ucx_list_remove(UcxList *list, UcxList *element);
+/**
+* Removes an element from the list using an UcxAllocator.
+*
+* See ucx_list_remove() for details.
+*
+* @param allocator the allocator to use
+* @param list the list from which the element shall be removed
+* @param element the element to removed
+* @return returns the updated list pointer or <code>NULL</code>, if the list
+* @see ucx_list_remove()
+*/
 UcxList *ucx_list_remove_a(UcxAllocator *allocator, UcxList *list,
 UcxList *element);
 #ifdef	__cplusplus
 }

Mercurial > hg > ucx / file comparison

comparison: ucx/list.h

ucx/list.h