Description

A list of VuoTime elements.

Classes
struct	VuoList_VuoTime_struct
	A list of VuoTime elements. More...

Typedefs
typedef const struct VuoList_VuoTime_struct *	VuoList_VuoTime
	A list of VuoTime elements. More...

Functions
VuoList_VuoTime	VuoListCreate_VuoTime (void)
	Creates a new list of VuoTime elements. More...

VuoList_VuoTime	VuoListCreateWithCount_VuoTime (const unsigned long count, const VuoTime value)
	Creates a new list of `count` instances of `value`. More...

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

VuoTime	VuoListGetValue_VuoTime (const VuoList_VuoTime list, const unsigned long index)
	Returns the VuoTime at `index`. More...

VuoTime *	VuoListGetData_VuoTime (const VuoList_VuoTime list)
	Returns a pointer to a C array containing the list items. More...

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

void	VuoListSetValue_VuoTime (const VuoList_VuoTime list, const VuoTime value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoTime at `index`. More...

void	VuoListInsertValue_VuoTime (const VuoList_VuoTime list, const VuoTime value, const unsigned long index)
	Inserts the `VuoTime` immediately before `index`. More...

void	VuoListPrependValue_VuoTime (VuoList_VuoTime list, const VuoTime value)
	Prepends `value` to `list`. More...

void	VuoListAppendValue_VuoTime (VuoList_VuoTime list, const VuoTime value)
	Appends `value` to `list`. More...

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

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

void	VuoListReverse_VuoTime (VuoList_VuoTime list)
	Reverses the order of the items in `list`. More...

VuoList_VuoTime	VuoListSubset_VuoTime (VuoList_VuoTime 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_VuoTime (VuoList_VuoTime list)
	Removes the first value from `list`. More...

void	VuoListRemoveLastValue_VuoTime (VuoList_VuoTime list)
	Removes the last value from `list`. More...

void	VuoListRemoveAll_VuoTime (VuoList_VuoTime list)
	Removes all values from `list`. More...

void	VuoListRemoveValue_VuoTime (VuoList_VuoTime list, const unsigned long index)
	Removes the `VuoTime` at `index`. More...

unsigned long	VuoListGetCount_VuoTime (const VuoList_VuoTime list)
	Returns the number of elements in `list`. More...

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

struct json_object *	VuoList_VuoTime_getJson (const VuoList_VuoTime value)
	Encodes `value` as a JSON object. More...

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

VuoList_VuoTime	VuoList_VuoTime_makeFromString (const char *str)
	Automatically generated function. More...

char *	VuoList_VuoTime_getString (const VuoList_VuoTime value)
	Automatically generated function. More...

Class Documentation

◆ VuoList_VuoTime_struct

struct VuoList_VuoTime_struct

Class Members
void *	l

Typedef Documentation

◆ VuoList_VuoTime

typedef const struct VuoList_VuoTime_struct * VuoList_VuoTime

A list of VuoTime elements.

Function Documentation

◆ VuoList_VuoTime_getJson()

struct json_object* VuoList_VuoTime_getJson ( const VuoList_VuoTime value )

Encodes value as a JSON object.

Definition at line 81 of file VuoList_VuoTime.cc.

◆ VuoList_VuoTime_getString()

char* VuoList_VuoTime_getString ( const VuoList_VuoTime value )

Automatically generated function.

◆ VuoList_VuoTime_getSummary()

char* VuoList_VuoTime_getSummary ( const VuoList_VuoTime value )

Produces a brief human-readable summary of value.

Definition at line 113 of file VuoList_VuoTime.cc.

◆ VuoList_VuoTime_makeFromJson()

VuoList_VuoTime VuoList_VuoTime_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_VuoTime.cc.

◆ VuoList_VuoTime_makeFromString()

VuoList_VuoTime VuoList_VuoTime_makeFromString ( const char * str )

Automatically generated function.

◆ VuoListAppendValue_VuoTime()

void VuoListAppendValue_VuoTime	(	VuoList_VuoTime	list,
		const VuoTime	value
	)

Appends value to list.

Definition at line 305 of file VuoList_VuoTime.cc.

◆ VuoListCopy_VuoTime()

VuoList_VuoTime VuoListCopy_VuoTime ( const VuoList_VuoTime list )

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

Definition at line 171 of file VuoList_VuoTime.cc.

◆ VuoListCreate_VuoTime()

VuoList_VuoTime VuoListCreate_VuoTime ( void )

Creates a new list of VuoTime elements.

Definition at line 151 of file VuoList_VuoTime.cc.

◆ VuoListCreateWithCount_VuoTime()

VuoList_VuoTime VuoListCreateWithCount_VuoTime	(	const unsigned long	count,
		const VuoTime	value
	)

Creates a new list of count instances of value.

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

Definition at line 158 of file VuoList_VuoTime.cc.

◆ VuoListExchangeValues_VuoTime()

void VuoListExchangeValues_VuoTime	(	VuoList_VuoTime	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_VuoTime.cc.

◆ VuoListForeach_VuoTime()

void VuoListForeach_VuoTime	(	const VuoList_VuoTime	list,
		bool(^)(const VuoTime 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_VuoTime.cc.

◆ VuoListGetCount_VuoTime()

unsigned long VuoListGetCount_VuoTime ( const VuoList_VuoTime list )

Returns the number of elements in list.

Definition at line 550 of file VuoList_VuoTime.cc.

◆ VuoListGetData_VuoTime()

VuoTime* VuoListGetData_VuoTime ( const VuoList_VuoTime 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_VuoTime.cc.

◆ VuoListGetValue_VuoTime()

VuoTime VuoListGetValue_VuoTime	(	const VuoList_VuoTime	list,
		const unsigned long	index
	)

Returns the VuoTime 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_VuoTime or VuoListForeach_VuoTime.

Definition at line 200 of file VuoList_VuoTime.cc.

◆ VuoListInsertValue_VuoTime()

void VuoListInsertValue_VuoTime	(	const VuoList_VuoTime	list,
		const VuoTime	value,
		const unsigned long	index
	)

Inserts the VuoTime 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_VuoTime.cc.

◆ VuoListPrependValue_VuoTime()

void VuoListPrependValue_VuoTime	(	VuoList_VuoTime	list,
		const VuoTime	value
	)

Prepends value to list.

Definition at line 295 of file VuoList_VuoTime.cc.

◆ VuoListRemoveAll_VuoTime()

void VuoListRemoveAll_VuoTime ( VuoList_VuoTime list )

Removes all values from list.

Definition at line 524 of file VuoList_VuoTime.cc.

◆ VuoListRemoveFirstValue_VuoTime()

void VuoListRemoveFirstValue_VuoTime ( VuoList_VuoTime list )

Removes the first value from list.

Definition at line 496 of file VuoList_VuoTime.cc.

◆ VuoListRemoveLastValue_VuoTime()

void VuoListRemoveLastValue_VuoTime ( VuoList_VuoTime list )

Removes the last value from list.

Definition at line 510 of file VuoList_VuoTime.cc.

◆ VuoListRemoveValue_VuoTime()

void VuoListRemoveValue_VuoTime	(	VuoList_VuoTime	list,
		const unsigned long	index
	)

Removes the VuoTime 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_VuoTime.cc.

◆ VuoListReverse_VuoTime()

void VuoListReverse_VuoTime ( VuoList_VuoTime list )

Reverses the order of the items in list.

Definition at line 419 of file VuoList_VuoTime.cc.

◆ VuoListSetValue_VuoTime()

void VuoListSetValue_VuoTime	(	const VuoList_VuoTime	list,
		const VuoTime	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoTime 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_VuoTime.cc.

◆ VuoListShuffle_VuoTime()

void VuoListShuffle_VuoTime	(	VuoList_VuoTime	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_VuoTime.cc.

◆ VuoListSubset_VuoTime()

VuoList_VuoTime VuoListSubset_VuoTime	(	VuoList_VuoTime	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_VuoTime.cc.