Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoCurve

Description

A list of VuoCurve elements.

Classes

struct  VuoList_VuoCurve_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoCurve_structVuoList_VuoCurve
 A list of VuoCurve elements. More...
 

Functions

VuoList_VuoCurve VuoListCreate_VuoCurve (void)
 Creates a new list of VuoCurve elements. More...
 
VuoList_VuoCurve VuoListCreateWithCount_VuoCurve (const unsigned long count, const VuoCurve value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoCurve VuoListCopy_VuoCurve (const VuoList_VuoCurve list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoCurve VuoListGetValue_VuoCurve (const VuoList_VuoCurve list, const unsigned long index)
 Returns the VuoCurve at index. More...
 
VuoCurveVuoListGetData_VuoCurve (const VuoList_VuoCurve list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoCurve (const VuoList_VuoCurve list, bool(^function)(const VuoCurve value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoCurve (const VuoList_VuoCurve list, const VuoCurve value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoCurve at index. More...
 
void VuoListInsertValue_VuoCurve (const VuoList_VuoCurve list, const VuoCurve value, const unsigned long index)
 Inserts the VuoCurve immediately before index. More...
 
void VuoListPrependValue_VuoCurve (VuoList_VuoCurve list, const VuoCurve value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoCurve (VuoList_VuoCurve list, const VuoCurve value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoCurve (VuoList_VuoCurve list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoCurve (VuoList_VuoCurve list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoCurve (VuoList_VuoCurve list)
 Reverses the order of the items in list. More...
 
VuoList_VuoCurve VuoListSubset_VuoCurve (VuoList_VuoCurve 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_VuoCurve (VuoList_VuoCurve list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoCurve (VuoList_VuoCurve list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoCurve (VuoList_VuoCurve list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoCurve (VuoList_VuoCurve list, const unsigned long index)
 Removes the VuoCurve at index. More...
 
unsigned long VuoListGetCount_VuoCurve (const VuoList_VuoCurve list)
 Returns the number of elements in list. More...
 
VuoList_VuoCurve VuoList_VuoCurve_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoCurve_getJson (const VuoList_VuoCurve value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoCurve_getSummary (const VuoList_VuoCurve value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoCurve VuoList_VuoCurve_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoCurve_getString (const VuoList_VuoCurve value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoCurve_struct

struct VuoList_VuoCurve_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoCurve

typedef const struct VuoList_VuoCurve_struct * VuoList_VuoCurve

A list of VuoCurve elements.

Function Documentation

◆ VuoList_VuoCurve_getJson()

struct json_object* VuoList_VuoCurve_getJson ( const VuoList_VuoCurve  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoCurve.cc.

◆ VuoList_VuoCurve_getString()

char* VuoList_VuoCurve_getString ( const VuoList_VuoCurve  value)

Automatically generated function.

◆ VuoList_VuoCurve_getSummary()

char* VuoList_VuoCurve_getSummary ( const VuoList_VuoCurve  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoCurve.cc.

◆ VuoList_VuoCurve_makeFromJson()

VuoList_VuoCurve VuoList_VuoCurve_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_VuoCurve.cc.

◆ VuoList_VuoCurve_makeFromString()

VuoList_VuoCurve VuoList_VuoCurve_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoCurve()

void VuoListAppendValue_VuoCurve ( VuoList_VuoCurve  list,
const VuoCurve  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoCurve.cc.

◆ VuoListCopy_VuoCurve()

VuoList_VuoCurve VuoListCopy_VuoCurve ( const VuoList_VuoCurve  list)

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

Definition at line 174 of file VuoList_VuoCurve.cc.

◆ VuoListCreate_VuoCurve()

VuoList_VuoCurve VuoListCreate_VuoCurve ( void  )

Creates a new list of VuoCurve elements.

Definition at line 154 of file VuoList_VuoCurve.cc.

◆ VuoListCreateWithCount_VuoCurve()

VuoList_VuoCurve VuoListCreateWithCount_VuoCurve ( const unsigned long  count,
const VuoCurve  value 
)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoCurve.cc.

◆ VuoListExchangeValues_VuoCurve()

void VuoListExchangeValues_VuoCurve ( VuoList_VuoCurve  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_VuoCurve.cc.

◆ VuoListForeach_VuoCurve()

void VuoListForeach_VuoCurve ( const VuoList_VuoCurve  list,
bool(^)(const VuoCurve 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_VuoCurve.cc.

◆ VuoListGetCount_VuoCurve()

unsigned long VuoListGetCount_VuoCurve ( const VuoList_VuoCurve  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoCurve.cc.

◆ VuoListGetData_VuoCurve()

VuoCurve* VuoListGetData_VuoCurve ( const VuoList_VuoCurve  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_VuoCurve.cc.

◆ VuoListGetValue_VuoCurve()

VuoCurve VuoListGetValue_VuoCurve ( const VuoList_VuoCurve  list,
const unsigned long  index 
)

Returns the VuoCurve 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_VuoCurve or VuoListForeach_VuoCurve.

Definition at line 203 of file VuoList_VuoCurve.cc.

◆ VuoListInsertValue_VuoCurve()

void VuoListInsertValue_VuoCurve ( const VuoList_VuoCurve  list,
const VuoCurve  value,
const unsigned long  index 
)

Inserts the VuoCurve 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_VuoCurve.cc.

◆ VuoListPrependValue_VuoCurve()

void VuoListPrependValue_VuoCurve ( VuoList_VuoCurve  list,
const VuoCurve  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoCurve.cc.

◆ VuoListRemoveAll_VuoCurve()

void VuoListRemoveAll_VuoCurve ( VuoList_VuoCurve  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoCurve.cc.

◆ VuoListRemoveFirstValue_VuoCurve()

void VuoListRemoveFirstValue_VuoCurve ( VuoList_VuoCurve  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoCurve.cc.

◆ VuoListRemoveLastValue_VuoCurve()

void VuoListRemoveLastValue_VuoCurve ( VuoList_VuoCurve  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoCurve.cc.

◆ VuoListRemoveValue_VuoCurve()

void VuoListRemoveValue_VuoCurve ( VuoList_VuoCurve  list,
const unsigned long  index 
)

Removes the VuoCurve 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_VuoCurve.cc.

◆ VuoListReverse_VuoCurve()

void VuoListReverse_VuoCurve ( VuoList_VuoCurve  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoCurve.cc.

◆ VuoListSetValue_VuoCurve()

void VuoListSetValue_VuoCurve ( const VuoList_VuoCurve  list,
const VuoCurve  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoCurve 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_VuoCurve.cc.

◆ VuoListShuffle_VuoCurve()

void VuoListShuffle_VuoCurve ( VuoList_VuoCurve  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_VuoCurve.cc.

◆ VuoListSubset_VuoCurve()

VuoList_VuoCurve VuoListSubset_VuoCurve ( VuoList_VuoCurve  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_VuoCurve.cc.