VuoList interface.
Definition in file VuoList_VuoAudioBinAverageType.h.
Go to the source code of this file.
Classes | |
struct | VuoList_VuoAudioBinAverageType |
An ordered list of items, all of the same type. More... | |
struct json_object * VuoList_VuoAudioBinAverageType_getJson | ( | const VuoList_VuoAudioBinAverageType | list | ) |
Encodes list as a JSON object.
char * VuoList_VuoAudioBinAverageType_getString | ( | const VuoList_VuoAudioBinAverageType | list | ) |
Automatically generated function.
char * VuoList_VuoAudioBinAverageType_getSummary | ( | const VuoList_VuoAudioBinAverageType | list | ) |
Produces a brief human-readable summary of list
.
VuoList_VuoAudioBinAverageType VuoList_VuoAudioBinAverageType_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js to create a new list.
void VuoList_VuoAudioBinAverageType_release | ( | VuoList_VuoAudioBinAverageType | list | ) |
Releases the list.
This function is provided for use in polymorphism; it just calls VuoRelease()
.
void VuoList_VuoAudioBinAverageType_retain | ( | VuoList_VuoAudioBinAverageType | list | ) |
Retains the list.
This function is provided for use in polymorphism; it just calls VuoRetain()
.
void VuoListAppendValue_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | list, |
const VuoAudioBinAverageType | value | ||
) |
Appends value to list.
VuoList_VuoAudioBinAverageType VuoListCopy_VuoAudioBinAverageType | ( | const VuoList_VuoAudioBinAverageType | list | ) |
Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoList_VuoAudioBinAverageType VuoListCreate_VuoAudioBinAverageType | ( | void | ) |
Creates a new list of VuoAudioBinAverageType
items.
VuoList_VuoAudioBinAverageType VuoListCreateWithCount_VuoAudioBinAverageType | ( | const unsigned long | count, |
const VuoAudioBinAverageType | value | ||
) |
Creates a new list of count instances of value.
Use this in conjunction with VuoListGetData_VuoAudioBinAverageType to quickly initialize a large list.
VuoList_VuoAudioBinAverageType VuoListCreateWithValueArray_VuoAudioBinAverageType | ( | const VuoAudioBinAverageType * | 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_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA with the value at indexB.
void VuoListForeach_VuoAudioBinAverageType | ( | const VuoList_VuoAudioBinAverageType | list, |
bool(^)(const VuoAudioBinAverageType 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_VuoAudioBinAverageType | ( | const VuoList_VuoAudioBinAverageType | list | ) |
Returns the number of items in list.
VuoAudioBinAverageType * VuoListGetData_VuoAudioBinAverageType | ( | const VuoList_VuoAudioBinAverageType | 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.
VuoAudioBinAverageType VuoListGetValue_VuoAudioBinAverageType | ( | const VuoList_VuoAudioBinAverageType | 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 VuoAudioBinAverageType
).
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_VuoAudioBinAverageType or VuoListForeach_VuoAudioBinAverageType.
void VuoListInsertValue_VuoAudioBinAverageType | ( | const VuoList_VuoAudioBinAverageType | list, |
const VuoAudioBinAverageType | 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_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | list, |
const VuoAudioBinAverageType | value | ||
) |
Prepends value to list.
void VuoListRemoveAll_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | list | ) |
Removes all items from list.
void VuoListRemoveFirstValue_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | list | ) |
Removes the first item from list.
void VuoListRemoveLastValue_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | list | ) |
Removes the last item from list.
void VuoListRemoveValue_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | 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_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | list | ) |
Reverses the order of the items in list.
void VuoListSetValue_VuoAudioBinAverageType | ( | const VuoList_VuoAudioBinAverageType | list, |
const VuoAudioBinAverageType | 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_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | 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_VuoAudioBinAverageType VuoListSubset_VuoAudioBinAverageType | ( | VuoList_VuoAudioBinAverageType | 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.