Vuo  1.1.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoData

Description

A list of VuoData elements.

Classes

struct  VuoList_VuoData_struct
 A list of VuoData elements. More...
 

Typedefs

typedef struct
VuoList_VuoData_struct
VuoList_VuoData
 A list of VuoData elements.
 

Functions

VuoList_VuoData VuoListCreate_VuoData (void)
 Creates a new list of VuoData elements.
 
VuoList_VuoData VuoListCopy_VuoData (const VuoList_VuoData list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoData VuoListGetValue_VuoData (const VuoList_VuoData list, const unsigned long index)
 Returns the VuoData at index.
 
void VuoListSetValue_VuoData (const VuoList_VuoData list, const VuoData value, const unsigned long index)
 Changes the VuoData at index.
 
void VuoListInsertValue_VuoData (const VuoList_VuoData list, const VuoData value, const unsigned long index)
 Inserts the VuoData immediately before index.
 
void VuoListPrependValue_VuoData (VuoList_VuoData list, const VuoData value)
 Prepends value to list.
 
void VuoListAppendValue_VuoData (VuoList_VuoData list, const VuoData value)
 Appends value to list.
 
void VuoListExchangeValues_VuoData (VuoList_VuoData list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoData (VuoList_VuoData list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoData (VuoList_VuoData list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoData (VuoList_VuoData list, const signed long startIndex, const unsigned long itemCount)
 Removes items from the list except those in the range specified by startIndex and itemCount.
 
void VuoListRemoveFirstValue_VuoData (VuoList_VuoData list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoData (VuoList_VuoData list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoData (VuoList_VuoData list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoData (VuoList_VuoData list, const unsigned long index)
 Removes the VuoData at index.
 
unsigned long VuoListGetCount_VuoData (const VuoList_VuoData list)
 Returns the number of elements in list.
 
VuoList_VuoData VuoList_VuoData_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoData_getJson (const VuoList_VuoData value)
 Encodes value as a JSON object.
 
char * VuoList_VuoData_getSummary (const VuoList_VuoData value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoData VuoList_VuoData_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoData_getString (const VuoList_VuoData value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoData_struct
Class Members
void * l

Typedef Documentation

A list of VuoData elements.

Function Documentation

struct json_object* VuoList_VuoData_getJson ( const VuoList_VuoData  value)
read

Encodes value as a JSON object.

char* VuoList_VuoData_getString ( const VuoList_VuoData  value)

Automatically generated function.

char* VuoList_VuoData_getSummary ( const VuoList_VuoData  value)

Produces a brief human-readable summary of value.

VuoList_VuoData VuoList_VuoData_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]
VuoList_VuoData VuoList_VuoData_makeFromString ( const char *  str)

Automatically generated function.

void VuoListAppendValue_VuoData ( VuoList_VuoData  list,
const VuoData  value 
)

Appends value to list.

VuoList_VuoData VuoListCopy_VuoData ( const VuoList_VuoData  list)

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

VuoList_VuoData VuoListCreate_VuoData ( void  )

Creates a new list of VuoData elements.

void VuoListCut_VuoData ( VuoList_VuoData  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Removes items from the list except those in the range specified by startIndex and itemCount.

void VuoListExchangeValues_VuoData ( VuoList_VuoData  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoData ( const VuoList_VuoData  list)

Returns the number of elements in list.

VuoData VuoListGetValue_VuoData ( const VuoList_VuoData  list,
const unsigned long  index 
)

Returns the VuoData 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_VuoData ( const VuoList_VuoData  list,
const VuoData  value,
const unsigned long  index 
)

Inserts the VuoData 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_VuoData ( VuoList_VuoData  list,
const VuoData  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoData ( VuoList_VuoData  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoData ( VuoList_VuoData  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoData ( VuoList_VuoData  list)

Removes the last value from list.

void VuoListRemoveValue_VuoData ( VuoList_VuoData  list,
const unsigned long  index 
)

Removes the VuoData 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_VuoData ( VuoList_VuoData  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoData ( const VuoList_VuoData  list,
const VuoData  value,
const unsigned long  index 
)

Changes the VuoData at index.

Index values start at 1. 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).

void VuoListShuffle_VuoData ( VuoList_VuoData  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.