Vuo  2.0.0
Classes | Typedefs | Functions
VuoList_VuoThresholdType

Description

A list of VuoThresholdType elements.

Classes

struct  VuoList_VuoThresholdType_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoThresholdType_structVuoList_VuoThresholdType
 A list of VuoThresholdType elements. More...
 

Functions

VuoList_VuoThresholdType VuoListCreate_VuoThresholdType (void)
 Creates a new list of VuoThresholdType elements. More...
 
VuoList_VuoThresholdType VuoListCreateWithCount_VuoThresholdType (const unsigned long count, const VuoThresholdType value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoThresholdType VuoListCopy_VuoThresholdType (const VuoList_VuoThresholdType list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoThresholdType VuoListGetValue_VuoThresholdType (const VuoList_VuoThresholdType list, const unsigned long index)
 Returns the VuoThresholdType at index. More...
 
VuoThresholdTypeVuoListGetData_VuoThresholdType (const VuoList_VuoThresholdType list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoThresholdType (const VuoList_VuoThresholdType list, bool(^function)(const VuoThresholdType value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoThresholdType (const VuoList_VuoThresholdType list, const VuoThresholdType value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoThresholdType at index. More...
 
void VuoListInsertValue_VuoThresholdType (const VuoList_VuoThresholdType list, const VuoThresholdType value, const unsigned long index)
 Inserts the VuoThresholdType immediately before index. More...
 
void VuoListPrependValue_VuoThresholdType (VuoList_VuoThresholdType list, const VuoThresholdType value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoThresholdType (VuoList_VuoThresholdType list, const VuoThresholdType value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoThresholdType (VuoList_VuoThresholdType list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoThresholdType (VuoList_VuoThresholdType list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoThresholdType (VuoList_VuoThresholdType list)
 Reverses the order of the items in list. More...
 
VuoList_VuoThresholdType VuoListSubset_VuoThresholdType (VuoList_VuoThresholdType 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_VuoThresholdType (VuoList_VuoThresholdType list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoThresholdType (VuoList_VuoThresholdType list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoThresholdType (VuoList_VuoThresholdType list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoThresholdType (VuoList_VuoThresholdType list, const unsigned long index)
 Removes the VuoThresholdType at index. More...
 
unsigned long VuoListGetCount_VuoThresholdType (const VuoList_VuoThresholdType list)
 Returns the number of elements in list. More...
 
VuoList_VuoThresholdType VuoList_VuoThresholdType_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoThresholdType_getJson (const VuoList_VuoThresholdType value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoThresholdType_getSummary (const VuoList_VuoThresholdType value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoThresholdType VuoList_VuoThresholdType_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoThresholdType_getString (const VuoList_VuoThresholdType value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoThresholdType_struct

struct VuoList_VuoThresholdType_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoThresholdType

A list of VuoThresholdType elements.

Function Documentation

◆ VuoList_VuoThresholdType_getJson()

struct json_object* VuoList_VuoThresholdType_getJson ( const VuoList_VuoThresholdType  value)

Encodes value as a JSON object.

Definition at line 81 of file VuoList_VuoThresholdType.cc.

◆ VuoList_VuoThresholdType_getString()

char* VuoList_VuoThresholdType_getString ( const VuoList_VuoThresholdType  value)

Automatically generated function.

◆ VuoList_VuoThresholdType_getSummary()

char* VuoList_VuoThresholdType_getSummary ( const VuoList_VuoThresholdType  value)

Produces a brief human-readable summary of value.

Definition at line 113 of file VuoList_VuoThresholdType.cc.

◆ VuoList_VuoThresholdType_makeFromJson()

VuoList_VuoThresholdType VuoList_VuoThresholdType_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_VuoThresholdType.cc.

◆ VuoList_VuoThresholdType_makeFromString()

VuoList_VuoThresholdType VuoList_VuoThresholdType_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoThresholdType()

void VuoListAppendValue_VuoThresholdType ( VuoList_VuoThresholdType  list,
const VuoThresholdType  value 
)

Appends value to list.

Definition at line 305 of file VuoList_VuoThresholdType.cc.

◆ VuoListCopy_VuoThresholdType()

VuoList_VuoThresholdType VuoListCopy_VuoThresholdType ( const VuoList_VuoThresholdType  list)

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

Definition at line 171 of file VuoList_VuoThresholdType.cc.

◆ VuoListCreate_VuoThresholdType()

VuoList_VuoThresholdType VuoListCreate_VuoThresholdType ( void  )

Creates a new list of VuoThresholdType elements.

Definition at line 151 of file VuoList_VuoThresholdType.cc.

◆ VuoListCreateWithCount_VuoThresholdType()

VuoList_VuoThresholdType VuoListCreateWithCount_VuoThresholdType ( const unsigned long  count,
const VuoThresholdType  value 
)

Creates a new list of count instances of value.

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

Definition at line 158 of file VuoList_VuoThresholdType.cc.

◆ VuoListExchangeValues_VuoThresholdType()

void VuoListExchangeValues_VuoThresholdType ( VuoList_VuoThresholdType  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

Definition at line 315 of file VuoList_VuoThresholdType.cc.

◆ VuoListForeach_VuoThresholdType()

void VuoListForeach_VuoThresholdType ( const VuoList_VuoThresholdType  list,
bool(^)(const VuoThresholdType 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 226 of file VuoList_VuoThresholdType.cc.

◆ VuoListGetCount_VuoThresholdType()

unsigned long VuoListGetCount_VuoThresholdType ( const VuoList_VuoThresholdType  list)

Returns the number of elements in list.

Definition at line 550 of file VuoList_VuoThresholdType.cc.

◆ VuoListGetData_VuoThresholdType()

VuoThresholdType* VuoListGetData_VuoThresholdType ( const VuoList_VuoThresholdType  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 216 of file VuoList_VuoThresholdType.cc.

◆ VuoListGetValue_VuoThresholdType()

VuoThresholdType VuoListGetValue_VuoThresholdType ( const VuoList_VuoThresholdType  list,
const unsigned long  index 
)

Returns the VuoThresholdType 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_VuoThresholdType or VuoListForeach_VuoThresholdType.

Definition at line 200 of file VuoList_VuoThresholdType.cc.

◆ VuoListInsertValue_VuoThresholdType()

void VuoListInsertValue_VuoThresholdType ( const VuoList_VuoThresholdType  list,
const VuoThresholdType  value,
const unsigned long  index 
)

Inserts the VuoThresholdType 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 273 of file VuoList_VuoThresholdType.cc.

◆ VuoListPrependValue_VuoThresholdType()

void VuoListPrependValue_VuoThresholdType ( VuoList_VuoThresholdType  list,
const VuoThresholdType  value 
)

Prepends value to list.

Definition at line 295 of file VuoList_VuoThresholdType.cc.

◆ VuoListRemoveAll_VuoThresholdType()

void VuoListRemoveAll_VuoThresholdType ( VuoList_VuoThresholdType  list)

Removes all values from list.

Definition at line 524 of file VuoList_VuoThresholdType.cc.

◆ VuoListRemoveFirstValue_VuoThresholdType()

void VuoListRemoveFirstValue_VuoThresholdType ( VuoList_VuoThresholdType  list)

Removes the first value from list.

Definition at line 496 of file VuoList_VuoThresholdType.cc.

◆ VuoListRemoveLastValue_VuoThresholdType()

void VuoListRemoveLastValue_VuoThresholdType ( VuoList_VuoThresholdType  list)

Removes the last value from list.

Definition at line 510 of file VuoList_VuoThresholdType.cc.

◆ VuoListRemoveValue_VuoThresholdType()

void VuoListRemoveValue_VuoThresholdType ( VuoList_VuoThresholdType  list,
const unsigned long  index 
)

Removes the VuoThresholdType 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 533 of file VuoList_VuoThresholdType.cc.

◆ VuoListReverse_VuoThresholdType()

void VuoListReverse_VuoThresholdType ( VuoList_VuoThresholdType  list)

Reverses the order of the items in list.

Definition at line 419 of file VuoList_VuoThresholdType.cc.

◆ VuoListSetValue_VuoThresholdType()

void VuoListSetValue_VuoThresholdType ( const VuoList_VuoThresholdType  list,
const VuoThresholdType  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoThresholdType 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 238 of file VuoList_VuoThresholdType.cc.

◆ VuoListShuffle_VuoThresholdType()

void VuoListShuffle_VuoThresholdType ( VuoList_VuoThresholdType  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 398 of file VuoList_VuoThresholdType.cc.

◆ VuoListSubset_VuoThresholdType()

VuoList_VuoThresholdType VuoListSubset_VuoThresholdType ( VuoList_VuoThresholdType  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 428 of file VuoList_VuoThresholdType.cc.