Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoCoordinateUnit

Description

A list of VuoCoordinateUnit elements.

Classes

struct  VuoList_VuoCoordinateUnit_struct
 A list of VuoCoordinateUnit elements. More...
 

Typedefs

typedef const struct VuoList_VuoCoordinateUnit_structVuoList_VuoCoordinateUnit
 A list of VuoCoordinateUnit elements. More...
 

Functions

VuoList_VuoCoordinateUnit VuoListCreate_VuoCoordinateUnit (void)
 Creates a new list of VuoCoordinateUnit elements. More...
 
VuoList_VuoCoordinateUnit VuoListCreateWithCount_VuoCoordinateUnit (const unsigned long count, const VuoCoordinateUnit value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoCoordinateUnit VuoListCopy_VuoCoordinateUnit (const VuoList_VuoCoordinateUnit list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoCoordinateUnit VuoListGetValue_VuoCoordinateUnit (const VuoList_VuoCoordinateUnit list, const unsigned long index)
 Returns the VuoCoordinateUnit at index. More...
 
VuoCoordinateUnitVuoListGetData_VuoCoordinateUnit (const VuoList_VuoCoordinateUnit list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoCoordinateUnit (const VuoList_VuoCoordinateUnit list, bool(^function)(const VuoCoordinateUnit value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoCoordinateUnit (const VuoList_VuoCoordinateUnit list, const VuoCoordinateUnit value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoCoordinateUnit at index. More...
 
void VuoListInsertValue_VuoCoordinateUnit (const VuoList_VuoCoordinateUnit list, const VuoCoordinateUnit value, const unsigned long index)
 Inserts the VuoCoordinateUnit immediately before index. More...
 
void VuoListPrependValue_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list, const VuoCoordinateUnit value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list, const VuoCoordinateUnit value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list)
 Reverses the order of the items in list. More...
 
VuoList_VuoCoordinateUnit VuoListSubset_VuoCoordinateUnit (VuoList_VuoCoordinateUnit 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_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoCoordinateUnit (VuoList_VuoCoordinateUnit list, const unsigned long index)
 Removes the VuoCoordinateUnit at index. More...
 
unsigned long VuoListGetCount_VuoCoordinateUnit (const VuoList_VuoCoordinateUnit list)
 Returns the number of elements in list. More...
 
VuoList_VuoCoordinateUnit VuoList_VuoCoordinateUnit_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoCoordinateUnit_getJson (const VuoList_VuoCoordinateUnit value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoCoordinateUnit_getSummary (const VuoList_VuoCoordinateUnit value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoCoordinateUnit VuoList_VuoCoordinateUnit_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoCoordinateUnit_getString (const VuoList_VuoCoordinateUnit value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoCoordinateUnit_struct

struct VuoList_VuoCoordinateUnit_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoCoordinateUnit

A list of VuoCoordinateUnit elements.

Function Documentation

◆ VuoList_VuoCoordinateUnit_getJson()

struct json_object* VuoList_VuoCoordinateUnit_getJson ( const VuoList_VuoCoordinateUnit  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoList_VuoCoordinateUnit_getString()

char* VuoList_VuoCoordinateUnit_getString ( const VuoList_VuoCoordinateUnit  value)

Automatically generated function.

◆ VuoList_VuoCoordinateUnit_getSummary()

char* VuoList_VuoCoordinateUnit_getSummary ( const VuoList_VuoCoordinateUnit  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoList_VuoCoordinateUnit_makeFromJson()

VuoList_VuoCoordinateUnit VuoList_VuoCoordinateUnit_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]

Definition at line 63 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoList_VuoCoordinateUnit_makeFromString()

VuoList_VuoCoordinateUnit VuoList_VuoCoordinateUnit_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoCoordinateUnit()

void VuoListAppendValue_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  list,
const VuoCoordinateUnit  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListCopy_VuoCoordinateUnit()

VuoList_VuoCoordinateUnit VuoListCopy_VuoCoordinateUnit ( const VuoList_VuoCoordinateUnit  list)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

Definition at line 174 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListCreate_VuoCoordinateUnit()

VuoList_VuoCoordinateUnit VuoListCreate_VuoCoordinateUnit ( void  )

Creates a new list of VuoCoordinateUnit elements.

Definition at line 154 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListCreateWithCount_VuoCoordinateUnit()

VuoList_VuoCoordinateUnit VuoListCreateWithCount_VuoCoordinateUnit ( const unsigned long  count,
const VuoCoordinateUnit  value 
)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoCoordinateUnit to quickly initialize a large list.

Definition at line 161 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListExchangeValues_VuoCoordinateUnit()

void VuoListExchangeValues_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  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_VuoCoordinateUnit.cc.

◆ VuoListForeach_VuoCoordinateUnit()

void VuoListForeach_VuoCoordinateUnit ( const VuoList_VuoCoordinateUnit  list,
bool(^)(const VuoCoordinateUnit 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).

Changed in Vuo 2.0.0:
New.

Definition at line 229 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListGetCount_VuoCoordinateUnit()

unsigned long VuoListGetCount_VuoCoordinateUnit ( const VuoList_VuoCoordinateUnit  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListGetData_VuoCoordinateUnit()

VuoCoordinateUnit* VuoListGetData_VuoCoordinateUnit ( const VuoList_VuoCoordinateUnit  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_VuoCoordinateUnit.cc.

◆ VuoListGetValue_VuoCoordinateUnit()

VuoCoordinateUnit VuoListGetValue_VuoCoordinateUnit ( const VuoList_VuoCoordinateUnit  list,
const unsigned long  index 
)

Returns the VuoCoordinateUnit 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_VuoCoordinateUnit or VuoListForeach_VuoCoordinateUnit.

Definition at line 203 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListInsertValue_VuoCoordinateUnit()

void VuoListInsertValue_VuoCoordinateUnit ( const VuoList_VuoCoordinateUnit  list,
const VuoCoordinateUnit  value,
const unsigned long  index 
)

Inserts the VuoCoordinateUnit 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_VuoCoordinateUnit.cc.

◆ VuoListPrependValue_VuoCoordinateUnit()

void VuoListPrependValue_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  list,
const VuoCoordinateUnit  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListRemoveAll_VuoCoordinateUnit()

void VuoListRemoveAll_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListRemoveFirstValue_VuoCoordinateUnit()

void VuoListRemoveFirstValue_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListRemoveLastValue_VuoCoordinateUnit()

void VuoListRemoveLastValue_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListRemoveValue_VuoCoordinateUnit()

void VuoListRemoveValue_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  list,
const unsigned long  index 
)

Removes the VuoCoordinateUnit 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_VuoCoordinateUnit.cc.

◆ VuoListReverse_VuoCoordinateUnit()

void VuoListReverse_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoCoordinateUnit.cc.

◆ VuoListSetValue_VuoCoordinateUnit()

void VuoListSetValue_VuoCoordinateUnit ( const VuoList_VuoCoordinateUnit  list,
const VuoCoordinateUnit  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoCoordinateUnit 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_VuoCoordinateUnit.cc.

◆ VuoListShuffle_VuoCoordinateUnit()

void VuoListShuffle_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  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_VuoCoordinateUnit.cc.

◆ VuoListSubset_VuoCoordinateUnit()

VuoList_VuoCoordinateUnit VuoListSubset_VuoCoordinateUnit ( VuoList_VuoCoordinateUnit  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_VuoCoordinateUnit.cc.