Vuo
1.0.1
|
A list of VuoCursor elements.
Classes | |
struct | VuoList_VuoCursor_struct |
A list of VuoCursor elements. More... | |
Typedefs | |
typedef struct VuoList_VuoCursor_struct * | VuoList_VuoCursor |
A list of VuoCursor elements. | |
Functions | |
VuoList_VuoCursor | VuoListCreate_VuoCursor (void) |
Creates a new list of VuoCursor elements. | |
VuoList_VuoCursor | VuoListCopy_VuoCursor (const VuoList_VuoCursor list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. | |
VuoCursor | VuoListGetValue_VuoCursor (const VuoList_VuoCursor list, const unsigned long index) |
Returns the VuoCursor at index . | |
void | VuoListSetValue_VuoCursor (const VuoList_VuoCursor list, const VuoCursor value, const unsigned long index) |
Changes the VuoCursor at index . | |
void | VuoListInsertValue_VuoCursor (const VuoList_VuoCursor list, const VuoCursor value, const unsigned long index) |
Inserts the VuoCursor immediately before index . | |
void | VuoListPrependValue_VuoCursor (VuoList_VuoCursor list, const VuoCursor value) |
Prepends value to list . | |
void | VuoListAppendValue_VuoCursor (VuoList_VuoCursor list, const VuoCursor value) |
Appends value to list . | |
void | VuoListExchangeValues_VuoCursor (VuoList_VuoCursor list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . | |
void | VuoListShuffle_VuoCursor (VuoList_VuoCursor list, const double chaos) |
Generates a random permutation of list . | |
void | VuoListReverse_VuoCursor (VuoList_VuoCursor list) |
Reverses the order of the items in list . | |
void | VuoListCut_VuoCursor (VuoList_VuoCursor 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_VuoCursor (VuoList_VuoCursor list) |
Removes the first value from list . | |
void | VuoListRemoveLastValue_VuoCursor (VuoList_VuoCursor list) |
Removes the last value from list . | |
void | VuoListRemoveAll_VuoCursor (VuoList_VuoCursor list) |
Removes all values from list . | |
void | VuoListRemoveValue_VuoCursor (VuoList_VuoCursor list, const unsigned long index) |
Removes the VuoCursor at index . | |
unsigned long | VuoListGetCount_VuoCursor (const VuoList_VuoCursor list) |
Returns the number of elements in list . | |
VuoList_VuoCursor | VuoList_VuoCursor_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. | |
struct json_object * | VuoList_VuoCursor_getJson (const VuoList_VuoCursor value) |
Encodes value as a JSON object. | |
char * | VuoList_VuoCursor_getSummary (const VuoList_VuoCursor value) |
Produces a brief human-readable summary of value . | |
VuoList_VuoCursor | VuoList_VuoCursor_makeFromString (const char *str) |
Automatically generated function. | |
char * | VuoList_VuoCursor_getString (const VuoList_VuoCursor value) |
Automatically generated function. | |
typedef struct VuoList_VuoCursor_struct * VuoList_VuoCursor |
A list of VuoCursor elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoCursor_getString | ( | const VuoList_VuoCursor | value | ) |
Automatically generated function.
char* VuoList_VuoCursor_getSummary | ( | const VuoList_VuoCursor | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoCursor VuoList_VuoCursor_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoCursor VuoList_VuoCursor_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoCursor | ( | VuoList_VuoCursor | list, |
const VuoCursor | value | ||
) |
Appends value
to list
.
VuoList_VuoCursor VuoListCopy_VuoCursor | ( | const VuoList_VuoCursor | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoCursor VuoListCreate_VuoCursor | ( | void | ) |
Creates a new list of VuoCursor elements.
void VuoListCut_VuoCursor | ( | VuoList_VuoCursor | 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_VuoCursor | ( | VuoList_VuoCursor | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoCursor | ( | const VuoList_VuoCursor | list | ) |
Returns the number of elements in list
.
VuoCursor VuoListGetValue_VuoCursor | ( | const VuoList_VuoCursor | list, |
const unsigned long | index | ||
) |
Returns the VuoCursor 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_VuoCursor | ( | const VuoList_VuoCursor | list, |
const VuoCursor | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoCursor
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_VuoCursor | ( | VuoList_VuoCursor | list, |
const VuoCursor | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoCursor | ( | VuoList_VuoCursor | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoCursor | ( | VuoList_VuoCursor | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoCursor | ( | VuoList_VuoCursor | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoCursor | ( | VuoList_VuoCursor | list, |
const unsigned long | index | ||
) |
Removes the VuoCursor
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_VuoCursor | ( | VuoList_VuoCursor | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoCursor | ( | const VuoList_VuoCursor | list, |
const VuoCursor | value, | ||
const unsigned long | index | ||
) |
Changes the VuoCursor 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_VuoCursor | ( | VuoList_VuoCursor | 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.