Description

A list of VuoNumberFormat elements.

Classes
struct	VuoList_VuoNumberFormat_struct
	A list of VuoNumberFormat elements. More...

Typedefs
typedef const struct VuoList_VuoNumberFormat_struct *	VuoList_VuoNumberFormat
	A list of VuoNumberFormat elements. More...

Functions
VuoList_VuoNumberFormat	VuoListCreate_VuoNumberFormat (void)
	Creates a new list of VuoNumberFormat elements. More...

VuoList_VuoNumberFormat	VuoListCreateWithCount_VuoNumberFormat (const unsigned long count, const VuoNumberFormat value)
	Creates a new list of `count` instances of `value`. More...

VuoList_VuoNumberFormat	VuoListCopy_VuoNumberFormat (const VuoList_VuoNumberFormat list)
	Makes a shallow copy of `list` — its items are retained (not copied) by the new list. More...

VuoNumberFormat	VuoListGetValue_VuoNumberFormat (const VuoList_VuoNumberFormat list, const unsigned long index)
	Returns the VuoNumberFormat at `index`. More...

VuoNumberFormat *	VuoListGetData_VuoNumberFormat (const VuoList_VuoNumberFormat list)
	Returns a pointer to a C array containing the list items. More...

void	VuoListForeach_VuoNumberFormat (const VuoList_VuoNumberFormat list, bool(^function)(const VuoNumberFormat value))
	Applies `function` to each of `list`'s items, serially in order of index. More...

