Vuo  2.0.2
Classes | Typedefs | Functions
VuoList_VuoTextSort

Description

A list of VuoTextSort elements.

Classes

struct  VuoList_VuoTextSort_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoTextSort_structVuoList_VuoTextSort
 A list of VuoTextSort elements. More...
 

Functions

VuoList_VuoTextSort VuoListCreate_VuoTextSort (void)
 Creates a new list of VuoTextSort elements. More...
 
VuoList_VuoTextSort VuoListCreateWithCount_VuoTextSort (const unsigned long count, const VuoTextSort value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoTextSort VuoListCopy_VuoTextSort (const VuoList_VuoTextSort list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoTextSort VuoListGetValue_VuoTextSort (const VuoList_VuoTextSort list, const unsigned long index)
 Returns the VuoTextSort at index. More...
 
VuoTextSortVuoListGetData_VuoTextSort (const VuoList_VuoTextSort list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoTextSort (const VuoList_VuoTextSort list, bool(^function)(const VuoTextSort value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoTextSort (const VuoList_VuoTextSort list, const VuoTextSort value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoTextSort at index. More...
 
void VuoListInsertValue_VuoTextSort (const VuoList_VuoTextSort list, const VuoTextSort value, const unsigned long index)
 Inserts the VuoTextSort immediately before index. More...
 
void VuoListPrependValue_VuoTextSort (VuoList_VuoTextSort list, const VuoTextSort value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoTextSort (VuoList_VuoTextSort list, const VuoTextSort value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoTextSort (VuoList_VuoTextSort list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoTextSort (VuoList_VuoTextSort list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoTextSort (VuoList_VuoTextSort list)
 Reverses the order of the items in list. More...
 
VuoList_VuoTextSort VuoListSubset_VuoTextSort (VuoList_VuoTextSort 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_VuoTextSort (VuoList_VuoTextSort list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoTextSort (VuoList_VuoTextSort list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoTextSort (VuoList_VuoTextSort list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoTextSort (VuoList_VuoTextSort list, const unsigned long index)
 Removes the VuoTextSort at index. More...
 
unsigned long VuoListGetCount_VuoTextSort (const VuoList_VuoTextSort list)
 Returns the number of elements in list. More...
 
VuoList_VuoTextSort VuoList_VuoTextSort_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoTextSort_getJson (const VuoList_VuoTextSort value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoTextSort_getSummary (const VuoList_VuoTextSort value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoTextSort VuoList_VuoTextSort_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoTextSort_getString (const VuoList_VuoTextSort value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoTextSort_struct

struct VuoList_VuoTextSort_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoTextSort

A list of VuoTextSort elements.

Function Documentation

◆ VuoList_VuoTextSort_getJson()

struct json_object* VuoList_VuoTextSort_getJson ( const VuoList_VuoTextSort  value)

Encodes value as a JSON object.

Definition at line 81 of file VuoList_VuoTextSort.cc.

◆ VuoList_VuoTextSort_getString()

char* VuoList_VuoTextSort_getString ( const VuoList_VuoTextSort  value)

Automatically generated function.

◆ VuoList_VuoTextSort_getSummary()

char* VuoList_VuoTextSort_getSummary ( const VuoList_VuoTextSort  value)

Produces a brief human-readable summary of value.

Definition at line 113 of file VuoList_VuoTextSort.cc.

◆ VuoList_VuoTextSort_makeFromJson()

VuoList_VuoTextSort VuoList_VuoTextSort_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_VuoTextSort.cc.

◆ VuoList_VuoTextSort_makeFromString()

VuoList_VuoTextSort VuoList_VuoTextSort_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoTextSort()

void VuoListAppendValue_VuoTextSort ( VuoList_VuoTextSort  list,
const VuoTextSort  value 
)

Appends value to list.

Definition at line 305 of file VuoList_VuoTextSort.cc.

◆ VuoListCopy_VuoTextSort()

VuoList_VuoTextSort VuoListCopy_VuoTextSort ( const VuoList_VuoTextSort  list)

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

Definition at line 171 of file VuoList_VuoTextSort.cc.

◆ VuoListCreate_VuoTextSort()

VuoList_VuoTextSort VuoListCreate_VuoTextSort ( void  )

Creates a new list of VuoTextSort elements.

Definition at line 151 of file VuoList_VuoTextSort.cc.

◆ VuoListCreateWithCount_VuoTextSort()

VuoList_VuoTextSort VuoListCreateWithCount_VuoTextSort ( const unsigned long  count,
const VuoTextSort  value 
)

Creates a new list of count instances of value.

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

Definition at line 158 of file VuoList_VuoTextSort.cc.

◆ VuoListExchangeValues_VuoTextSort()

void VuoListExchangeValues_VuoTextSort ( VuoList_VuoTextSort  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_VuoTextSort.cc.

◆ VuoListForeach_VuoTextSort()

void VuoListForeach_VuoTextSort ( const VuoList_VuoTextSort  list,
bool(^)(const VuoTextSort 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_VuoTextSort.cc.

◆ VuoListGetCount_VuoTextSort()

unsigned long VuoListGetCount_VuoTextSort ( const VuoList_VuoTextSort  list)

Returns the number of elements in list.

Definition at line 550 of file VuoList_VuoTextSort.cc.

◆ VuoListGetData_VuoTextSort()

VuoTextSort* VuoListGetData_VuoTextSort ( const VuoList_VuoTextSort  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_VuoTextSort.cc.

◆ VuoListGetValue_VuoTextSort()

VuoTextSort VuoListGetValue_VuoTextSort ( const VuoList_VuoTextSort  list,
const unsigned long  index 
)

Returns the VuoTextSort 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_VuoTextSort or VuoListForeach_VuoTextSort.

Definition at line 200 of file VuoList_VuoTextSort.cc.

◆ VuoListInsertValue_VuoTextSort()

void VuoListInsertValue_VuoTextSort ( const VuoList_VuoTextSort  list,
const VuoTextSort  value,
const unsigned long  index 
)

Inserts the VuoTextSort 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_VuoTextSort.cc.

◆ VuoListPrependValue_VuoTextSort()

void VuoListPrependValue_VuoTextSort ( VuoList_VuoTextSort  list,
const VuoTextSort  value 
)

Prepends value to list.

Definition at line 295 of file VuoList_VuoTextSort.cc.

◆ VuoListRemoveAll_VuoTextSort()

void VuoListRemoveAll_VuoTextSort ( VuoList_VuoTextSort  list)

Removes all values from list.

Definition at line 524 of file VuoList_VuoTextSort.cc.

◆ VuoListRemoveFirstValue_VuoTextSort()

void VuoListRemoveFirstValue_VuoTextSort ( VuoList_VuoTextSort  list)

Removes the first value from list.

Definition at line 496 of file VuoList_VuoTextSort.cc.

◆ VuoListRemoveLastValue_VuoTextSort()

void VuoListRemoveLastValue_VuoTextSort ( VuoList_VuoTextSort  list)

Removes the last value from list.

Definition at line 510 of file VuoList_VuoTextSort.cc.

◆ VuoListRemoveValue_VuoTextSort()

void VuoListRemoveValue_VuoTextSort ( VuoList_VuoTextSort  list,
const unsigned long  index 
)

Removes the VuoTextSort 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_VuoTextSort.cc.

◆ VuoListReverse_VuoTextSort()

void VuoListReverse_VuoTextSort ( VuoList_VuoTextSort  list)

Reverses the order of the items in list.

Definition at line 419 of file VuoList_VuoTextSort.cc.

◆ VuoListSetValue_VuoTextSort()

void VuoListSetValue_VuoTextSort ( const VuoList_VuoTextSort  list,
const VuoTextSort  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoTextSort 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_VuoTextSort.cc.

◆ VuoListShuffle_VuoTextSort()

void VuoListShuffle_VuoTextSort ( VuoList_VuoTextSort  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_VuoTextSort.cc.

◆ VuoListSubset_VuoTextSort()

VuoList_VuoTextSort VuoListSubset_VuoTextSort ( VuoList_VuoTextSort  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_VuoTextSort.cc.