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

Description

A list of VuoDisplacement elements.

Classes

struct  VuoList_VuoDisplacement_struct
 A list of VuoDisplacement elements. More...
 

Typedefs

typedef struct
VuoList_VuoDisplacement_struct
VuoList_VuoDisplacement
 A list of VuoDisplacement elements.
 

Functions

VuoList_VuoDisplacement VuoListCreate_VuoDisplacement (void)
 Creates a new list of VuoDisplacement elements.
 
VuoList_VuoDisplacement VuoListCreateWithCount_VuoDisplacement (const unsigned long count, const VuoDisplacement value)
 Creates a new list of count instances of value.
 
VuoList_VuoDisplacement VuoListCopy_VuoDisplacement (const VuoList_VuoDisplacement list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoDisplacement VuoListGetValue_VuoDisplacement (const VuoList_VuoDisplacement list, const unsigned long index)
 Returns the VuoDisplacement at index.
 
VuoDisplacementVuoListGetData_VuoDisplacement (const VuoList_VuoDisplacement list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoDisplacement (const VuoList_VuoDisplacement list, const VuoDisplacement value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoDisplacement at index.
 
void VuoListInsertValue_VuoDisplacement (const VuoList_VuoDisplacement list, const VuoDisplacement value, const unsigned long index)
 Inserts the VuoDisplacement immediately before index.
 
void VuoListPrependValue_VuoDisplacement (VuoList_VuoDisplacement list, const VuoDisplacement value)
 Prepends value to list.
 
void VuoListAppendValue_VuoDisplacement (VuoList_VuoDisplacement list, const VuoDisplacement value)
 Appends value to list.
 
void VuoListExchangeValues_VuoDisplacement (VuoList_VuoDisplacement list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoDisplacement (VuoList_VuoDisplacement list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoDisplacement (VuoList_VuoDisplacement list)
 Reverses the order of the items in list.
 
VuoList_VuoDisplacement VuoListSubset_VuoDisplacement (VuoList_VuoDisplacement 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.
 
void VuoListRemoveFirstValue_VuoDisplacement (VuoList_VuoDisplacement list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoDisplacement (VuoList_VuoDisplacement list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoDisplacement (VuoList_VuoDisplacement list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoDisplacement (VuoList_VuoDisplacement list, const unsigned long index)
 Removes the VuoDisplacement at index.
 
unsigned long VuoListGetCount_VuoDisplacement (const VuoList_VuoDisplacement list)
 Returns the number of elements in list.
 
VuoList_VuoDisplacement VuoList_VuoDisplacement_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoDisplacement_getJson (const VuoList_VuoDisplacement value)
 Encodes value as a JSON object.
 
char * VuoList_VuoDisplacement_getSummary (const VuoList_VuoDisplacement value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoDisplacement VuoList_VuoDisplacement_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoDisplacement_getString (const VuoList_VuoDisplacement value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoDisplacement_struct
Class Members
void * l

Typedef Documentation

A list of VuoDisplacement elements.

Function Documentation

struct json_object* VuoList_VuoDisplacement_getJson ( const VuoList_VuoDisplacement  value)
read

Encodes value as a JSON object.

char* VuoList_VuoDisplacement_getString ( const VuoList_VuoDisplacement  value)

Automatically generated function.

char* VuoList_VuoDisplacement_getSummary ( const VuoList_VuoDisplacement  value)

Produces a brief human-readable summary of value.

VuoList_VuoDisplacement VuoList_VuoDisplacement_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoDisplacement ( VuoList_VuoDisplacement  list,
const VuoDisplacement  value 
)

Appends value to list.

VuoList_VuoDisplacement VuoListCopy_VuoDisplacement ( const VuoList_VuoDisplacement  list)

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

VuoList_VuoDisplacement VuoListCreate_VuoDisplacement ( void  )

Creates a new list of VuoDisplacement elements.

VuoList_VuoDisplacement VuoListCreateWithCount_VuoDisplacement ( const unsigned long  count,
const VuoDisplacement  value 
)

Creates a new list of count instances of value.

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

void VuoListExchangeValues_VuoDisplacement ( VuoList_VuoDisplacement  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoDisplacement ( const VuoList_VuoDisplacement  list)

Returns the number of elements in list.

VuoDisplacement* VuoListGetData_VuoDisplacement ( const VuoList_VuoDisplacement  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.

VuoDisplacement VuoListGetValue_VuoDisplacement ( const VuoList_VuoDisplacement  list,
const unsigned long  index 
)

Returns the VuoDisplacement 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_VuoDisplacement ( const VuoList_VuoDisplacement  list,
const VuoDisplacement  value,
const unsigned long  index 
)

Inserts the VuoDisplacement 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_VuoDisplacement ( VuoList_VuoDisplacement  list,
const VuoDisplacement  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoDisplacement ( VuoList_VuoDisplacement  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoDisplacement ( VuoList_VuoDisplacement  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoDisplacement ( VuoList_VuoDisplacement  list)

Removes the last value from list.

void VuoListRemoveValue_VuoDisplacement ( VuoList_VuoDisplacement  list,
const unsigned long  index 
)

Removes the VuoDisplacement 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_VuoDisplacement ( VuoList_VuoDisplacement  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoDisplacement ( const VuoList_VuoDisplacement  list,
const VuoDisplacement  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoDisplacement 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.

void VuoListShuffle_VuoDisplacement ( VuoList_VuoDisplacement  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.

VuoList_VuoDisplacement VuoListSubset_VuoDisplacement ( VuoList_VuoDisplacement  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.