void	VuoListSetValue_VuoNumberFormat (const VuoList_VuoNumberFormat list, const VuoNumberFormat value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoNumberFormat at `index`. More...

void	VuoListInsertValue_VuoNumberFormat (const VuoList_VuoNumberFormat list, const VuoNumberFormat value, const unsigned long index)
	Inserts the `VuoNumberFormat` immediately before `index`. More...

void	VuoListPrependValue_VuoNumberFormat (VuoList_VuoNumberFormat list, const VuoNumberFormat value)
	Prepends `value` to `list`. More...

void	VuoListAppendValue_VuoNumberFormat (VuoList_VuoNumberFormat list, const VuoNumberFormat value)
	Appends `value` to `list`. More...

void	VuoListExchangeValues_VuoNumberFormat (VuoList_VuoNumberFormat list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at `indexA` with the value at `indexB`. More...

void	VuoListShuffle_VuoNumberFormat (VuoList_VuoNumberFormat list, const double chaos)
	Generates a random permutation of `list`. More...

void	VuoListReverse_VuoNumberFormat (VuoList_VuoNumberFormat list)
	Reverses the order of the items in `list`. More...

VuoList_VuoNumberFormat	VuoListSubset_VuoNumberFormat (VuoList_VuoNumberFormat 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_VuoNumberFormat (VuoList_VuoNumberFormat list)
	Removes the first value from `list`. More...

void	VuoListRemoveLastValue_VuoNumberFormat (VuoList_VuoNumberFormat list)
	Removes the last value from `list`. More...

void	VuoListRemoveAll_VuoNumberFormat (VuoList_VuoNumberFormat list)
	Removes all values from `list`. More...

void	VuoListRemoveValue_VuoNumberFormat (VuoList_VuoNumberFormat list, const unsigned long index)
	Removes the `VuoNumberFormat` at `index`. More...

unsigned long	VuoListGetCount_VuoNumberFormat (const VuoList_VuoNumberFormat list)
	Returns the number of elements in `list`. More...

VuoList_VuoNumberFormat	VuoList_VuoNumberFormat_makeFromJson (struct json_object *js)
	Decodes the JSON object `js` to create a new value. More...

struct json_object *	VuoList_VuoNumberFormat_getJson (const VuoList_VuoNumberFormat value)
	Encodes `value` as a JSON object. More...

char *	VuoList_VuoNumberFormat_getSummary (const VuoList_VuoNumberFormat value)
	Produces a brief human-readable summary of `value`. More...

VuoList_VuoNumberFormat	VuoList_VuoNumberFormat_makeFromString (const char *str)
	Automatically generated function. More...

char *	VuoList_VuoNumberFormat_getString (const VuoList_VuoNumberFormat value)
	Automatically generated function. More...

Class Documentation

◆ VuoList_VuoNumberFormat_struct

struct VuoList_VuoNumberFormat_struct

Class Members
void *	l

Typedef Documentation

◆ VuoList_VuoNumberFormat

typedef const struct VuoList_VuoNumberFormat_struct * VuoList_VuoNumberFormat

A list of VuoNumberFormat elements.

Function Documentation

◆ VuoList_VuoNumberFormat_getJson()

struct json_object* VuoList_VuoNumberFormat_getJson ( const VuoList_VuoNumberFormat value )

Encodes value as a JSON object.

Definition at line 81 of file VuoList_VuoNumberFormat.cc.

◆ VuoList_VuoNumberFormat_getString()

char* VuoList_VuoNumberFormat_getString ( const VuoList_VuoNumberFormat value )

Automatically generated function.

◆ VuoList_VuoNumberFormat_getSummary()

char* VuoList_VuoNumberFormat_getSummary ( const VuoList_VuoNumberFormat value )

Produces a brief human-readable summary of value.

Definition at line 113 of file VuoList_VuoNumberFormat.cc.

◆ VuoList_VuoNumberFormat_makeFromJson()

VuoList_VuoNumberFormat VuoList_VuoNumberFormat_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_VuoNumberFormat.cc.

◆ VuoList_VuoNumberFormat_makeFromString()

VuoList_VuoNumberFormat VuoList_VuoNumberFormat_makeFromString ( const char * str )

Automatically generated function.

◆ VuoListAppendValue_VuoNumberFormat()

void VuoListAppendValue_VuoNumberFormat	(	VuoList_VuoNumberFormat	list,
		const VuoNumberFormat	value
	)

Appends value to list.

Definition at line 305 of file VuoList_VuoNumberFormat.cc.

◆ VuoListCopy_VuoNumberFormat()

VuoList_VuoNumberFormat VuoListCopy_VuoNumberFormat ( const VuoList_VuoNumberFormat list )

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

Definition at line 171 of file VuoList_VuoNumberFormat.cc.

◆ VuoListCreate_VuoNumberFormat()

VuoList_VuoNumberFormat VuoListCreate_VuoNumberFormat ( void )

Creates a new list of VuoNumberFormat elements.

Definition at line 151 of file VuoList_VuoNumberFormat.cc.

◆ VuoListCreateWithCount_VuoNumberFormat()

VuoList_VuoNumberFormat VuoListCreateWithCount_VuoNumberFormat	(	const unsigned long	count,
		const VuoNumberFormat	value
	)

Creates a new list of count instances of value.

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

Definition at line 158 of file VuoList_VuoNumberFormat.cc.

◆ VuoListExchangeValues_VuoNumberFormat()

void VuoListExchangeValues_VuoNumberFormat	(	VuoList_VuoNumberFormat	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_VuoNumberFormat.cc.

◆ VuoListForeach_VuoNumberFormat()

void VuoListForeach_VuoNumberFormat	(	const VuoList_VuoNumberFormat	list,
		bool(^)(const VuoNumberFormat 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_VuoNumberFormat.cc.

◆ VuoListGetCount_VuoNumberFormat()

unsigned long VuoListGetCount_VuoNumberFormat ( const VuoList_VuoNumberFormat list )

Returns the number of elements in list.

Definition at line 550 of file VuoList_VuoNumberFormat.cc.

◆ VuoListGetData_VuoNumberFormat()

VuoNumberFormat* VuoListGetData_VuoNumberFormat ( const VuoList_VuoNumberFormat 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_VuoNumberFormat.cc.

◆ VuoListGetValue_VuoNumberFormat()

VuoNumberFormat VuoListGetValue_VuoNumberFormat	(	const VuoList_VuoNumberFormat	list,
		const unsigned long	index
	)

Returns the VuoNumberFormat 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_VuoNumberFormat or VuoListForeach_VuoNumberFormat.

Definition at line 200 of file VuoList_VuoNumberFormat.cc.

◆ VuoListInsertValue_VuoNumberFormat()

void VuoListInsertValue_VuoNumberFormat	(	const VuoList_VuoNumberFormat	list,
		const VuoNumberFormat	value,
		const unsigned long	index
	)

Inserts the VuoNumberFormat 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_VuoNumberFormat.cc.

◆ VuoListPrependValue_VuoNumberFormat()

void VuoListPrependValue_VuoNumberFormat	(	VuoList_VuoNumberFormat	list,
		const VuoNumberFormat	value
	)

Prepends value to list.

Definition at line 295 of file VuoList_VuoNumberFormat.cc.

◆ VuoListRemoveAll_VuoNumberFormat()

void VuoListRemoveAll_VuoNumberFormat ( VuoList_VuoNumberFormat list )

Removes all values from list.

Definition at line 524 of file VuoList_VuoNumberFormat.cc.

◆ VuoListRemoveFirstValue_VuoNumberFormat()

void VuoListRemoveFirstValue_VuoNumberFormat ( VuoList_VuoNumberFormat list )

Removes the first value from list.

Definition at line 496 of file VuoList_VuoNumberFormat.cc.

◆ VuoListRemoveLastValue_VuoNumberFormat()

void VuoListRemoveLastValue_VuoNumberFormat ( VuoList_VuoNumberFormat list )

Removes the last value from list.

Definition at line 510 of file VuoList_VuoNumberFormat.cc.

◆ VuoListRemoveValue_VuoNumberFormat()

void VuoListRemoveValue_VuoNumberFormat	(	VuoList_VuoNumberFormat	list,
		const unsigned long	index
	)

Removes the VuoNumberFormat 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_VuoNumberFormat.cc.

◆ VuoListReverse_VuoNumberFormat()

void VuoListReverse_VuoNumberFormat ( VuoList_VuoNumberFormat list )

Reverses the order of the items in list.

Definition at line 419 of file VuoList_VuoNumberFormat.cc.

◆ VuoListSetValue_VuoNumberFormat()

void VuoListSetValue_VuoNumberFormat	(	const VuoList_VuoNumberFormat	list,
		const VuoNumberFormat	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoNumberFormat 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_VuoNumberFormat.cc.

◆ VuoListShuffle_VuoNumberFormat()

void VuoListShuffle_VuoNumberFormat	(	VuoList_VuoNumberFormat	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_VuoNumberFormat.cc.

◆ VuoListSubset_VuoNumberFormat()

VuoList_VuoNumberFormat VuoListSubset_VuoNumberFormat	(	VuoList_VuoNumberFormat	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_VuoNumberFormat.cc.