Vuo
1.2.6
|
A list of VuoDiode elements.
Classes | |
struct | VuoList_VuoDiode_struct |
A list of VuoDiode elements. More... | |
Typedefs | |
typedef struct VuoList_VuoDiode_struct * | VuoList_VuoDiode |
A list of VuoDiode elements. | |
Functions | |
VuoList_VuoDiode | VuoListCreate_VuoDiode (void) |
Creates a new list of VuoDiode elements. | |
VuoList_VuoDiode | VuoListCreateWithCount_VuoDiode (const unsigned long count, const VuoDiode value) |
Creates a new list of count instances of value . | |
VuoList_VuoDiode | VuoListCopy_VuoDiode (const VuoList_VuoDiode list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. | |
VuoDiode | VuoListGetValue_VuoDiode (const VuoList_VuoDiode list, const unsigned long index) |
Returns the VuoDiode at index . | |
VuoDiode * | VuoListGetData_VuoDiode (const VuoList_VuoDiode list) |
Returns a pointer to a C array containing the list items. | |
void | VuoListSetValue_VuoDiode (const VuoList_VuoDiode list, const VuoDiode value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoDiode at index . | |
void | VuoListInsertValue_VuoDiode (const VuoList_VuoDiode list, const VuoDiode value, const unsigned long index) |
Inserts the VuoDiode immediately before index . | |
void | VuoListPrependValue_VuoDiode (VuoList_VuoDiode list, const VuoDiode value) |
Prepends value to list . | |
void | VuoListAppendValue_VuoDiode (VuoList_VuoDiode list, const VuoDiode value) |
Appends value to list . | |
void | VuoListExchangeValues_VuoDiode (VuoList_VuoDiode list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . | |
void | VuoListShuffle_VuoDiode (VuoList_VuoDiode list, const double chaos) |
Generates a random permutation of list . | |
void | VuoListReverse_VuoDiode (VuoList_VuoDiode list) |
Reverses the order of the items in list . | |
VuoList_VuoDiode | VuoListSubset_VuoDiode (VuoList_VuoDiode 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 . | |
void | VuoListRemoveFirstValue_VuoDiode (VuoList_VuoDiode list) |
Removes the first value from list . | |
void | VuoListRemoveLastValue_VuoDiode (VuoList_VuoDiode list) |
Removes the last value from list . | |
void | VuoListRemoveAll_VuoDiode (VuoList_VuoDiode list) |
Removes all values from list . | |
void | VuoListRemoveValue_VuoDiode (VuoList_VuoDiode list, const unsigned long index) |
Removes the VuoDiode at index . | |
unsigned long | VuoListGetCount_VuoDiode (const VuoList_VuoDiode list) |
Returns the number of elements in list . | |
VuoList_VuoDiode | VuoList_VuoDiode_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. | |
struct json_object * | VuoList_VuoDiode_getJson (const VuoList_VuoDiode value) |
Encodes value as a JSON object. | |
char * | VuoList_VuoDiode_getSummary (const VuoList_VuoDiode value) |
Produces a brief human-readable summary of value . | |
VuoList_VuoDiode | VuoList_VuoDiode_makeFromString (const char *str) |
Automatically generated function. | |
char * | VuoList_VuoDiode_getString (const VuoList_VuoDiode value) |
Automatically generated function. | |
typedef struct VuoList_VuoDiode_struct * VuoList_VuoDiode |
A list of VuoDiode elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoDiode_getString | ( | const VuoList_VuoDiode | value | ) |
Automatically generated function.
char* VuoList_VuoDiode_getSummary | ( | const VuoList_VuoDiode | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoDiode VuoList_VuoDiode_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoDiode VuoList_VuoDiode_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoDiode | ( | VuoList_VuoDiode | list, |
const VuoDiode | value | ||
) |
Appends value
to list
.
VuoList_VuoDiode VuoListCopy_VuoDiode | ( | const VuoList_VuoDiode | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoDiode VuoListCreate_VuoDiode | ( | void | ) |
Creates a new list of VuoDiode elements.
VuoList_VuoDiode VuoListCreateWithCount_VuoDiode | ( | const unsigned long | count, |
const VuoDiode | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoDiode to quickly initialize a large list.
void VuoListExchangeValues_VuoDiode | ( | VuoList_VuoDiode | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoDiode | ( | const VuoList_VuoDiode | list | ) |
Returns the number of elements in list
.
VuoDiode* VuoListGetData_VuoDiode | ( | const VuoList_VuoDiode | 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.
VuoDiode VuoListGetValue_VuoDiode | ( | const VuoList_VuoDiode | list, |
const unsigned long | index | ||
) |
Returns the VuoDiode 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).
void VuoListInsertValue_VuoDiode | ( | const VuoList_VuoDiode | list, |
const VuoDiode | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoDiode
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_VuoDiode | ( | VuoList_VuoDiode | list, |
const VuoDiode | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoDiode | ( | VuoList_VuoDiode | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoDiode | ( | VuoList_VuoDiode | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoDiode | ( | VuoList_VuoDiode | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoDiode | ( | VuoList_VuoDiode | list, |
const unsigned long | index | ||
) |
Removes the VuoDiode
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_VuoDiode | ( | VuoList_VuoDiode | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoDiode | ( | const VuoList_VuoDiode | list, |
const VuoDiode | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoDiode 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
.
void VuoListShuffle_VuoDiode | ( | VuoList_VuoDiode | 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_VuoDiode VuoListSubset_VuoDiode | ( | VuoList_VuoDiode | 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.