Vuo
2.3.2
|
A list of VuoMultisample elements.
Classes | |
struct | VuoList_VuoMultisample_struct |
A list of VuoMultisample elements. More... | |
Typedefs | |
typedef const struct VuoList_VuoMultisample_struct * | VuoList_VuoMultisample |
A list of VuoMultisample elements. More... | |
Functions | |
VuoList_VuoMultisample | VuoListCreate_VuoMultisample (void) |
Creates a new list of VuoMultisample elements. More... | |
VuoList_VuoMultisample | VuoListCreateWithCount_VuoMultisample (const unsigned long count, const VuoMultisample value) |
Creates a new list of count instances of value . More... | |
VuoList_VuoMultisample | VuoListCopy_VuoMultisample (const VuoList_VuoMultisample list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. More... | |
VuoMultisample | VuoListGetValue_VuoMultisample (const VuoList_VuoMultisample list, const unsigned long index) |
Returns the VuoMultisample at index . More... | |
VuoMultisample * | VuoListGetData_VuoMultisample (const VuoList_VuoMultisample list) |
Returns a pointer to a C array containing the list items. More... | |
void | VuoListForeach_VuoMultisample (const VuoList_VuoMultisample list, bool(^function)(const VuoMultisample value)) |
Applies function to each of list 's items, serially in order of index. More... | |
void | VuoListSetValue_VuoMultisample (const VuoList_VuoMultisample list, const VuoMultisample value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoMultisample at index . More... | |
void | VuoListInsertValue_VuoMultisample (const VuoList_VuoMultisample list, const VuoMultisample value, const unsigned long index) |
Inserts the VuoMultisample immediately before index . More... | |
void | VuoListPrependValue_VuoMultisample (VuoList_VuoMultisample list, const VuoMultisample value) |
Prepends value to list . More... | |
void | VuoListAppendValue_VuoMultisample (VuoList_VuoMultisample list, const VuoMultisample value) |
Appends value to list . More... | |
void | VuoListExchangeValues_VuoMultisample (VuoList_VuoMultisample list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . More... | |
void | VuoListShuffle_VuoMultisample (VuoList_VuoMultisample list, const double chaos) |
Generates a random permutation of list . More... | |
void | VuoListReverse_VuoMultisample (VuoList_VuoMultisample list) |
Reverses the order of the items in list . More... | |
VuoList_VuoMultisample | VuoListSubset_VuoMultisample (VuoList_VuoMultisample 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_VuoMultisample (VuoList_VuoMultisample list) |
Removes the first value from list . More... | |
void | VuoListRemoveLastValue_VuoMultisample (VuoList_VuoMultisample list) |
Removes the last value from list . More... | |
void | VuoListRemoveAll_VuoMultisample (VuoList_VuoMultisample list) |
Removes all values from list . More... | |
void | VuoListRemoveValue_VuoMultisample (VuoList_VuoMultisample list, const unsigned long index) |
Removes the VuoMultisample at index . More... | |
unsigned long | VuoListGetCount_VuoMultisample (const VuoList_VuoMultisample list) |
Returns the number of elements in list . More... | |
VuoList_VuoMultisample | VuoList_VuoMultisample_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoList_VuoMultisample_getJson (const VuoList_VuoMultisample value) |
Encodes value as a JSON object. More... | |
char * | VuoList_VuoMultisample_getSummary (const VuoList_VuoMultisample value) |
Produces a brief human-readable summary of value . More... | |
VuoList_VuoMultisample | VuoList_VuoMultisample_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoList_VuoMultisample_getString (const VuoList_VuoMultisample value) |
Automatically generated function. More... | |
typedef const struct VuoList_VuoMultisample_struct * VuoList_VuoMultisample |
A list of VuoMultisample elements.
struct json_object* VuoList_VuoMultisample_getJson | ( | const VuoList_VuoMultisample | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoMultisample.cc.
char* VuoList_VuoMultisample_getString | ( | const VuoList_VuoMultisample | value | ) |
Automatically generated function.
char* VuoList_VuoMultisample_getSummary | ( | const VuoList_VuoMultisample | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 119 of file VuoList_VuoMultisample.cc.
VuoList_VuoMultisample VuoList_VuoMultisample_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoMultisample.cc.
VuoList_VuoMultisample VuoList_VuoMultisample_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoMultisample | ( | VuoList_VuoMultisample | list, |
const VuoMultisample | value | ||
) |
Appends value
to list
.
Definition at line 308 of file VuoList_VuoMultisample.cc.
VuoList_VuoMultisample VuoListCopy_VuoMultisample | ( | const VuoList_VuoMultisample | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 174 of file VuoList_VuoMultisample.cc.
VuoList_VuoMultisample VuoListCreate_VuoMultisample | ( | void | ) |
Creates a new list of VuoMultisample elements.
Definition at line 154 of file VuoList_VuoMultisample.cc.
VuoList_VuoMultisample VuoListCreateWithCount_VuoMultisample | ( | const unsigned long | count, |
const VuoMultisample | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoMultisample to quickly initialize a large list.
Definition at line 161 of file VuoList_VuoMultisample.cc.
void VuoListExchangeValues_VuoMultisample | ( | VuoList_VuoMultisample | 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_VuoMultisample.cc.
void VuoListForeach_VuoMultisample | ( | const VuoList_VuoMultisample | list, |
bool(^)(const VuoMultisample 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_VuoMultisample.cc.
unsigned long VuoListGetCount_VuoMultisample | ( | const VuoList_VuoMultisample | list | ) |
Returns the number of elements in list
.
Definition at line 553 of file VuoList_VuoMultisample.cc.
VuoMultisample* VuoListGetData_VuoMultisample | ( | const VuoList_VuoMultisample | 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_VuoMultisample.cc.
VuoMultisample VuoListGetValue_VuoMultisample | ( | const VuoList_VuoMultisample | list, |
const unsigned long | index | ||
) |
Returns the VuoMultisample 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_VuoMultisample or VuoListForeach_VuoMultisample.
Definition at line 203 of file VuoList_VuoMultisample.cc.
void VuoListInsertValue_VuoMultisample | ( | const VuoList_VuoMultisample | list, |
const VuoMultisample | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoMultisample
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_VuoMultisample.cc.
void VuoListPrependValue_VuoMultisample | ( | VuoList_VuoMultisample | list, |
const VuoMultisample | value | ||
) |
Prepends value
to list
.
Definition at line 298 of file VuoList_VuoMultisample.cc.
void VuoListRemoveAll_VuoMultisample | ( | VuoList_VuoMultisample | list | ) |
Removes all values from list
.
Definition at line 527 of file VuoList_VuoMultisample.cc.
void VuoListRemoveFirstValue_VuoMultisample | ( | VuoList_VuoMultisample | list | ) |
Removes the first value from list
.
Definition at line 499 of file VuoList_VuoMultisample.cc.
void VuoListRemoveLastValue_VuoMultisample | ( | VuoList_VuoMultisample | list | ) |
Removes the last value from list
.
Definition at line 513 of file VuoList_VuoMultisample.cc.
void VuoListRemoveValue_VuoMultisample | ( | VuoList_VuoMultisample | list, |
const unsigned long | index | ||
) |
Removes the VuoMultisample
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_VuoMultisample.cc.
void VuoListReverse_VuoMultisample | ( | VuoList_VuoMultisample | list | ) |
Reverses the order of the items in list
.
Definition at line 422 of file VuoList_VuoMultisample.cc.
void VuoListSetValue_VuoMultisample | ( | const VuoList_VuoMultisample | list, |
const VuoMultisample | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoMultisample 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_VuoMultisample.cc.
void VuoListShuffle_VuoMultisample | ( | VuoList_VuoMultisample | 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_VuoMultisample.cc.
VuoList_VuoMultisample VuoListSubset_VuoMultisample | ( | VuoList_VuoMultisample | 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_VuoMultisample.cc.