Vuo  1.0.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoInteger

Description

A list of VuoInteger elements.

Classes

struct  VuoList_VuoInteger_struct
 A list of VuoInteger elements. More...
 

Typedefs

typedef struct
VuoList_VuoInteger_struct
VuoList_VuoInteger
 A list of VuoInteger elements.
 

Functions

VuoList_VuoInteger VuoListCreate_VuoInteger (void)
 Creates a new list of VuoInteger elements.
 
VuoList_VuoInteger VuoListCopy_VuoInteger (const VuoList_VuoInteger list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoInteger VuoListGetValue_VuoInteger (const VuoList_VuoInteger list, const unsigned long index)
 Returns the VuoInteger at index.
 
void VuoListSetValue_VuoInteger (const VuoList_VuoInteger list, const VuoInteger value, const unsigned long index)
 Changes the VuoInteger at index.
 
void VuoListInsertValue_VuoInteger (const VuoList_VuoInteger list, const VuoInteger value, const unsigned long index)
 Inserts the VuoInteger immediately before index.
 
void VuoListPrependValue_VuoInteger (VuoList_VuoInteger list, const VuoInteger value)
 Prepends value to list.
 
void VuoListAppendValue_VuoInteger (VuoList_VuoInteger list, const VuoInteger value)
 Appends value to list.
 
void VuoListExchangeValues_VuoInteger (VuoList_VuoInteger list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoInteger (VuoList_VuoInteger list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoInteger (VuoList_VuoInteger list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoInteger (VuoList_VuoInteger 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_VuoInteger (VuoList_VuoInteger list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoInteger (VuoList_VuoInteger list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoInteger (VuoList_VuoInteger list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoInteger (VuoList_VuoInteger list, const unsigned long index)
 Removes the VuoInteger at index.
 
unsigned long VuoListGetCount_VuoInteger (const VuoList_VuoInteger list)
 Returns the number of elements in list.
 
VuoList_VuoInteger VuoList_VuoInteger_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_object * VuoList_VuoInteger_getJson (const VuoList_VuoInteger value)
 Encodes value as a JSON object.
 
char * VuoList_VuoInteger_getSummary (const VuoList_VuoInteger value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoInteger VuoList_VuoInteger_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoInteger_getString (const VuoList_VuoInteger value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoInteger_struct
Class Members
void * l

Typedef Documentation

A list of VuoInteger elements.

Function Documentation

struct json_object* VuoList_VuoInteger_getJson ( const VuoList_VuoInteger  value)
read

Encodes value as a JSON object.

char* VuoList_VuoInteger_getString ( const VuoList_VuoInteger  value)

Automatically generated function.

char* VuoList_VuoInteger_getSummary ( const VuoList_VuoInteger  value)

Produces a brief human-readable summary of value.

VuoList_VuoInteger VuoList_VuoInteger_makeFromJson ( struct json_object *  js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoInteger ( VuoList_VuoInteger  list,
const VuoInteger  value 
)

Appends value to list.

VuoList_VuoInteger VuoListCopy_VuoInteger ( const VuoList_VuoInteger  list)

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

VuoList_VuoInteger VuoListCreate_VuoInteger ( void  )

Creates a new list of VuoInteger elements.

void VuoListCut_VuoInteger ( VuoList_VuoInteger  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_VuoInteger ( VuoList_VuoInteger  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoInteger ( const VuoList_VuoInteger  list)

Returns the number of elements in list.

VuoInteger VuoListGetValue_VuoInteger ( const VuoList_VuoInteger  list,
const unsigned long  index 
)

Returns the VuoInteger 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_VuoInteger ( const VuoList_VuoInteger  list,
const VuoInteger  value,
const unsigned long  index 
)

Inserts the VuoInteger 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_VuoInteger ( VuoList_VuoInteger  list,
const VuoInteger  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoInteger ( VuoList_VuoInteger  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoInteger ( VuoList_VuoInteger  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoInteger ( VuoList_VuoInteger  list)

Removes the last value from list.

void VuoListRemoveValue_VuoInteger ( VuoList_VuoInteger  list,
const unsigned long  index 
)

Removes the VuoInteger 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_VuoInteger ( VuoList_VuoInteger  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoInteger ( const VuoList_VuoInteger  list,
const VuoInteger  value,
const unsigned long  index 
)

Changes the VuoInteger 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_VuoInteger ( VuoList_VuoInteger  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.