Vuo
2.1.1
|
A list of VuoParity elements.
Classes | |
struct | VuoList_VuoParity_struct |
A list of VuoParity elements. More... | |
Typedefs | |
typedef const struct VuoList_VuoParity_struct * | VuoList_VuoParity |
A list of VuoParity elements. More... | |
Functions | |
VuoList_VuoParity | VuoListCreate_VuoParity (void) |
Creates a new list of VuoParity elements. More... | |
VuoList_VuoParity | VuoListCreateWithCount_VuoParity (const unsigned long count, const VuoParity value) |
Creates a new list of count instances of value . More... | |
VuoList_VuoParity | VuoListCopy_VuoParity (const VuoList_VuoParity list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. More... | |
VuoParity | VuoListGetValue_VuoParity (const VuoList_VuoParity list, const unsigned long index) |
Returns the VuoParity at index . More... | |
VuoParity * | VuoListGetData_VuoParity (const VuoList_VuoParity list) |
Returns a pointer to a C array containing the list items. More... | |
void | VuoListForeach_VuoParity (const VuoList_VuoParity list, bool(^function)(const VuoParity value)) |
Applies function to each of list 's items, serially in order of index. More... | |
void | VuoListSetValue_VuoParity (const VuoList_VuoParity list, const VuoParity value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoParity at index . More... | |
void | VuoListInsertValue_VuoParity (const VuoList_VuoParity list, const VuoParity value, const unsigned long index) |
Inserts the VuoParity immediately before index . More... | |
void | VuoListPrependValue_VuoParity (VuoList_VuoParity list, const VuoParity value) |
Prepends value to list . More... | |
void | VuoListAppendValue_VuoParity (VuoList_VuoParity list, const VuoParity value) |
Appends value to list . More... | |
void | VuoListExchangeValues_VuoParity (VuoList_VuoParity list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . More... | |
void | VuoListShuffle_VuoParity (VuoList_VuoParity list, const double chaos) |
Generates a random permutation of list . More... | |
void | VuoListReverse_VuoParity (VuoList_VuoParity list) |
Reverses the order of the items in list . More... | |
VuoList_VuoParity | VuoListSubset_VuoParity (VuoList_VuoParity 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_VuoParity (VuoList_VuoParity list) |
Removes the first value from list . More... | |
void | VuoListRemoveLastValue_VuoParity (VuoList_VuoParity list) |
Removes the last value from list . More... | |
void | VuoListRemoveAll_VuoParity (VuoList_VuoParity list) |
Removes all values from list . More... | |
void | VuoListRemoveValue_VuoParity (VuoList_VuoParity list, const unsigned long index) |
Removes the VuoParity at index . More... | |
unsigned long | VuoListGetCount_VuoParity (const VuoList_VuoParity list) |
Returns the number of elements in list . More... | |
VuoList_VuoParity | VuoList_VuoParity_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoList_VuoParity_getJson (const VuoList_VuoParity value) |
Encodes value as a JSON object. More... | |
char * | VuoList_VuoParity_getSummary (const VuoList_VuoParity value) |
Produces a brief human-readable summary of value . More... | |
VuoList_VuoParity | VuoList_VuoParity_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoList_VuoParity_getString (const VuoList_VuoParity value) |
Automatically generated function. More... | |
typedef const struct VuoList_VuoParity_struct * VuoList_VuoParity |
A list of VuoParity elements.
struct json_object* VuoList_VuoParity_getJson | ( | const VuoList_VuoParity | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoParity.cc.
char* VuoList_VuoParity_getString | ( | const VuoList_VuoParity | value | ) |
Automatically generated function.
char* VuoList_VuoParity_getSummary | ( | const VuoList_VuoParity | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 119 of file VuoList_VuoParity.cc.
VuoList_VuoParity VuoList_VuoParity_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoParity.cc.
VuoList_VuoParity VuoList_VuoParity_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoParity | ( | VuoList_VuoParity | list, |
const VuoParity | value | ||
) |
Appends value
to list
.
Definition at line 308 of file VuoList_VuoParity.cc.
VuoList_VuoParity VuoListCopy_VuoParity | ( | const VuoList_VuoParity | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 174 of file VuoList_VuoParity.cc.
VuoList_VuoParity VuoListCreate_VuoParity | ( | void | ) |
Creates a new list of VuoParity elements.
Definition at line 154 of file VuoList_VuoParity.cc.
VuoList_VuoParity VuoListCreateWithCount_VuoParity | ( | const unsigned long | count, |
const VuoParity | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoParity to quickly initialize a large list.
Definition at line 161 of file VuoList_VuoParity.cc.
void VuoListExchangeValues_VuoParity | ( | VuoList_VuoParity | 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_VuoParity.cc.
void VuoListForeach_VuoParity | ( | const VuoList_VuoParity | list, |
bool(^)(const VuoParity 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_VuoParity.cc.
unsigned long VuoListGetCount_VuoParity | ( | const VuoList_VuoParity | list | ) |
Returns the number of elements in list
.
Definition at line 553 of file VuoList_VuoParity.cc.
VuoParity* VuoListGetData_VuoParity | ( | const VuoList_VuoParity | 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_VuoParity.cc.
VuoParity VuoListGetValue_VuoParity | ( | const VuoList_VuoParity | list, |
const unsigned long | index | ||
) |
Returns the VuoParity 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_VuoParity or VuoListForeach_VuoParity.
Definition at line 203 of file VuoList_VuoParity.cc.
void VuoListInsertValue_VuoParity | ( | const VuoList_VuoParity | list, |
const VuoParity | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoParity
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_VuoParity.cc.
void VuoListPrependValue_VuoParity | ( | VuoList_VuoParity | list, |
const VuoParity | value | ||
) |
Prepends value
to list
.
Definition at line 298 of file VuoList_VuoParity.cc.
void VuoListRemoveAll_VuoParity | ( | VuoList_VuoParity | list | ) |
Removes all values from list
.
Definition at line 527 of file VuoList_VuoParity.cc.
void VuoListRemoveFirstValue_VuoParity | ( | VuoList_VuoParity | list | ) |
Removes the first value from list
.
Definition at line 499 of file VuoList_VuoParity.cc.
void VuoListRemoveLastValue_VuoParity | ( | VuoList_VuoParity | list | ) |
Removes the last value from list
.
Definition at line 513 of file VuoList_VuoParity.cc.
void VuoListRemoveValue_VuoParity | ( | VuoList_VuoParity | list, |
const unsigned long | index | ||
) |
Removes the VuoParity
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_VuoParity.cc.
void VuoListReverse_VuoParity | ( | VuoList_VuoParity | list | ) |
Reverses the order of the items in list
.
Definition at line 422 of file VuoList_VuoParity.cc.
void VuoListSetValue_VuoParity | ( | const VuoList_VuoParity | list, |
const VuoParity | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoParity 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_VuoParity.cc.
void VuoListShuffle_VuoParity | ( | VuoList_VuoParity | 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_VuoParity.cc.
VuoList_VuoParity VuoListSubset_VuoParity | ( | VuoList_VuoParity | 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_VuoParity.cc.