Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoAnchor

Description

A list of VuoAnchor elements.

Classes

struct  VuoList_VuoAnchor_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoAnchor_structVuoList_VuoAnchor
 A list of VuoAnchor elements. More...
 

Functions

VuoList_VuoAnchor VuoListCreate_VuoAnchor (void)
 Creates a new list of VuoAnchor elements. More...
 
VuoList_VuoAnchor VuoListCreateWithCount_VuoAnchor (const unsigned long count, const VuoAnchor value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoAnchor VuoListCopy_VuoAnchor (const VuoList_VuoAnchor list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoAnchor VuoListGetValue_VuoAnchor (const VuoList_VuoAnchor list, const unsigned long index)
 Returns the VuoAnchor at index. More...
 
VuoAnchorVuoListGetData_VuoAnchor (const VuoList_VuoAnchor list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoAnchor (const VuoList_VuoAnchor list, bool(^function)(const VuoAnchor value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoAnchor (const VuoList_VuoAnchor list, const VuoAnchor value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoAnchor at index. More...
 
void VuoListInsertValue_VuoAnchor (const VuoList_VuoAnchor list, const VuoAnchor value, const unsigned long index)
 Inserts the VuoAnchor immediately before index. More...
 
void VuoListPrependValue_VuoAnchor (VuoList_VuoAnchor list, const VuoAnchor value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoAnchor (VuoList_VuoAnchor list, const VuoAnchor value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoAnchor (VuoList_VuoAnchor list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoAnchor (VuoList_VuoAnchor list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoAnchor (VuoList_VuoAnchor list)
 Reverses the order of the items in list. More...
 
VuoList_VuoAnchor VuoListSubset_VuoAnchor (VuoList_VuoAnchor 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_VuoAnchor (VuoList_VuoAnchor list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoAnchor (VuoList_VuoAnchor list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoAnchor (VuoList_VuoAnchor list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoAnchor (VuoList_VuoAnchor list, const unsigned long index)
 Removes the VuoAnchor at index. More...
 
unsigned long VuoListGetCount_VuoAnchor (const VuoList_VuoAnchor list)
 Returns the number of elements in list. More...
 
VuoList_VuoAnchor VuoList_VuoAnchor_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoAnchor_getJson (const VuoList_VuoAnchor value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoAnchor_getSummary (const VuoList_VuoAnchor value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoAnchor VuoList_VuoAnchor_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoAnchor_getString (const VuoList_VuoAnchor value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoAnchor_struct

struct VuoList_VuoAnchor_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoAnchor

A list of VuoAnchor elements.

Function Documentation

◆ VuoList_VuoAnchor_getJson()

struct json_object* VuoList_VuoAnchor_getJson ( const VuoList_VuoAnchor  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoAnchor.cc.

◆ VuoList_VuoAnchor_getString()

char* VuoList_VuoAnchor_getString ( const VuoList_VuoAnchor  value)

Automatically generated function.

◆ VuoList_VuoAnchor_getSummary()

char* VuoList_VuoAnchor_getSummary ( const VuoList_VuoAnchor  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoAnchor.cc.

◆ VuoList_VuoAnchor_makeFromJson()

VuoList_VuoAnchor VuoList_VuoAnchor_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_VuoAnchor.cc.

◆ VuoList_VuoAnchor_makeFromString()

VuoList_VuoAnchor VuoList_VuoAnchor_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoAnchor()

void VuoListAppendValue_VuoAnchor ( VuoList_VuoAnchor  list,
const VuoAnchor  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoAnchor.cc.

◆ VuoListCopy_VuoAnchor()

VuoList_VuoAnchor VuoListCopy_VuoAnchor ( const VuoList_VuoAnchor  list)

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

Definition at line 174 of file VuoList_VuoAnchor.cc.

◆ VuoListCreate_VuoAnchor()

VuoList_VuoAnchor VuoListCreate_VuoAnchor ( void  )

Creates a new list of VuoAnchor elements.

Definition at line 154 of file VuoList_VuoAnchor.cc.

◆ VuoListCreateWithCount_VuoAnchor()

VuoList_VuoAnchor VuoListCreateWithCount_VuoAnchor ( const unsigned long  count,
const VuoAnchor  value 
)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoAnchor.cc.

◆ VuoListExchangeValues_VuoAnchor()

void VuoListExchangeValues_VuoAnchor ( VuoList_VuoAnchor  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_VuoAnchor.cc.

◆ VuoListForeach_VuoAnchor()

void VuoListForeach_VuoAnchor ( const VuoList_VuoAnchor  list,
bool(^)(const VuoAnchor 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_VuoAnchor.cc.

◆ VuoListGetCount_VuoAnchor()

unsigned long VuoListGetCount_VuoAnchor ( const VuoList_VuoAnchor  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoAnchor.cc.

◆ VuoListGetData_VuoAnchor()

VuoAnchor* VuoListGetData_VuoAnchor ( const VuoList_VuoAnchor  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_VuoAnchor.cc.

◆ VuoListGetValue_VuoAnchor()

VuoAnchor VuoListGetValue_VuoAnchor ( const VuoList_VuoAnchor  list,
const unsigned long  index 
)

Returns the VuoAnchor 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_VuoAnchor or VuoListForeach_VuoAnchor.

Definition at line 203 of file VuoList_VuoAnchor.cc.

◆ VuoListInsertValue_VuoAnchor()

void VuoListInsertValue_VuoAnchor ( const VuoList_VuoAnchor  list,
const VuoAnchor  value,
const unsigned long  index 
)

Inserts the VuoAnchor 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_VuoAnchor.cc.

◆ VuoListPrependValue_VuoAnchor()

void VuoListPrependValue_VuoAnchor ( VuoList_VuoAnchor  list,
const VuoAnchor  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoAnchor.cc.

◆ VuoListRemoveAll_VuoAnchor()

void VuoListRemoveAll_VuoAnchor ( VuoList_VuoAnchor  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoAnchor.cc.

◆ VuoListRemoveFirstValue_VuoAnchor()

void VuoListRemoveFirstValue_VuoAnchor ( VuoList_VuoAnchor  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoAnchor.cc.

◆ VuoListRemoveLastValue_VuoAnchor()

void VuoListRemoveLastValue_VuoAnchor ( VuoList_VuoAnchor  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoAnchor.cc.

◆ VuoListRemoveValue_VuoAnchor()

void VuoListRemoveValue_VuoAnchor ( VuoList_VuoAnchor  list,
const unsigned long  index 
)

Removes the VuoAnchor 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_VuoAnchor.cc.

◆ VuoListReverse_VuoAnchor()

void VuoListReverse_VuoAnchor ( VuoList_VuoAnchor  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoAnchor.cc.

◆ VuoListSetValue_VuoAnchor()

void VuoListSetValue_VuoAnchor ( const VuoList_VuoAnchor  list,
const VuoAnchor  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoAnchor 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_VuoAnchor.cc.

◆ VuoListShuffle_VuoAnchor()

void VuoListShuffle_VuoAnchor ( VuoList_VuoAnchor  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_VuoAnchor.cc.

◆ VuoListSubset_VuoAnchor()

VuoList_VuoAnchor VuoListSubset_VuoAnchor ( VuoList_VuoAnchor  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_VuoAnchor.cc.