Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoImageNoise

Description

A list of VuoImageNoise elements.

Classes

struct  VuoList_VuoImageNoise_struct
 A list of VuoImageNoise elements. More...
 

Typedefs

typedef const struct VuoList_VuoImageNoise_structVuoList_VuoImageNoise
 A list of VuoImageNoise elements. More...
 

Functions

VuoList_VuoImageNoise VuoListCreate_VuoImageNoise (void)
 Creates a new list of VuoImageNoise elements. More...
 
VuoList_VuoImageNoise VuoListCreateWithCount_VuoImageNoise (const unsigned long count, const VuoImageNoise value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoImageNoise VuoListCopy_VuoImageNoise (const VuoList_VuoImageNoise list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoImageNoise VuoListGetValue_VuoImageNoise (const VuoList_VuoImageNoise list, const unsigned long index)
 Returns the VuoImageNoise at index. More...
 
VuoImageNoiseVuoListGetData_VuoImageNoise (const VuoList_VuoImageNoise list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoImageNoise (const VuoList_VuoImageNoise list, bool(^function)(const VuoImageNoise value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoImageNoise (const VuoList_VuoImageNoise list, const VuoImageNoise value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoImageNoise at index. More...
 
void VuoListInsertValue_VuoImageNoise (const VuoList_VuoImageNoise list, const VuoImageNoise value, const unsigned long index)
 Inserts the VuoImageNoise immediately before index. More...
 
void VuoListPrependValue_VuoImageNoise (VuoList_VuoImageNoise list, const VuoImageNoise value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoImageNoise (VuoList_VuoImageNoise list, const VuoImageNoise value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoImageNoise (VuoList_VuoImageNoise list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoImageNoise (VuoList_VuoImageNoise list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoImageNoise (VuoList_VuoImageNoise list)
 Reverses the order of the items in list. More...
 
VuoList_VuoImageNoise VuoListSubset_VuoImageNoise (VuoList_VuoImageNoise 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_VuoImageNoise (VuoList_VuoImageNoise list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoImageNoise (VuoList_VuoImageNoise list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoImageNoise (VuoList_VuoImageNoise list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoImageNoise (VuoList_VuoImageNoise list, const unsigned long index)
 Removes the VuoImageNoise at index. More...
 
unsigned long VuoListGetCount_VuoImageNoise (const VuoList_VuoImageNoise list)
 Returns the number of elements in list. More...
 
VuoList_VuoImageNoise VuoList_VuoImageNoise_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoImageNoise_getJson (const VuoList_VuoImageNoise value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoImageNoise_getSummary (const VuoList_VuoImageNoise value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoImageNoise VuoList_VuoImageNoise_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoImageNoise_getString (const VuoList_VuoImageNoise value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoImageNoise_struct

struct VuoList_VuoImageNoise_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoImageNoise

A list of VuoImageNoise elements.

Function Documentation

◆ VuoList_VuoImageNoise_getJson()

struct json_object* VuoList_VuoImageNoise_getJson ( const VuoList_VuoImageNoise  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoImageNoise.cc.

◆ VuoList_VuoImageNoise_getString()

char* VuoList_VuoImageNoise_getString ( const VuoList_VuoImageNoise  value)

Automatically generated function.

◆ VuoList_VuoImageNoise_getSummary()

char* VuoList_VuoImageNoise_getSummary ( const VuoList_VuoImageNoise  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoImageNoise.cc.

◆ VuoList_VuoImageNoise_makeFromJson()

VuoList_VuoImageNoise VuoList_VuoImageNoise_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_VuoImageNoise.cc.

◆ VuoList_VuoImageNoise_makeFromString()

VuoList_VuoImageNoise VuoList_VuoImageNoise_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoImageNoise()

void VuoListAppendValue_VuoImageNoise ( VuoList_VuoImageNoise  list,
const VuoImageNoise  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoImageNoise.cc.

◆ VuoListCopy_VuoImageNoise()

VuoList_VuoImageNoise VuoListCopy_VuoImageNoise ( const VuoList_VuoImageNoise  list)

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

Definition at line 174 of file VuoList_VuoImageNoise.cc.

◆ VuoListCreate_VuoImageNoise()

VuoList_VuoImageNoise VuoListCreate_VuoImageNoise ( void  )

Creates a new list of VuoImageNoise elements.

Definition at line 154 of file VuoList_VuoImageNoise.cc.

◆ VuoListCreateWithCount_VuoImageNoise()

VuoList_VuoImageNoise VuoListCreateWithCount_VuoImageNoise ( const unsigned long  count,
const VuoImageNoise  value 
)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoImageNoise.cc.

◆ VuoListExchangeValues_VuoImageNoise()

void VuoListExchangeValues_VuoImageNoise ( VuoList_VuoImageNoise  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_VuoImageNoise.cc.

◆ VuoListForeach_VuoImageNoise()

void VuoListForeach_VuoImageNoise ( const VuoList_VuoImageNoise  list,
bool(^)(const VuoImageNoise 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_VuoImageNoise.cc.

◆ VuoListGetCount_VuoImageNoise()

unsigned long VuoListGetCount_VuoImageNoise ( const VuoList_VuoImageNoise  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoImageNoise.cc.

◆ VuoListGetData_VuoImageNoise()

VuoImageNoise* VuoListGetData_VuoImageNoise ( const VuoList_VuoImageNoise  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_VuoImageNoise.cc.

◆ VuoListGetValue_VuoImageNoise()

VuoImageNoise VuoListGetValue_VuoImageNoise ( const VuoList_VuoImageNoise  list,
const unsigned long  index 
)

Returns the VuoImageNoise 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_VuoImageNoise or VuoListForeach_VuoImageNoise.

Definition at line 203 of file VuoList_VuoImageNoise.cc.

◆ VuoListInsertValue_VuoImageNoise()

void VuoListInsertValue_VuoImageNoise ( const VuoList_VuoImageNoise  list,
const VuoImageNoise  value,
const unsigned long  index 
)

Inserts the VuoImageNoise 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_VuoImageNoise.cc.

◆ VuoListPrependValue_VuoImageNoise()

void VuoListPrependValue_VuoImageNoise ( VuoList_VuoImageNoise  list,
const VuoImageNoise  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoImageNoise.cc.

◆ VuoListRemoveAll_VuoImageNoise()

void VuoListRemoveAll_VuoImageNoise ( VuoList_VuoImageNoise  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoImageNoise.cc.

◆ VuoListRemoveFirstValue_VuoImageNoise()

void VuoListRemoveFirstValue_VuoImageNoise ( VuoList_VuoImageNoise  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoImageNoise.cc.

◆ VuoListRemoveLastValue_VuoImageNoise()

void VuoListRemoveLastValue_VuoImageNoise ( VuoList_VuoImageNoise  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoImageNoise.cc.

◆ VuoListRemoveValue_VuoImageNoise()

void VuoListRemoveValue_VuoImageNoise ( VuoList_VuoImageNoise  list,
const unsigned long  index 
)

Removes the VuoImageNoise 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_VuoImageNoise.cc.

◆ VuoListReverse_VuoImageNoise()

void VuoListReverse_VuoImageNoise ( VuoList_VuoImageNoise  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoImageNoise.cc.

◆ VuoListSetValue_VuoImageNoise()

void VuoListSetValue_VuoImageNoise ( const VuoList_VuoImageNoise  list,
const VuoImageNoise  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoImageNoise 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_VuoImageNoise.cc.

◆ VuoListShuffle_VuoImageNoise()

void VuoListShuffle_VuoImageNoise ( VuoList_VuoImageNoise  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_VuoImageNoise.cc.

◆ VuoListSubset_VuoImageNoise()

VuoList_VuoImageNoise VuoListSubset_VuoImageNoise ( VuoList_VuoImageNoise  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_VuoImageNoise.cc.