Vuo
2.4.1
|
A list of VuoOrientation elements.
Classes | |
struct | VuoList_VuoOrientation_struct |
List type. More... | |
Typedefs | |
typedef const struct VuoList_VuoOrientation_struct * | VuoList_VuoOrientation |
A list of VuoOrientation elements. More... | |
Functions | |
VuoList_VuoOrientation | VuoListCreate_VuoOrientation (void) |
Creates a new list of VuoOrientation elements. More... | |
VuoList_VuoOrientation | VuoListCreateWithCount_VuoOrientation (const unsigned long count, const VuoOrientation value) |
Creates a new list of count instances of value . More... | |
VuoList_VuoOrientation | VuoListCreateWithValueArray_VuoOrientation (const VuoOrientation *values, const unsigned long valueCount) |
Creates a new list containing the items in the C array values . More... | |
VuoList_VuoOrientation | VuoListCopy_VuoOrientation (const VuoList_VuoOrientation list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. More... | |
static unsigned long | VuoListIndexToCArrayIndex (long index, unsigned long listCount) __attribute__((const)) |
Converts a Vuo-style [1..n] list index into a C-style [0..n-1] list index. More... | |
VuoOrientation | VuoListGetValue_VuoOrientation (const VuoList_VuoOrientation list, const unsigned long index) |
Returns the VuoOrientation at index . More... | |
VuoOrientation * | VuoListGetData_VuoOrientation (const VuoList_VuoOrientation list) |
Returns a pointer to a C array containing the list items. More... | |
void | VuoListForeach_VuoOrientation (const VuoList_VuoOrientation list, bool(^function)(const VuoOrientation value)) |
Applies function to each of list 's items, serially in order of index. More... | |
void | VuoListSetValue_VuoOrientation (const VuoList_VuoOrientation list, const VuoOrientation value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoOrientation at index . More... | |
void | VuoListInsertValue_VuoOrientation (const VuoList_VuoOrientation list, const VuoOrientation value, const unsigned long index) |
Inserts the VuoOrientation immediately before index . More... | |
void | VuoListPrependValue_VuoOrientation (VuoList_VuoOrientation list, const VuoOrientation value) |
Prepends value to list . More... | |
void | VuoListAppendValue_VuoOrientation (VuoList_VuoOrientation list, const VuoOrientation value) |
Appends value to list . More... | |
void | VuoListExchangeValues_VuoOrientation (VuoList_VuoOrientation list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . More... | |
void | VuoListShuffle_VuoOrientation (VuoList_VuoOrientation list, const double chaos) |
Generates a random permutation of list . More... | |
void | VuoListReverse_VuoOrientation (VuoList_VuoOrientation list) |
Reverses the order of the items in list . More... | |
VuoList_VuoOrientation | VuoListSubset_VuoOrientation (VuoList_VuoOrientation 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_VuoOrientation (VuoList_VuoOrientation list) |
Removes the first value from list . More... | |
void | VuoListRemoveLastValue_VuoOrientation (VuoList_VuoOrientation list) |
Removes the last value from list . More... | |
void | VuoListRemoveAll_VuoOrientation (VuoList_VuoOrientation list) |
Removes all values from list . More... | |
void | VuoListRemoveValue_VuoOrientation (VuoList_VuoOrientation list, const unsigned long index) |
Removes the VuoOrientation at index . More... | |
unsigned long | VuoListGetCount_VuoOrientation (const VuoList_VuoOrientation list) |
Returns the number of elements in list . More... | |
VuoList_VuoOrientation | VuoList_VuoOrientation_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoList_VuoOrientation_getJson (const VuoList_VuoOrientation value) |
Encodes value as a JSON object. More... | |
char * | VuoList_VuoOrientation_getSummary (const VuoList_VuoOrientation value) |
Produces a brief human-readable summary of value . More... | |
void | VuoList_VuoOrientation_retain (VuoList_VuoOrientation value) |
Retains the list. More... | |
void | VuoList_VuoOrientation_release (VuoList_VuoOrientation value) |
Releases the list. More... | |
char * | VuoList_VuoOrientation_getString (const VuoList_VuoOrientation value) |
Automatically generated function. More... | |
#define VUO_LIST_INDEX_TO_C_ARRAY_INDEX |
Definition at line 63 of file VuoList_VuoOrientation.h.
typedef const struct VuoList_VuoOrientation_struct * VuoList_VuoOrientation |
A list of VuoOrientation elements.
struct json_object * VuoList_VuoOrientation_getJson | ( | const VuoList_VuoOrientation | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoOrientation.cc.
char * VuoList_VuoOrientation_getString | ( | const VuoList_VuoOrientation | value | ) |
Automatically generated function.
char * VuoList_VuoOrientation_getSummary | ( | const VuoList_VuoOrientation | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 119 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoList_VuoOrientation_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoOrientation.cc.
void VuoList_VuoOrientation_release | ( | VuoList_VuoOrientation | value | ) |
Releases the list.
This function is provided for use in polymorphism; it just calls VuoRelease()
.
Definition at line 580 of file VuoList_VuoOrientation.cc.
void VuoList_VuoOrientation_retain | ( | VuoList_VuoOrientation | value | ) |
Retains the list.
This function is provided for use in polymorphism; it just calls VuoRetain()
.
Definition at line 575 of file VuoList_VuoOrientation.cc.
void VuoListAppendValue_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const VuoOrientation | value | ||
) |
Appends value
to list
.
Definition at line 321 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListCopy_VuoOrientation | ( | const VuoList_VuoOrientation | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 187 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListCreate_VuoOrientation | ( | void | ) |
Creates a new list of VuoOrientation elements.
Definition at line 154 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListCreateWithCount_VuoOrientation | ( | const unsigned long | count, |
const VuoOrientation | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoOrientation to quickly initialize a large list.
Definition at line 161 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListCreateWithValueArray_VuoOrientation | ( | const VuoOrientation * | values, |
const unsigned long | valueCount | ||
) |
Creates a new list containing the items in the C array values
.
The list retains each item in values
.
The caller may discard values
after this function returns.
Definition at line 174 of file VuoList_VuoOrientation.cc.
void VuoListExchangeValues_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
Definition at line 331 of file VuoList_VuoOrientation.cc.
void VuoListForeach_VuoOrientation | ( | const VuoList_VuoOrientation | list, |
bool(^)(const VuoOrientation 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 242 of file VuoList_VuoOrientation.cc.
unsigned long VuoListGetCount_VuoOrientation | ( | const VuoList_VuoOrientation | list | ) |
Returns the number of elements in list
.
Definition at line 566 of file VuoList_VuoOrientation.cc.
VuoOrientation * VuoListGetData_VuoOrientation | ( | const VuoList_VuoOrientation | 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 232 of file VuoList_VuoOrientation.cc.
VuoOrientation VuoListGetValue_VuoOrientation | ( | const VuoList_VuoOrientation | list, |
const unsigned long | index | ||
) |
Returns the VuoOrientation 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_VuoOrientation or VuoListForeach_VuoOrientation.
Definition at line 216 of file VuoList_VuoOrientation.cc.
|
inlinestatic |
Converts a Vuo-style [1..n]
list index into a C-style [0..n-1]
list index.
If the index is less than 1, or larger than the size of the list, the returned index is clamped.
Definition at line 70 of file VuoList_VuoOrientation.h.
void VuoListInsertValue_VuoOrientation | ( | const VuoList_VuoOrientation | list, |
const VuoOrientation | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoOrientation
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 289 of file VuoList_VuoOrientation.cc.
void VuoListPrependValue_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const VuoOrientation | value | ||
) |
Prepends value
to list
.
Definition at line 311 of file VuoList_VuoOrientation.cc.
void VuoListRemoveAll_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Removes all values from list
.
Definition at line 540 of file VuoList_VuoOrientation.cc.
void VuoListRemoveFirstValue_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Removes the first value from list
.
Definition at line 512 of file VuoList_VuoOrientation.cc.
void VuoListRemoveLastValue_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Removes the last value from list
.
Definition at line 526 of file VuoList_VuoOrientation.cc.
void VuoListRemoveValue_VuoOrientation | ( | VuoList_VuoOrientation | list, |
const unsigned long | index | ||
) |
Removes the VuoOrientation
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 549 of file VuoList_VuoOrientation.cc.
void VuoListReverse_VuoOrientation | ( | VuoList_VuoOrientation | list | ) |
Reverses the order of the items in list
.
Definition at line 435 of file VuoList_VuoOrientation.cc.
void VuoListSetValue_VuoOrientation | ( | const VuoList_VuoOrientation | list, |
const VuoOrientation | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoOrientation 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 254 of file VuoList_VuoOrientation.cc.
void VuoListShuffle_VuoOrientation | ( | VuoList_VuoOrientation | 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 414 of file VuoList_VuoOrientation.cc.
VuoList_VuoOrientation VuoListSubset_VuoOrientation | ( | VuoList_VuoOrientation | 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 444 of file VuoList_VuoOrientation.cc.