Vuo
2.3.2
|
A list of VuoListPosition elements.
Classes | |
struct | VuoList_VuoListPosition_struct |
A list of VuoListPosition elements. More... | |
Typedefs | |
typedef const struct VuoList_VuoListPosition_struct * | VuoList_VuoListPosition |
A list of VuoListPosition elements. More... | |
Functions | |
VuoList_VuoListPosition | VuoListCreate_VuoListPosition (void) |
Creates a new list of VuoListPosition elements. More... | |
VuoList_VuoListPosition | VuoListCreateWithCount_VuoListPosition (const unsigned long count, const VuoListPosition value) |
Creates a new list of count instances of value . More... | |
VuoList_VuoListPosition | VuoListCopy_VuoListPosition (const VuoList_VuoListPosition list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. More... | |
VuoListPosition | VuoListGetValue_VuoListPosition (const VuoList_VuoListPosition list, const unsigned long index) |
Returns the VuoListPosition at index . More... | |
VuoListPosition * | VuoListGetData_VuoListPosition (const VuoList_VuoListPosition list) |
Returns a pointer to a C array containing the list items. More... | |
void | VuoListForeach_VuoListPosition (const VuoList_VuoListPosition list, bool(^function)(const VuoListPosition value)) |
Applies function to each of list 's items, serially in order of index. More... | |
void | VuoListSetValue_VuoListPosition (const VuoList_VuoListPosition list, const VuoListPosition value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoListPosition at index . More... | |
void | VuoListInsertValue_VuoListPosition (const VuoList_VuoListPosition list, const VuoListPosition value, const unsigned long index) |
Inserts the VuoListPosition immediately before index . More... | |
void | VuoListPrependValue_VuoListPosition (VuoList_VuoListPosition list, const VuoListPosition value) |
Prepends value to list . More... | |
void | VuoListAppendValue_VuoListPosition (VuoList_VuoListPosition list, const VuoListPosition value) |
Appends value to list . More... | |
void | VuoListExchangeValues_VuoListPosition (VuoList_VuoListPosition list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . More... | |
void | VuoListShuffle_VuoListPosition (VuoList_VuoListPosition list, const double chaos) |
Generates a random permutation of list . More... | |
void | VuoListReverse_VuoListPosition (VuoList_VuoListPosition list) |
Reverses the order of the items in list . More... | |
VuoList_VuoListPosition | VuoListSubset_VuoListPosition (VuoList_VuoListPosition 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 . More... | |
void | VuoListRemoveFirstValue_VuoListPosition (VuoList_VuoListPosition list) |
Removes the first value from list . More... | |
void | VuoListRemoveLastValue_VuoListPosition (VuoList_VuoListPosition list) |
Removes the last value from list . More... | |
void | VuoListRemoveAll_VuoListPosition (VuoList_VuoListPosition list) |
Removes all values from list . More... | |
void | VuoListRemoveValue_VuoListPosition (VuoList_VuoListPosition list, const unsigned long index) |
Removes the VuoListPosition at index . More... | |
unsigned long | VuoListGetCount_VuoListPosition (const VuoList_VuoListPosition list) |
Returns the number of elements in list . More... | |
VuoList_VuoListPosition | VuoList_VuoListPosition_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoList_VuoListPosition_getJson (const VuoList_VuoListPosition value) |
Encodes value as a JSON object. More... | |
char * | VuoList_VuoListPosition_getSummary (const VuoList_VuoListPosition value) |
Produces a brief human-readable summary of value . More... | |
VuoList_VuoListPosition | VuoList_VuoListPosition_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoList_VuoListPosition_getString (const VuoList_VuoListPosition value) |
Automatically generated function. More... | |
typedef const struct VuoList_VuoListPosition_struct * VuoList_VuoListPosition |
A list of VuoListPosition elements.
struct json_object* VuoList_VuoListPosition_getJson | ( | const VuoList_VuoListPosition | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoListPosition.cc.
char* VuoList_VuoListPosition_getString | ( | const VuoList_VuoListPosition | value | ) |
Automatically generated function.
char* VuoList_VuoListPosition_getSummary | ( | const VuoList_VuoListPosition | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 119 of file VuoList_VuoListPosition.cc.
VuoList_VuoListPosition VuoList_VuoListPosition_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoListPosition.cc.
VuoList_VuoListPosition VuoList_VuoListPosition_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoListPosition | ( | VuoList_VuoListPosition | list, |
const VuoListPosition | value | ||
) |
Appends value
to list
.
Definition at line 308 of file VuoList_VuoListPosition.cc.
VuoList_VuoListPosition VuoListCopy_VuoListPosition | ( | const VuoList_VuoListPosition | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 174 of file VuoList_VuoListPosition.cc.
VuoList_VuoListPosition VuoListCreate_VuoListPosition | ( | void | ) |
Creates a new list of VuoListPosition elements.
Definition at line 154 of file VuoList_VuoListPosition.cc.
VuoList_VuoListPosition VuoListCreateWithCount_VuoListPosition | ( | const unsigned long | count, |
const VuoListPosition | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoListPosition to quickly initialize a large list.
Definition at line 161 of file VuoList_VuoListPosition.cc.
void VuoListExchangeValues_VuoListPosition | ( | VuoList_VuoListPosition | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
Definition at line 318 of file VuoList_VuoListPosition.cc.
void VuoListForeach_VuoListPosition | ( | const VuoList_VuoListPosition | list, |
bool(^)(const VuoListPosition value) | function | ||
) |
Applies function
to each of list
's items, serially in order of index.
If function
returns false, visiting will stop immediately (possibly before all items have been visited).
Definition at line 229 of file VuoList_VuoListPosition.cc.
unsigned long VuoListGetCount_VuoListPosition | ( | const VuoList_VuoListPosition | list | ) |
Returns the number of elements in list
.
Definition at line 553 of file VuoList_VuoListPosition.cc.
VuoListPosition* VuoListGetData_VuoListPosition | ( | const VuoList_VuoListPosition | 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.
Definition at line 219 of file VuoList_VuoListPosition.cc.
VuoListPosition VuoListGetValue_VuoListPosition | ( | const VuoList_VuoListPosition | list, |
const unsigned long | index | ||
) |
Returns the VuoListPosition at index
.
Index values start at 1. If the list has no items, returns a default value. 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_VuoListPosition or VuoListForeach_VuoListPosition.
Definition at line 203 of file VuoList_VuoListPosition.cc.
void VuoListInsertValue_VuoListPosition | ( | const VuoList_VuoListPosition | list, |
const VuoListPosition | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoListPosition
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.
Definition at line 276 of file VuoList_VuoListPosition.cc.
void VuoListPrependValue_VuoListPosition | ( | VuoList_VuoListPosition | list, |
const VuoListPosition | value | ||
) |
Prepends value
to list
.
Definition at line 298 of file VuoList_VuoListPosition.cc.
void VuoListRemoveAll_VuoListPosition | ( | VuoList_VuoListPosition | list | ) |
Removes all values from list
.
Definition at line 527 of file VuoList_VuoListPosition.cc.
void VuoListRemoveFirstValue_VuoListPosition | ( | VuoList_VuoListPosition | list | ) |
Removes the first value from list
.
Definition at line 499 of file VuoList_VuoListPosition.cc.
void VuoListRemoveLastValue_VuoListPosition | ( | VuoList_VuoListPosition | list | ) |
Removes the last value from list
.
Definition at line 513 of file VuoList_VuoListPosition.cc.
void VuoListRemoveValue_VuoListPosition | ( | VuoList_VuoListPosition | list, |
const unsigned long | index | ||
) |
Removes the VuoListPosition
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.
Definition at line 536 of file VuoList_VuoListPosition.cc.
void VuoListReverse_VuoListPosition | ( | VuoList_VuoListPosition | list | ) |
Reverses the order of the items in list
.
Definition at line 422 of file VuoList_VuoListPosition.cc.
void VuoListSetValue_VuoListPosition | ( | const VuoList_VuoListPosition | list, |
const VuoListPosition | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoListPosition 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
elements, it is expanded to accommodate the specified index
. If index
is 0, the list is resized to contain 1 item set to value
.
Definition at line 241 of file VuoList_VuoListPosition.cc.
void VuoListShuffle_VuoListPosition | ( | VuoList_VuoListPosition | 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.
Definition at line 401 of file VuoList_VuoListPosition.cc.
VuoList_VuoListPosition VuoListSubset_VuoListPosition | ( | VuoList_VuoListPosition | 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.
Definition at line 431 of file VuoList_VuoListPosition.cc.