VuoList interface.
Definition in file VuoList_VuoVerticalReflection.h.
Go to the source code of this file.
Classes | |
struct | VuoList_VuoVerticalReflection |
An ordered list of items, all of the same type. More... | |
struct json_object * VuoList_VuoVerticalReflection_getJson | ( | const VuoList_VuoVerticalReflection | list | ) |
Encodes list as a JSON object.
char * VuoList_VuoVerticalReflection_getString | ( | const VuoList_VuoVerticalReflection | list | ) |
Automatically generated function.
char * VuoList_VuoVerticalReflection_getSummary | ( | const VuoList_VuoVerticalReflection | list | ) |
Produces a brief human-readable summary of list
.
VuoList_VuoVerticalReflection VuoList_VuoVerticalReflection_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js to create a new list.
void VuoList_VuoVerticalReflection_release | ( | VuoList_VuoVerticalReflection | list | ) |
Releases the list.
This function is provided for use in polymorphism; it just calls VuoRelease()
.
void VuoList_VuoVerticalReflection_retain | ( | VuoList_VuoVerticalReflection | list | ) |
Retains the list.
This function is provided for use in polymorphism; it just calls VuoRetain()
.
void VuoListAppendValue_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list, |
const VuoVerticalReflection | value | ||
) |
Appends value to list.
VuoList_VuoVerticalReflection VuoListCopy_VuoVerticalReflection | ( | const VuoList_VuoVerticalReflection | list | ) |
Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoList_VuoVerticalReflection VuoListCreate_VuoVerticalReflection | ( | void | ) |
Creates a new list of VuoVerticalReflection
items.
VuoList_VuoVerticalReflection VuoListCreateWithCount_VuoVerticalReflection | ( | const unsigned long | count, |
const VuoVerticalReflection | value | ||
) |
Creates a new list of count instances of value.
Use this in conjunction with VuoListGetData_VuoVerticalReflection to quickly initialize a large list.
VuoList_VuoVerticalReflection VuoListCreateWithValueArray_VuoVerticalReflection | ( | const VuoVerticalReflection * | values, |
const unsigned long | valueCount | ||
) |
Creates a new list containing the items in the C array values.
The list retains each item in values. The caller may discard values after this function returns.
void VuoListExchangeValues_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA with the value at indexB.
void VuoListForeach_VuoVerticalReflection | ( | const VuoList_VuoVerticalReflection | list, |
bool(^)(const VuoVerticalReflection value) | function | ||
) |
Applies function to each item in list, serially in order of index.
If function returns false, visiting will stop immediately (possibly before all items have been visited).
unsigned long VuoListGetCount_VuoVerticalReflection | ( | const VuoList_VuoVerticalReflection | list | ) |
Returns the number of items in list.
VuoVerticalReflection * VuoListGetData_VuoVerticalReflection | ( | const VuoList_VuoVerticalReflection | list | ) |
Returns a pointer to a C array containing the list items.
Use this if you need a fast way to get or change multiple list items.
You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.
The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.
If the list has no items, returns NULL.
The pointer remains owned by the list; don't free it.
VuoVerticalReflection VuoListGetValue_VuoVerticalReflection | ( | const VuoList_VuoVerticalReflection | list, |
const unsigned long | index | ||
) |
Returns the item at index.
Index values start at 1.
If the list has no items, returns a default value (an empty/zero value of VuoVerticalReflection
).
Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).
If iterating over an entire list, consider using VuoListGetData_VuoVerticalReflection or VuoListForeach_VuoVerticalReflection.
void VuoListInsertValue_VuoVerticalReflection | ( | const VuoList_VuoVerticalReflection | list, |
const VuoVerticalReflection | value, | ||
const unsigned long | index | ||
) |
Inserts value immediately before index.
Index values start at 1.
Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.
void VuoListPrependValue_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list, |
const VuoVerticalReflection | value | ||
) |
Prepends value to list.
void VuoListRemoveAll_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list | ) |
Removes all items from list.
void VuoListRemoveFirstValue_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list | ) |
Removes the first item from list.
void VuoListRemoveLastValue_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list | ) |
Removes the last item from list.
void VuoListRemoveValue_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list, |
const unsigned long | index | ||
) |
Removes the item at index.
Index values start at 1.
Attempting to remove index 0 or an index beyond the last value in the list has no effect.
void VuoListReverse_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list | ) |
Reverses the order of the items in list.
void VuoListSetValue_VuoVerticalReflection | ( | const VuoList_VuoVerticalReflection | list, |
const VuoVerticalReflection | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the item at index.
Index values start at 1.
If expandListIfNeeded is false — If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).
If expandListIfNeeded is true — If the list has less than index items, it is expanded to accommodate the specified index. If index is 0, the list is resized to contain 1 item set to value.
void VuoListShuffle_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list, |
const double | chaos | ||
) |
Generates a random permutation of list.
chaos ranges from 0 to 1. When chaos is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.
VuoList_VuoVerticalReflection VuoListSubset_VuoVerticalReflection | ( | VuoList_VuoVerticalReflection | list, |
const signed long | startIndex, | ||
const unsigned long | itemCount | ||
) |
Returns a new list containing items from the original list in the range specified by startIndex and itemCount.
Items in the new list are retained (not copied) from the original list.