/cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.31/CxxUtils/CxxUtils/libcalg/arraylist.h File Reference
Automatically resizing array.
More...
Go to the source code of this file.
Classes |
struct | _ArrayList |
Typedefs |
typedef void * | ArrayListValue |
typedef struct _ArrayList | ArrayList |
typedef int(* | ArrayListEqualFunc )(ArrayListValue value1, ArrayListValue value2) |
typedef int(* | ArrayListCompareFunc )(ArrayListValue value1, ArrayListValue value2) |
Functions |
ArrayList * | arraylist_new (int length) |
void | arraylist_free (ArrayList *arraylist) |
int | arraylist_append (ArrayList *arraylist, ArrayListValue data) |
int | arraylist_prepend (ArrayList *arraylist, ArrayListValue data) |
void | arraylist_remove (ArrayList *arraylist, int index) |
void | arraylist_remove_range (ArrayList *arraylist, int index, int length) |
int | arraylist_insert (ArrayList *arraylist, int index, ArrayListValue data) |
int | arraylist_index_of (ArrayList *arraylist, ArrayListEqualFunc callback, ArrayListValue data) |
void | arraylist_clear (ArrayList *arraylist) |
void | arraylist_sort (ArrayList *arraylist, ArrayListCompareFunc compare_func) |
Detailed Description
Automatically resizing array.
ArrayLists are arrays of pointers which automatically increase in size.
To create an ArrayList, use arraylist_new. To destroy an ArrayList, use arraylist_free.
To add a value to an ArrayList, use arraylist_prepend, arraylist_append, or arraylist_insert.
To remove a value from an ArrayList, use arraylist_remove or arraylist_remove_range.
Typedef Documentation
An ArrayList structure. New ArrayLists can be created using the arraylist_new function.
- See also:
- arraylist_new
Compare two values in an arraylist. Used by arraylist_sort when sorting values.
- Parameters:
-
| value1 | The first value. |
| value2 | The second value. |
- Returns:
- A negative number if value1 should be sorted before value2, a positive number if value2 should be sorted before value1, zero if the two values are equal.
Compare two values in an arraylist to determine if they are equal.
- Returns:
- Non-zero if the values are not equal, zero if they are equal.
Function Documentation
Append a value to the end of an ArrayList.
- Parameters:
-
| arraylist | The ArrayList. |
| data | The value to append. |
- Returns:
- Non-zero if the request was successful, zero if it was not possible to allocate more memory for the new entry.
void arraylist_clear |
( |
ArrayList * |
arraylist |
) |
|
Remove all entries from an ArrayList.
- Parameters:
-
void arraylist_free |
( |
ArrayList * |
arraylist |
) |
|
Destroy an ArrayList and free back the memory it uses.
- Parameters:
-
| arraylist | The ArrayList to free. |
Find the index of a particular value in an ArrayList.
- Parameters:
-
| arraylist | The ArrayList to search. |
| callback | Callback function to be invoked to compare values in the list with the value to be searched for. |
| data | The value to search for. |
- Returns:
- The index of the value if found, or -1 if not found.
Insert a value at the specified index in an ArrayList. The index where the new value can be inserted is limited by the size of the ArrayList.
- Parameters:
-
| arraylist | The ArrayList. |
| index | The index at which to insert the value. |
| data | The value. |
- Returns:
- Returns zero if unsuccessful, else non-zero if successful (due to an invalid index or if it was impossible to allocate more memory).
Allocate a new ArrayList for use.
- Parameters:
-
| length | Hint to the initialise function as to the amount of memory to allocate initially to the ArrayList. |
- Returns:
- A new arraylist, or NULL if it was not possible to allocate the memory.
- See also:
- arraylist_free
Prepend a value to the beginning of an ArrayList.
- Parameters:
-
| arraylist | The ArrayList. |
| data | The value to prepend. |
- Returns:
- Non-zero if the request was successful, zero if it was not possible to allocate more memory for the new entry.
void arraylist_remove |
( |
ArrayList * |
arraylist, |
|
|
int |
index | |
|
) |
| | |
Remove the entry at the specified location in an ArrayList.
- Parameters:
-
| arraylist | The ArrayList. |
| index | The index of the entry to remove. |
void arraylist_remove_range |
( |
ArrayList * |
arraylist, |
|
|
int |
index, |
|
|
int |
length | |
|
) |
| | |
Remove a range of entries at the specified location in an ArrayList.
- Parameters:
-
| arraylist | The ArrayList. |
| index | The index of the start of the range to remove. |
| length | The length of the range to remove. |
Sort the values in an ArrayList.
- Parameters:
-
| arraylist | The ArrayList. |
| compare_func | Function used to compare values in sorting. |