Vuo
1.2.6
|
A list of VuoDistribution3d elements.
Classes | |
struct | VuoList_VuoDistribution3d_struct |
A list of VuoDistribution3d elements. More... | |
Typedefs | |
typedef struct VuoList_VuoDistribution3d_struct * | VuoList_VuoDistribution3d |
A list of VuoDistribution3d elements. | |
Functions | |
VuoList_VuoDistribution3d | VuoListCreate_VuoDistribution3d (void) |
Creates a new list of VuoDistribution3d elements. | |
VuoList_VuoDistribution3d | VuoListCreateWithCount_VuoDistribution3d (const unsigned long count, const VuoDistribution3d value) |
Creates a new list of count instances of value . | |
VuoList_VuoDistribution3d | VuoListCopy_VuoDistribution3d (const VuoList_VuoDistribution3d list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. | |
VuoDistribution3d | VuoListGetValue_VuoDistribution3d (const VuoList_VuoDistribution3d list, const unsigned long index) |
Returns the VuoDistribution3d at index . | |
VuoDistribution3d * | VuoListGetData_VuoDistribution3d (const VuoList_VuoDistribution3d list) |
Returns a pointer to a C array containing the list items. | |
void | VuoListSetValue_VuoDistribution3d (const VuoList_VuoDistribution3d list, const VuoDistribution3d value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoDistribution3d at index . | |
void | VuoListInsertValue_VuoDistribution3d (const VuoList_VuoDistribution3d list, const VuoDistribution3d value, const unsigned long index) |
Inserts the VuoDistribution3d immediately before index . | |
void | VuoListPrependValue_VuoDistribution3d (VuoList_VuoDistribution3d list, const VuoDistribution3d value) |
Prepends value to list . | |
void | VuoListAppendValue_VuoDistribution3d (VuoList_VuoDistribution3d list, const VuoDistribution3d value) |
Appends value to list . | |
void | VuoListExchangeValues_VuoDistribution3d (VuoList_VuoDistribution3d list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . | |
void | VuoListShuffle_VuoDistribution3d (VuoList_VuoDistribution3d list, const double chaos) |
Generates a random permutation of list . | |
void | VuoListReverse_VuoDistribution3d (VuoList_VuoDistribution3d list) |
Reverses the order of the items in list . | |
VuoList_VuoDistribution3d | VuoListSubset_VuoDistribution3d (VuoList_VuoDistribution3d 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_VuoDistribution3d (VuoList_VuoDistribution3d list) |
Removes the first value from list . | |
void | VuoListRemoveLastValue_VuoDistribution3d (VuoList_VuoDistribution3d list) |
Removes the last value from list . | |
void | VuoListRemoveAll_VuoDistribution3d (VuoList_VuoDistribution3d list) |
Removes all values from list . | |
void | VuoListRemoveValue_VuoDistribution3d (VuoList_VuoDistribution3d list, const unsigned long index) |
Removes the VuoDistribution3d at index . | |
unsigned long | VuoListGetCount_VuoDistribution3d (const VuoList_VuoDistribution3d list) |
Returns the number of elements in list . | |
VuoList_VuoDistribution3d | VuoList_VuoDistribution3d_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. | |
struct json_object * | VuoList_VuoDistribution3d_getJson (const VuoList_VuoDistribution3d value) |
Encodes value as a JSON object. | |
char * | VuoList_VuoDistribution3d_getSummary (const VuoList_VuoDistribution3d value) |
Produces a brief human-readable summary of value . | |
VuoList_VuoDistribution3d | VuoList_VuoDistribution3d_makeFromString (const char *str) |
Automatically generated function. | |
char * | VuoList_VuoDistribution3d_getString (const VuoList_VuoDistribution3d value) |
Automatically generated function. | |
typedef struct VuoList_VuoDistribution3d_struct * VuoList_VuoDistribution3d |
A list of VuoDistribution3d elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoDistribution3d_getString | ( | const VuoList_VuoDistribution3d | value | ) |
Automatically generated function.
char* VuoList_VuoDistribution3d_getSummary | ( | const VuoList_VuoDistribution3d | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoDistribution3d VuoList_VuoDistribution3d_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoDistribution3d VuoList_VuoDistribution3d_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list, |
const VuoDistribution3d | value | ||
) |
Appends value
to list
.
VuoList_VuoDistribution3d VuoListCopy_VuoDistribution3d | ( | const VuoList_VuoDistribution3d | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoDistribution3d VuoListCreate_VuoDistribution3d | ( | void | ) |
Creates a new list of VuoDistribution3d elements.
VuoList_VuoDistribution3d VuoListCreateWithCount_VuoDistribution3d | ( | const unsigned long | count, |
const VuoDistribution3d | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoDistribution3d to quickly initialize a large list.
void VuoListExchangeValues_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoDistribution3d | ( | const VuoList_VuoDistribution3d | list | ) |
Returns the number of elements in list
.
VuoDistribution3d* VuoListGetData_VuoDistribution3d | ( | const VuoList_VuoDistribution3d | 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.
VuoDistribution3d VuoListGetValue_VuoDistribution3d | ( | const VuoList_VuoDistribution3d | list, |
const unsigned long | index | ||
) |
Returns the VuoDistribution3d 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_VuoDistribution3d | ( | const VuoList_VuoDistribution3d | list, |
const VuoDistribution3d | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoDistribution3d
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_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list, |
const VuoDistribution3d | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list, |
const unsigned long | index | ||
) |
Removes the VuoDistribution3d
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_VuoDistribution3d | ( | VuoList_VuoDistribution3d | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoDistribution3d | ( | const VuoList_VuoDistribution3d | list, |
const VuoDistribution3d | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoDistribution3d 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_VuoDistribution3d | ( | VuoList_VuoDistribution3d | 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_VuoDistribution3d VuoListSubset_VuoDistribution3d | ( | VuoList_VuoDistribution3d | 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.