Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoWeekday

Description

A list of VuoWeekday elements.

Classes

struct  VuoList_VuoWeekday_struct
 A list of VuoWeekday elements. More...
 

Typedefs

typedef const struct VuoList_VuoWeekday_structVuoList_VuoWeekday
 A list of VuoWeekday elements. More...
 

Functions

VuoList_VuoWeekday VuoListCreate_VuoWeekday (void)
 Creates a new list of VuoWeekday elements. More...
 
VuoList_VuoWeekday VuoListCreateWithCount_VuoWeekday (const unsigned long count, const VuoWeekday value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoWeekday VuoListCopy_VuoWeekday (const VuoList_VuoWeekday list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoWeekday VuoListGetValue_VuoWeekday (const VuoList_VuoWeekday list, const unsigned long index)
 Returns the VuoWeekday at index. More...
 
VuoWeekdayVuoListGetData_VuoWeekday (const VuoList_VuoWeekday list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoWeekday (const VuoList_VuoWeekday list, bool(^function)(const VuoWeekday value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoWeekday (const VuoList_VuoWeekday list, const VuoWeekday value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoWeekday at index. More...
 
void VuoListInsertValue_VuoWeekday (const VuoList_VuoWeekday list, const VuoWeekday value, const unsigned long index)
 Inserts the VuoWeekday immediately before index. More...
 
void VuoListPrependValue_VuoWeekday (VuoList_VuoWeekday list, const VuoWeekday value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoWeekday (VuoList_VuoWeekday list, const VuoWeekday value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoWeekday (VuoList_VuoWeekday list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoWeekday (VuoList_VuoWeekday list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoWeekday (VuoList_VuoWeekday list)
 Reverses the order of the items in list. More...
 
VuoList_VuoWeekday VuoListSubset_VuoWeekday (VuoList_VuoWeekday 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_VuoWeekday (VuoList_VuoWeekday list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoWeekday (VuoList_VuoWeekday list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoWeekday (VuoList_VuoWeekday list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoWeekday (VuoList_VuoWeekday list, const unsigned long index)
 Removes the VuoWeekday at index. More...
 
unsigned long VuoListGetCount_VuoWeekday (const VuoList_VuoWeekday list)
 Returns the number of elements in list. More...
 
VuoList_VuoWeekday VuoList_VuoWeekday_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoWeekday_getJson (const VuoList_VuoWeekday value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoWeekday_getSummary (const VuoList_VuoWeekday value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoWeekday VuoList_VuoWeekday_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoWeekday_getString (const VuoList_VuoWeekday value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoWeekday_struct

struct VuoList_VuoWeekday_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoWeekday

A list of VuoWeekday elements.

Function Documentation

◆ VuoList_VuoWeekday_getJson()

struct json_object* VuoList_VuoWeekday_getJson ( const VuoList_VuoWeekday  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoWeekday.cc.

◆ VuoList_VuoWeekday_getString()

char* VuoList_VuoWeekday_getString ( const VuoList_VuoWeekday  value)

Automatically generated function.

◆ VuoList_VuoWeekday_getSummary()

char* VuoList_VuoWeekday_getSummary ( const VuoList_VuoWeekday  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoWeekday.cc.

◆ VuoList_VuoWeekday_makeFromJson()

VuoList_VuoWeekday VuoList_VuoWeekday_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_VuoWeekday.cc.

◆ VuoList_VuoWeekday_makeFromString()

VuoList_VuoWeekday VuoList_VuoWeekday_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoWeekday()

void VuoListAppendValue_VuoWeekday ( VuoList_VuoWeekday  list,
const VuoWeekday  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoWeekday.cc.

◆ VuoListCopy_VuoWeekday()

VuoList_VuoWeekday VuoListCopy_VuoWeekday ( const VuoList_VuoWeekday  list)

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

Definition at line 174 of file VuoList_VuoWeekday.cc.

◆ VuoListCreate_VuoWeekday()

VuoList_VuoWeekday VuoListCreate_VuoWeekday ( void  )

Creates a new list of VuoWeekday elements.

Definition at line 154 of file VuoList_VuoWeekday.cc.

◆ VuoListCreateWithCount_VuoWeekday()

VuoList_VuoWeekday VuoListCreateWithCount_VuoWeekday ( const unsigned long  count,
const VuoWeekday  value 
)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoWeekday.cc.

◆ VuoListExchangeValues_VuoWeekday()

void VuoListExchangeValues_VuoWeekday ( VuoList_VuoWeekday  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_VuoWeekday.cc.

◆ VuoListForeach_VuoWeekday()

void VuoListForeach_VuoWeekday ( const VuoList_VuoWeekday  list,
bool(^)(const VuoWeekday 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_VuoWeekday.cc.

◆ VuoListGetCount_VuoWeekday()

unsigned long VuoListGetCount_VuoWeekday ( const VuoList_VuoWeekday  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoWeekday.cc.

◆ VuoListGetData_VuoWeekday()

VuoWeekday* VuoListGetData_VuoWeekday ( const VuoList_VuoWeekday  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_VuoWeekday.cc.

◆ VuoListGetValue_VuoWeekday()

VuoWeekday VuoListGetValue_VuoWeekday ( const VuoList_VuoWeekday  list,
const unsigned long  index 
)

Returns the VuoWeekday 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_VuoWeekday or VuoListForeach_VuoWeekday.

Definition at line 203 of file VuoList_VuoWeekday.cc.

◆ VuoListInsertValue_VuoWeekday()

void VuoListInsertValue_VuoWeekday ( const VuoList_VuoWeekday  list,
const VuoWeekday  value,
const unsigned long  index 
)

Inserts the VuoWeekday 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_VuoWeekday.cc.

◆ VuoListPrependValue_VuoWeekday()

void VuoListPrependValue_VuoWeekday ( VuoList_VuoWeekday  list,
const VuoWeekday  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoWeekday.cc.

◆ VuoListRemoveAll_VuoWeekday()

void VuoListRemoveAll_VuoWeekday ( VuoList_VuoWeekday  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoWeekday.cc.

◆ VuoListRemoveFirstValue_VuoWeekday()

void VuoListRemoveFirstValue_VuoWeekday ( VuoList_VuoWeekday  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoWeekday.cc.

◆ VuoListRemoveLastValue_VuoWeekday()

void VuoListRemoveLastValue_VuoWeekday ( VuoList_VuoWeekday  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoWeekday.cc.

◆ VuoListRemoveValue_VuoWeekday()

void VuoListRemoveValue_VuoWeekday ( VuoList_VuoWeekday  list,
const unsigned long  index 
)

Removes the VuoWeekday 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_VuoWeekday.cc.

◆ VuoListReverse_VuoWeekday()

void VuoListReverse_VuoWeekday ( VuoList_VuoWeekday  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoWeekday.cc.

◆ VuoListSetValue_VuoWeekday()

void VuoListSetValue_VuoWeekday ( const VuoList_VuoWeekday  list,
const VuoWeekday  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoWeekday 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_VuoWeekday.cc.

◆ VuoListShuffle_VuoWeekday()

void VuoListShuffle_VuoWeekday ( VuoList_VuoWeekday  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_VuoWeekday.cc.

◆ VuoListSubset_VuoWeekday()

VuoList_VuoWeekday VuoListSubset_VuoWeekday ( VuoList_VuoWeekday  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_VuoWeekday.cc.