Vuo  1.2.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoKey

Description

A list of VuoKey elements.

Classes

struct  VuoList_VuoKey_struct
 A list of VuoKey elements. More...
 

Typedefs

typedef struct
VuoList_VuoKey_struct
VuoList_VuoKey
 A list of VuoKey elements.
 

Functions

VuoList_VuoKey VuoListCreate_VuoKey (void)
 Creates a new list of VuoKey elements.
 
VuoList_VuoKey VuoListCreateWithCount_VuoKey (const unsigned long count, const VuoKey value)
 Creates a new list of count instances of value.
 
VuoList_VuoKey VuoListCopy_VuoKey (const VuoList_VuoKey list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoKey VuoListGetValue_VuoKey (const VuoList_VuoKey list, const unsigned long index)
 Returns the VuoKey at index.
 
VuoKeyVuoListGetData_VuoKey (const VuoList_VuoKey list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoKey (const VuoList_VuoKey list, const VuoKey value, const unsigned long index)
 Changes the VuoKey at index.
 
void VuoListInsertValue_VuoKey (const VuoList_VuoKey list, const VuoKey value, const unsigned long index)
 Inserts the VuoKey immediately before index.
 
void VuoListPrependValue_VuoKey (VuoList_VuoKey list, const VuoKey value)
 Prepends value to list.
 
void VuoListAppendValue_VuoKey (VuoList_VuoKey list, const VuoKey value)
 Appends value to list.
 
void VuoListExchangeValues_VuoKey (VuoList_VuoKey list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoKey (VuoList_VuoKey list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoKey (VuoList_VuoKey list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoKey (VuoList_VuoKey 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_VuoKey (VuoList_VuoKey list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoKey (VuoList_VuoKey list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoKey (VuoList_VuoKey list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoKey (VuoList_VuoKey list, const unsigned long index)
 Removes the VuoKey at index.
 
unsigned long VuoListGetCount_VuoKey (const VuoList_VuoKey list)
 Returns the number of elements in list.
 
VuoList_VuoKey VuoList_VuoKey_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoKey_getJson (const VuoList_VuoKey value)
 Encodes value as a JSON object.
 
char * VuoList_VuoKey_getSummary (const VuoList_VuoKey value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoKey VuoList_VuoKey_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoKey_getString (const VuoList_VuoKey value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoKey_struct
Class Members
void * l

Typedef Documentation

A list of VuoKey elements.

Function Documentation

struct json_object* VuoList_VuoKey_getJson ( const VuoList_VuoKey  value)
read

Encodes value as a JSON object.

char* VuoList_VuoKey_getString ( const VuoList_VuoKey  value)

Automatically generated function.

char* VuoList_VuoKey_getSummary ( const VuoList_VuoKey  value)

Produces a brief human-readable summary of value.

VuoList_VuoKey VuoList_VuoKey_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoKey ( VuoList_VuoKey  list,
const VuoKey  value 
)

Appends value to list.

VuoList_VuoKey VuoListCopy_VuoKey ( const VuoList_VuoKey  list)

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

VuoList_VuoKey VuoListCreate_VuoKey ( void  )

Creates a new list of VuoKey elements.

VuoList_VuoKey VuoListCreateWithCount_VuoKey ( const unsigned long  count,
const VuoKey  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoKey ( VuoList_VuoKey  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_VuoKey ( VuoList_VuoKey  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoKey ( const VuoList_VuoKey  list)

Returns the number of elements in list.

VuoKey* VuoListGetData_VuoKey ( const VuoList_VuoKey  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.

VuoKey VuoListGetValue_VuoKey ( const VuoList_VuoKey  list,
const unsigned long  index 
)

Returns the VuoKey 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_VuoKey ( const VuoList_VuoKey  list,
const VuoKey  value,
const unsigned long  index 
)

Inserts the VuoKey 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_VuoKey ( VuoList_VuoKey  list,
const VuoKey  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoKey ( VuoList_VuoKey  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoKey ( VuoList_VuoKey  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoKey ( VuoList_VuoKey  list)

Removes the last value from list.

void VuoListRemoveValue_VuoKey ( VuoList_VuoKey  list,
const unsigned long  index 
)

Removes the VuoKey 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_VuoKey ( VuoList_VuoKey  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoKey ( const VuoList_VuoKey  list,
const VuoKey  value,
const unsigned long  index 
)

Changes the VuoKey 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_VuoKey ( VuoList_VuoKey  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.