Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoGridType

Description

A list of VuoGridType elements.

Classes

struct  VuoList_VuoGridType_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoGridType_structVuoList_VuoGridType
 A list of VuoGridType elements. More...
 

Functions

VuoList_VuoGridType VuoListCreate_VuoGridType (void)
 Creates a new list of VuoGridType elements. More...
 
VuoList_VuoGridType VuoListCreateWithCount_VuoGridType (const unsigned long count, const VuoGridType value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoGridType VuoListCopy_VuoGridType (const VuoList_VuoGridType list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoGridType VuoListGetValue_VuoGridType (const VuoList_VuoGridType list, const unsigned long index)
 Returns the VuoGridType at index. More...
 
VuoGridTypeVuoListGetData_VuoGridType (const VuoList_VuoGridType list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoGridType (const VuoList_VuoGridType list, bool(^function)(const VuoGridType value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoGridType (const VuoList_VuoGridType list, const VuoGridType value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoGridType at index. More...
 
void VuoListInsertValue_VuoGridType (const VuoList_VuoGridType list, const VuoGridType value, const unsigned long index)
 Inserts the VuoGridType immediately before index. More...
 
void VuoListPrependValue_VuoGridType (VuoList_VuoGridType list, const VuoGridType value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoGridType (VuoList_VuoGridType list, const VuoGridType value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoGridType (VuoList_VuoGridType list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoGridType (VuoList_VuoGridType list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoGridType (VuoList_VuoGridType list)
 Reverses the order of the items in list. More...
 
VuoList_VuoGridType VuoListSubset_VuoGridType (VuoList_VuoGridType 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_VuoGridType (VuoList_VuoGridType list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoGridType (VuoList_VuoGridType list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoGridType (VuoList_VuoGridType list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoGridType (VuoList_VuoGridType list, const unsigned long index)
 Removes the VuoGridType at index. More...
 
unsigned long VuoListGetCount_VuoGridType (const VuoList_VuoGridType list)
 Returns the number of elements in list. More...
 
VuoList_VuoGridType VuoList_VuoGridType_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoGridType_getJson (const VuoList_VuoGridType value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoGridType_getSummary (const VuoList_VuoGridType value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoGridType VuoList_VuoGridType_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoGridType_getString (const VuoList_VuoGridType value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoGridType_struct

struct VuoList_VuoGridType_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoGridType

A list of VuoGridType elements.

Function Documentation

◆ VuoList_VuoGridType_getJson()

struct json_object* VuoList_VuoGridType_getJson ( const VuoList_VuoGridType  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoGridType.cc.

◆ VuoList_VuoGridType_getString()

char* VuoList_VuoGridType_getString ( const VuoList_VuoGridType  value)

Automatically generated function.

◆ VuoList_VuoGridType_getSummary()

char* VuoList_VuoGridType_getSummary ( const VuoList_VuoGridType  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoGridType.cc.

◆ VuoList_VuoGridType_makeFromJson()

VuoList_VuoGridType VuoList_VuoGridType_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_VuoGridType.cc.

◆ VuoList_VuoGridType_makeFromString()

VuoList_VuoGridType VuoList_VuoGridType_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoGridType()

void VuoListAppendValue_VuoGridType ( VuoList_VuoGridType  list,
const VuoGridType  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoGridType.cc.

◆ VuoListCopy_VuoGridType()

VuoList_VuoGridType VuoListCopy_VuoGridType ( const VuoList_VuoGridType  list)

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

Definition at line 174 of file VuoList_VuoGridType.cc.

◆ VuoListCreate_VuoGridType()

VuoList_VuoGridType VuoListCreate_VuoGridType ( void  )

Creates a new list of VuoGridType elements.

Definition at line 154 of file VuoList_VuoGridType.cc.

◆ VuoListCreateWithCount_VuoGridType()

VuoList_VuoGridType VuoListCreateWithCount_VuoGridType ( const unsigned long  count,
const VuoGridType  value 
)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoGridType.cc.

◆ VuoListExchangeValues_VuoGridType()

void VuoListExchangeValues_VuoGridType ( VuoList_VuoGridType  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_VuoGridType.cc.

◆ VuoListForeach_VuoGridType()

void VuoListForeach_VuoGridType ( const VuoList_VuoGridType  list,
bool(^)(const VuoGridType 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_VuoGridType.cc.

◆ VuoListGetCount_VuoGridType()

unsigned long VuoListGetCount_VuoGridType ( const VuoList_VuoGridType  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoGridType.cc.

◆ VuoListGetData_VuoGridType()

VuoGridType* VuoListGetData_VuoGridType ( const VuoList_VuoGridType  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_VuoGridType.cc.

◆ VuoListGetValue_VuoGridType()

VuoGridType VuoListGetValue_VuoGridType ( const VuoList_VuoGridType  list,
const unsigned long  index 
)

Returns the VuoGridType 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_VuoGridType or VuoListForeach_VuoGridType.

Definition at line 203 of file VuoList_VuoGridType.cc.

◆ VuoListInsertValue_VuoGridType()

void VuoListInsertValue_VuoGridType ( const VuoList_VuoGridType  list,
const VuoGridType  value,
const unsigned long  index 
)

Inserts the VuoGridType 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_VuoGridType.cc.

◆ VuoListPrependValue_VuoGridType()

void VuoListPrependValue_VuoGridType ( VuoList_VuoGridType  list,
const VuoGridType  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoGridType.cc.

◆ VuoListRemoveAll_VuoGridType()

void VuoListRemoveAll_VuoGridType ( VuoList_VuoGridType  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoGridType.cc.

◆ VuoListRemoveFirstValue_VuoGridType()

void VuoListRemoveFirstValue_VuoGridType ( VuoList_VuoGridType  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoGridType.cc.

◆ VuoListRemoveLastValue_VuoGridType()

void VuoListRemoveLastValue_VuoGridType ( VuoList_VuoGridType  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoGridType.cc.

◆ VuoListRemoveValue_VuoGridType()

void VuoListRemoveValue_VuoGridType ( VuoList_VuoGridType  list,
const unsigned long  index 
)

Removes the VuoGridType 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_VuoGridType.cc.

◆ VuoListReverse_VuoGridType()

void VuoListReverse_VuoGridType ( VuoList_VuoGridType  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoGridType.cc.

◆ VuoListSetValue_VuoGridType()

void VuoListSetValue_VuoGridType ( const VuoList_VuoGridType  list,
const VuoGridType  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoGridType 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_VuoGridType.cc.

◆ VuoListShuffle_VuoGridType()

void VuoListShuffle_VuoGridType ( VuoList_VuoGridType  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_VuoGridType.cc.

◆ VuoListSubset_VuoGridType()

VuoList_VuoGridType VuoListSubset_VuoGridType ( VuoList_VuoGridType  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_VuoGridType.cc.