ucx: comparison src/cx/linked

-:9a72258446cd
+:563033aa998c
 #ifdef __cplusplus
 extern "C" {
 #endif
 /**
-* Meta data for a linked list.
+* Metadata for a linked list.
 */
 typedef struct cx_linked_list_s {
 /** Base members. */
 struct cx_list_s base;
 /**
 /**
 * Allocates a linked list for storing elements with @p elem_size bytes each.
 *
 * If @p elem_size is #CX_STORE_POINTERS, the created list stores pointers instead of
-* copies of the added elements and the compare function will be automatically set
+* copies of the added elements, and the compare function will be automatically set
-* to cx_cmp_ptr(), if none is given.
+* to cx_cmp_ptr() if none is given.
 *
 * @param allocator the allocator for allocating the list nodes
 * (if @c NULL, the cxDefaultAllocator will be used)
 * @param comparator the comparator for the elements
 * (if @c NULL, and the list is not storing pointers, sort and find
 * The list will use cxDefaultAllocator and no comparator function. If you want
 * to call functions that need a comparator, you must either set one immediately
 * after list creation or use cxLinkedListCreate().
 *
 * If @p elem_size is #CX_STORE_POINTERS, the created list stores pointers instead of
-* copies of the added elements and the compare function will be automatically set
+* copies of the added elements, and the compare function will be automatically set
 * to cx_cmp_ptr().
 *
 * @param elem_size (@c size_t) the size of each element in bytes
 * @return (@c CxList*) the created list
 */
 /**
 * Finds the node at a certain index.
 *
 * This function can be used to start at an arbitrary position within the list.
-* If the search index is large than the start index, @p loc_advance must denote
+* If the search index is larger than the start index, @p loc_advance must denote
-* the location of some sort of @c next pointer (i.e. a pointer to the next node).
+* the location of a @c next pointer (i.e., a pointer to the next node).
 * But it is also possible that the search index is smaller than the start index
-* (e.g. in cases where traversing a list backwards is faster) in which case
+* (e.g., in cases where traversing a list backwards is faster).
-* @p loc_advance must denote the location of some sort of @c prev pointer
+* In that case @p loc_advance must denote the location of a @c prev pointer
-* (i.e. a pointer to the previous node).
+* (i.e., a pointer to the previous node).
 *
 * @param start a pointer to the start node
 * @param start_index the start index
 * @param loc_advance the location of the pointer to advance
 * @param index the search index
 const void *node
 );
 /**
 * Adds a new node to a linked list.
-* The node must not be part of any list already.
+* The node must not be part of any list yet.
 *
 * @remark One of the pointers @p begin or @p end may be @c NULL, but not both.
 *
 * @param begin a pointer to the beginning node pointer (if your list has one)
 * @param end a pointer to the end node pointer (if your list has one)
 void *new_node
 );
 /**
 * Prepends a new node to a linked list.
-* The node must not be part of any list already.
+* The node must not be part of any list yet.
 *
 * @remark One of the pointers @p begin or @p end may be @c NULL, but not both.
 *
 * @param begin a pointer to the beginning node pointer (if your list has one)
 * @param end a pointer to the end node pointer (if your list has one)
 ptrdiff_t loc_next
 );
 /**
 * Inserts a new node after a given node of a linked list.
-* The new node must not be part of any list already.
+* The new node must not be part of any list yet.
 *
 * @note If you specify @c NULL as the @p node to insert after, this function needs either the @p begin or
 * the @p end pointer to determine the start of the list. Then the new node will be prepended to the list.
 *
 * @param begin a pointer to the beginning node pointer (if your list has one)
 void *new_node
 );
 /**
 * Inserts a chain of nodes after a given node of a linked list.
-* The chain must not be part of any list already.
+* The chain must not be part of any list yet.
 *
 * If you do not explicitly specify the end of the chain, it will be determined by traversing
 * the @c next pointer.
 *
 * @note If you specify @c NULL as the @p node to insert after, this function needs either the @p begin or
 void *insert_end
 );
 /**
 * Inserts a node into a sorted linked list.
-* The new node must not be part of any list already.
+* The new node must not be part of any list yet.
 *
 * If the list starting with the node pointed to by @p begin is not sorted
 * already, the behavior is undefined.
 *
 * @param begin a pointer to the beginning node pointer (required)
 * If either the list starting with the node pointed to by @p begin or the list
 * starting with @p insert_begin is not sorted, the behavior is undefined.
 *
 * @attention In contrast to cx_linked_list_insert_chain(), the source chain
 * will be broken and inserted into the target list so that the resulting list
-* will be sorted according to @p cmp_func. That means, each node in the source
+* will be sorted according to @p cmp_func. That means each node in the source
 * chain may be re-linked with nodes from the target list.
 *
 * @param begin a pointer to the beginning node pointer (required)
 * @param end a pointer to the end node pointer (if your list has one)
 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
 );
 /**
 * Removes a chain of nodes from the linked list.
 *
-* If one of the nodes to remove is the beginning (resp. end) node of the list and if @p begin (resp. @p end)
+* If one of the nodes to remove is the beginning (resp. end) node of the list, and if @p begin (resp. @p end)
 * addresses are provided, the pointers are adjusted accordingly.
 *
 * The following combinations of arguments are valid (more arguments are optional):
 * @li @p loc_next and @p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance)
 * @li @p loc_next and @p begin (ancestor node is determined by list traversal, overall O(n) performance)
 );
 /**
 * Removes a node from the linked list.
 *
-* If the node to remove is the beginning (resp. end) node of the list and if @p begin (resp. @p end)
+* If the node to remove is the beginning (resp. end) node of the list, and if @p begin (resp. @p end)
 * addresses are provided, the pointers are adjusted accordingly.
 *
 * The following combinations of arguments are valid (more arguments are optional):
 * @li @p loc_next and @p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance)
 * @li @p loc_next and @p begin (ancestor node is determined by list traversal, overall O(n) performance)
 /**
 * Compares two lists element wise.
 *
-* @attention Both list must have the same structure.
+* @attention Both lists must have the same structure.
 *
 * @param begin_left the beginning of the left list (@c NULL denotes an empty list)
 * @param begin_right the beginning of the right list  (@c NULL denotes an empty list)
 * @param loc_advance the location of the pointer to advance
 * @param loc_data the location of the @c data pointer within your node struct

comparison: src/cx/linked_list.h

src/cx/linked_list.h

Mercurial > hg > ucx / file comparison

comparison: src/cx/linked_list.h

src/cx/linked_list.h