comparison: src/cx/collection.h
src/cx/collection.h
- changeset 1424
- 563033aa998c
- parent 1171
- 155bc3b0dcb3
equal
deleted
inserted
replaced
| 1423:9a72258446cd | 1424:563033aa998c |
|---|---|
| 140 #define cxCollectionStoresPointers(c) ((c)->collection.store_pointer) | 140 #define cxCollectionStoresPointers(c) ((c)->collection.store_pointer) |
| 141 | 141 |
| 142 /** | 142 /** |
| 143 * Indicates whether the collection can guarantee that the stored elements are currently sorted. | 143 * Indicates whether the collection can guarantee that the stored elements are currently sorted. |
| 144 * | 144 * |
| 145 * This may return false even when the elements are sorted. | 145 * This may return @c false even when the elements are sorted. |
| 146 * It is totally up to the implementation of the collection whether it keeps track of the order of its elements. | 146 * It is totally up to the implementation of the collection when to check if the elements are sorted. |
| 147 * It is usually a good practice to establish this property as an invariant that does not need | |
| 148 * to be re-checked on certain operations. | |
| 147 * | 149 * |
| 148 * @param c a pointer to a struct that contains #CX_COLLECTION_BASE | 150 * @param c a pointer to a struct that contains #CX_COLLECTION_BASE |
| 149 * @retval true if the elements are currently sorted wrt. the collection's compare function | 151 * @retval true if the elements are currently sorted wrt. the collection's compare function |
| 150 * @retval false if the order of elements is unknown | 152 * @retval false if the order of elements is unknown |
| 151 */ | 153 */ |
