Vuo
1.2.0
|
A list of VuoFileType elements.
Classes | |
struct | VuoList_VuoFileType_struct |
A list of VuoFileType elements. More... | |
Typedefs | |
typedef struct VuoList_VuoFileType_struct * | VuoList_VuoFileType |
A list of VuoFileType elements. | |
Functions | |
VuoList_VuoFileType | VuoListCreate_VuoFileType (void) |
Creates a new list of VuoFileType elements. | |
VuoList_VuoFileType | VuoListCreateWithCount_VuoFileType (const unsigned long count, const VuoFileType value) |
Creates a new list of count instances of value . | |
VuoList_VuoFileType | VuoListCopy_VuoFileType (const VuoList_VuoFileType list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. | |
VuoFileType | VuoListGetValue_VuoFileType (const VuoList_VuoFileType list, const unsigned long index) |
Returns the VuoFileType at index . | |
VuoFileType * | VuoListGetData_VuoFileType (const VuoList_VuoFileType list) |
Returns a pointer to a C array containing the list items. | |
void | VuoListSetValue_VuoFileType (const VuoList_VuoFileType list, const VuoFileType value, const unsigned long index) |
Changes the VuoFileType at index . | |
void | VuoListInsertValue_VuoFileType (const VuoList_VuoFileType list, const VuoFileType value, const unsigned long index) |
Inserts the VuoFileType immediately before index . | |
void | VuoListPrependValue_VuoFileType (VuoList_VuoFileType list, const VuoFileType value) |
Prepends value to list . | |
void | VuoListAppendValue_VuoFileType (VuoList_VuoFileType list, const VuoFileType value) |
Appends value to list . | |
void | VuoListExchangeValues_VuoFileType (VuoList_VuoFileType list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . | |
void | VuoListShuffle_VuoFileType (VuoList_VuoFileType list, const double chaos) |
Generates a random permutation of list . | |
void | VuoListReverse_VuoFileType (VuoList_VuoFileType list) |
Reverses the order of the items in list . | |
void | VuoListCut_VuoFileType (VuoList_VuoFileType list, const signed long startIndex, const unsigned long itemCount) |
Removes items from the list except those in the range specified by startIndex and itemCount . | |
void | VuoListRemoveFirstValue_VuoFileType (VuoList_VuoFileType list) |
Removes the first value from list . | |
void | VuoListRemoveLastValue_VuoFileType (VuoList_VuoFileType list) |
Removes the last value from list . | |
void | VuoListRemoveAll_VuoFileType (VuoList_VuoFileType list) |
Removes all values from list . | |
void | VuoListRemoveValue_VuoFileType (VuoList_VuoFileType list, const unsigned long index) |
Removes the VuoFileType at index . | |
unsigned long | VuoListGetCount_VuoFileType (const VuoList_VuoFileType list) |
Returns the number of elements in list . | |
VuoList_VuoFileType | VuoList_VuoFileType_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. | |
struct json_object * | VuoList_VuoFileType_getJson (const VuoList_VuoFileType value) |
Encodes value as a JSON object. | |
char * | VuoList_VuoFileType_getSummary (const VuoList_VuoFileType value) |
Produces a brief human-readable summary of value . | |
VuoList_VuoFileType | VuoList_VuoFileType_makeFromString (const char *str) |
Automatically generated function. | |
char * | VuoList_VuoFileType_getString (const VuoList_VuoFileType value) |
Automatically generated function. | |
typedef struct VuoList_VuoFileType_struct * VuoList_VuoFileType |
A list of VuoFileType elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoFileType_getString | ( | const VuoList_VuoFileType | value | ) |
Automatically generated function.
char* VuoList_VuoFileType_getSummary | ( | const VuoList_VuoFileType | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoFileType VuoList_VuoFileType_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoFileType VuoList_VuoFileType_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoFileType | ( | VuoList_VuoFileType | list, |
const VuoFileType | value | ||
) |
Appends value
to list
.
VuoList_VuoFileType VuoListCopy_VuoFileType | ( | const VuoList_VuoFileType | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoFileType VuoListCreate_VuoFileType | ( | void | ) |
Creates a new list of VuoFileType elements.
VuoList_VuoFileType VuoListCreateWithCount_VuoFileType | ( | const unsigned long | count, |
const VuoFileType | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoFileType to quickly initialize a large list.
void VuoListCut_VuoFileType | ( | VuoList_VuoFileType | list, |
const signed long | startIndex, | ||
const unsigned long | itemCount | ||
) |
Removes items from the list except those in the range specified by startIndex
and itemCount
.
void VuoListExchangeValues_VuoFileType | ( | VuoList_VuoFileType | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoFileType | ( | const VuoList_VuoFileType | list | ) |
Returns the number of elements in list
.
VuoFileType* VuoListGetData_VuoFileType | ( | const VuoList_VuoFileType | 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.
VuoFileType VuoListGetValue_VuoFileType | ( | const VuoList_VuoFileType | list, |
const unsigned long | index | ||
) |
Returns the VuoFileType 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_VuoFileType | ( | const VuoList_VuoFileType | list, |
const VuoFileType | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoFileType
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_VuoFileType | ( | VuoList_VuoFileType | list, |
const VuoFileType | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoFileType | ( | VuoList_VuoFileType | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoFileType | ( | VuoList_VuoFileType | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoFileType | ( | VuoList_VuoFileType | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoFileType | ( | VuoList_VuoFileType | list, |
const unsigned long | index | ||
) |
Removes the VuoFileType
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_VuoFileType | ( | VuoList_VuoFileType | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoFileType | ( | const VuoList_VuoFileType | list, |
const VuoFileType | value, | ||
const unsigned long | index | ||
) |
Changes the VuoFileType at index
.
Index values start at 1. 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).
void VuoListShuffle_VuoFileType | ( | VuoList_VuoFileType | 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.