VuoList_VuoGridType

Description

A list of VuoGridType elements.

Classes
struct	VuoList_VuoGridType_struct
	A list of VuoGridType elements. More...

Typedefs
typedef struct VuoList_VuoGridType_struct *	VuoList_VuoGridType
	A list of VuoGridType elements.

Functions
VuoList_VuoGridType	VuoListCreate_VuoGridType (void)
	Creates a new list of VuoGridType elements.
VuoList_VuoGridType	VuoListCopy_VuoGridType (const VuoList_VuoGridType list)
	Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoGridType	VuoListGetValue_VuoGridType (const VuoList_VuoGridType list, const unsigned long index)
	Returns the VuoGridType at index.
void	VuoListSetValue_VuoGridType (const VuoList_VuoGridType list, const VuoGridType value, const unsigned long index)
	Changes the VuoGridType at index.
void	VuoListInsertValue_VuoGridType (const VuoList_VuoGridType list, const VuoGridType value, const unsigned long index)
	Inserts the VuoGridType immediately before index.
void	VuoListPrependValue_VuoGridType (VuoList_VuoGridType list, const VuoGridType value)
	Prepends value to list.
void	VuoListAppendValue_VuoGridType (VuoList_VuoGridType list, const VuoGridType value)
	Appends value to list.
void	VuoListExchangeValues_VuoGridType (VuoList_VuoGridType list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at indexA with the value at indexB.
void	VuoListShuffle_VuoGridType (VuoList_VuoGridType list, const double chaos)
	Generates a random permutation of list.
void	VuoListReverse_VuoGridType (VuoList_VuoGridType list)
	Reverses the order of the items in list.
void	VuoListCut_VuoGridType (VuoList_VuoGridType list, const signed long startIndex, const unsigned long itemCount)
	Removes items from the list except those in the range specified by startIndex and itemCount.
void	VuoListRemoveFirstValue_VuoGridType (VuoList_VuoGridType list)
	Removes the first value from list.
void	VuoListRemoveLastValue_VuoGridType (VuoList_VuoGridType list)
	Removes the last value from list.
void	VuoListRemoveAll_VuoGridType (VuoList_VuoGridType list)
	Removes all values from list.
void	VuoListRemoveValue_VuoGridType (VuoList_VuoGridType list, const unsigned long index)
	Removes the VuoGridType at index.
unsigned long	VuoListGetCount_VuoGridType (const VuoList_VuoGridType list)
	Returns the number of elements in list.
VuoList_VuoGridType	VuoList_VuoGridType_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value.
struct json_object *	VuoList_VuoGridType_getJson (const VuoList_VuoGridType value)
	Encodes value as a JSON object.
char *	VuoList_VuoGridType_getSummary (const VuoList_VuoGridType value)
	Produces a brief human-readable summary of value.
VuoList_VuoGridType	VuoList_VuoGridType_makeFromString (const char *str)
	Automatically generated function.
char *	VuoList_VuoGridType_getString (const VuoList_VuoGridType value)
	Automatically generated function.

---

Class Documentation

struct VuoList_VuoGridType_struct

Class Members
void *	l

Typedef Documentation

typedef struct VuoList_VuoGridType_struct * VuoList_VuoGridType

A list of VuoGridType elements.

Function Documentation

struct json_object* VuoList_VuoGridType_getJson ( const VuoList_VuoGridType  value )

read

Encodes value as a JSON object.

char* VuoList_VuoGridType_getString

(

const VuoList_VuoGridType

value

)

Automatically generated function.

char* VuoList_VuoGridType_getSummary

(

const VuoList_VuoGridType

value

)

Produces a brief human-readable summary of value.

VuoList_VuoGridType VuoList_VuoGridType_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

["uno", "dos", "tres", "catorce"]

VuoList_VuoGridType VuoList_VuoGridType_makeFromString

(

const char *

str

)

Automatically generated function.

void VuoListAppendValue_VuoGridType	(	VuoList_VuoGridType	list,
		const VuoGridType	value
	)

Appends value to list.

VuoList_VuoGridType VuoListCopy_VuoGridType

(

const VuoList_VuoGridType

list

)

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

VuoList_VuoGridType VuoListCreate_VuoGridType

(

void

)

Creates a new list of VuoGridType elements.

void VuoListCut_VuoGridType	(	VuoList_VuoGridType	list,
		const signed long	startIndex,
		const unsigned long	itemCount
	)

Removes items from the list except those in the range specified by startIndex and itemCount.

void VuoListExchangeValues_VuoGridType	(	VuoList_VuoGridType	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoGridType

(

const VuoList_VuoGridType

list

)

Returns the number of elements in list.

VuoGridType VuoListGetValue_VuoGridType	(	const VuoList_VuoGridType	list,
		const unsigned long	index
	)

Returns the VuoGridType 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).

void VuoListInsertValue_VuoGridType	(	const VuoList_VuoGridType	list,
		const VuoGridType	value,
		const unsigned long	index
	)

Inserts the VuoGridType 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.

void VuoListPrependValue_VuoGridType	(	VuoList_VuoGridType	list,
		const VuoGridType	value
	)

Prepends value to list.

void VuoListRemoveAll_VuoGridType

(

VuoList_VuoGridType

list

)

Removes all values from list.

void VuoListRemoveFirstValue_VuoGridType

(

VuoList_VuoGridType

list

)

Removes the first value from list.

void VuoListRemoveLastValue_VuoGridType

(

VuoList_VuoGridType

list

)

Removes the last value from list.

void VuoListRemoveValue_VuoGridType	(	VuoList_VuoGridType	list,
		const unsigned long	index
	)

Removes the VuoGridType 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.

void VuoListReverse_VuoGridType

(

VuoList_VuoGridType

list

)

Reverses the order of the items in list.

void VuoListSetValue_VuoGridType	(	const VuoList_VuoGridType	list,
		const VuoGridType	value,
		const unsigned long	index
	)

Changes the VuoGridType at index.

Index values start at 1. 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).

void VuoListShuffle_VuoGridType	(	VuoList_VuoGridType	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.