Description

A list of VuoDistribution3d elements.

Classes
struct	VuoList_VuoDistribution3d_struct
	A list of VuoDistribution3d elements. More...

Typedefs
typedef const struct VuoList_VuoDistribution3d_struct *	VuoList_VuoDistribution3d
	A list of VuoDistribution3d elements. More...

Functions
VuoList_VuoDistribution3d	VuoListCreate_VuoDistribution3d (void)
	Creates a new list of VuoDistribution3d elements. More...

VuoList_VuoDistribution3d	VuoListCreateWithCount_VuoDistribution3d (const unsigned long count, const VuoDistribution3d value)
	Creates a new list of `count` instances of `value`. More...

VuoList_VuoDistribution3d	VuoListCreateWithValueArray_VuoDistribution3d (const VuoDistribution3d *values, const unsigned long valueCount)
	Creates a new list containing the items in the C array `values`. More...

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

static unsigned long	VuoListIndexToCArrayIndex (long index, unsigned long listCount) __attribute__((const))
	Converts a Vuo-style `[1..n]` list index into a C-style `[0..n-1]` list index. More...

VuoDistribution3d	VuoListGetValue_VuoDistribution3d (const VuoList_VuoDistribution3d list, const unsigned long index)
	Returns the VuoDistribution3d at `index`. More...

VuoDistribution3d *	VuoListGetData_VuoDistribution3d (const VuoList_VuoDistribution3d list)
	Returns a pointer to a C array containing the list items. More...

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

void	VuoListSetValue_VuoDistribution3d (const VuoList_VuoDistribution3d list, const VuoDistribution3d value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoDistribution3d at `index`. More...

void	VuoListInsertValue_VuoDistribution3d (const VuoList_VuoDistribution3d list, const VuoDistribution3d value, const unsigned long index)
	Inserts the `VuoDistribution3d` immediately before `index`. More...

void	VuoListPrependValue_VuoDistribution3d (VuoList_VuoDistribution3d list, const VuoDistribution3d value)
	Prepends `value` to `list`. More...

void	VuoListAppendValue_VuoDistribution3d (VuoList_VuoDistribution3d list, const VuoDistribution3d value)
	Appends `value` to `list`. More...

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

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

void	VuoListReverse_VuoDistribution3d (VuoList_VuoDistribution3d list)
	Reverses the order of the items in `list`. More...

VuoList_VuoDistribution3d	VuoListSubset_VuoDistribution3d (VuoList_VuoDistribution3d 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_VuoDistribution3d (VuoList_VuoDistribution3d list)
	Removes the first value from `list`. More...

void	VuoListRemoveLastValue_VuoDistribution3d (VuoList_VuoDistribution3d list)
	Removes the last value from `list`. More...

void	VuoListRemoveAll_VuoDistribution3d (VuoList_VuoDistribution3d list)
	Removes all values from `list`. More...

void	VuoListRemoveValue_VuoDistribution3d (VuoList_VuoDistribution3d list, const unsigned long index)
	Removes the `VuoDistribution3d` at `index`. More...

unsigned long	VuoListGetCount_VuoDistribution3d (const VuoList_VuoDistribution3d list)
	Returns the number of elements in `list`. More...

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

struct json_object *	VuoList_VuoDistribution3d_getJson (const VuoList_VuoDistribution3d value)
	Encodes `value` as a JSON object. More...

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

void	VuoList_VuoDistribution3d_retain (VuoList_VuoDistribution3d value)
	Retains the list. More...

void	VuoList_VuoDistribution3d_release (VuoList_VuoDistribution3d value)
	Releases the list. More...

char *	VuoList_VuoDistribution3d_getString (const VuoList_VuoDistribution3d value)
	Automatically generated function. More...

Class Documentation

◆ VuoList_VuoDistribution3d_struct

struct VuoList_VuoDistribution3d_struct

Class Members
void *	l

Macro Definition Documentation

◆ VUO_LIST_INDEX_TO_C_ARRAY_INDEX

#define VUO_LIST_INDEX_TO_C_ARRAY_INDEX

Definition at line 63 of file VuoList_VuoDistribution3d.h.

Typedef Documentation

◆ VuoList_VuoDistribution3d

typedef const struct VuoList_VuoDistribution3d_struct * VuoList_VuoDistribution3d

A list of VuoDistribution3d elements.

Function Documentation

◆ VuoList_VuoDistribution3d_getJson()

struct json_object * VuoList_VuoDistribution3d_getJson ( const VuoList_VuoDistribution3d value )

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoDistribution3d.cc.

◆ VuoList_VuoDistribution3d_getString()

char * VuoList_VuoDistribution3d_getString ( const VuoList_VuoDistribution3d value )

Automatically generated function.

◆ VuoList_VuoDistribution3d_getSummary()

char * VuoList_VuoDistribution3d_getSummary ( const VuoList_VuoDistribution3d value )

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoDistribution3d.cc.

◆ VuoList_VuoDistribution3d_makeFromJson()

VuoList_VuoDistribution3d VuoList_VuoDistribution3d_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_VuoDistribution3d.cc.

◆ VuoList_VuoDistribution3d_release()

void VuoList_VuoDistribution3d_release ( VuoList_VuoDistribution3d value )

Releases the list.

This function is provided for use in polymorphism; it just calls VuoRelease().

Definition at line 580 of file VuoList_VuoDistribution3d.cc.

◆ VuoList_VuoDistribution3d_retain()

void VuoList_VuoDistribution3d_retain ( VuoList_VuoDistribution3d value )

Retains the list.

This function is provided for use in polymorphism; it just calls VuoRetain().

Definition at line 575 of file VuoList_VuoDistribution3d.cc.

◆ VuoListAppendValue_VuoDistribution3d()

void VuoListAppendValue_VuoDistribution3d	(	VuoList_VuoDistribution3d	list,
		const VuoDistribution3d	value
	)

Appends value to list.

Definition at line 321 of file VuoList_VuoDistribution3d.cc.

◆ VuoListCopy_VuoDistribution3d()

VuoList_VuoDistribution3d VuoListCopy_VuoDistribution3d ( const VuoList_VuoDistribution3d list )

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

Definition at line 187 of file VuoList_VuoDistribution3d.cc.

◆ VuoListCreate_VuoDistribution3d()

VuoList_VuoDistribution3d VuoListCreate_VuoDistribution3d ( void )

Creates a new list of VuoDistribution3d elements.

Definition at line 154 of file VuoList_VuoDistribution3d.cc.

◆ VuoListCreateWithCount_VuoDistribution3d()

VuoList_VuoDistribution3d VuoListCreateWithCount_VuoDistribution3d	(	const unsigned long	count,
		const VuoDistribution3d	value
	)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoDistribution3d.cc.

◆ VuoListCreateWithValueArray_VuoDistribution3d()

VuoList_VuoDistribution3d VuoListCreateWithValueArray_VuoDistribution3d	(	const VuoDistribution3d *	values,
		const unsigned long	valueCount
	)

Creates a new list containing the items in the C array values.

The list retains each item in values.

The caller may discard values after this function returns.

Definition at line 174 of file VuoList_VuoDistribution3d.cc.

◆ VuoListExchangeValues_VuoDistribution3d()

void VuoListExchangeValues_VuoDistribution3d	(	VuoList_VuoDistribution3d	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

Definition at line 331 of file VuoList_VuoDistribution3d.cc.

◆ VuoListForeach_VuoDistribution3d()

void VuoListForeach_VuoDistribution3d	(	const VuoList_VuoDistribution3d	list,
		bool(^)(const VuoDistribution3d 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 242 of file VuoList_VuoDistribution3d.cc.

◆ VuoListGetCount_VuoDistribution3d()

unsigned long VuoListGetCount_VuoDistribution3d ( const VuoList_VuoDistribution3d list )

Returns the number of elements in list.

Definition at line 566 of file VuoList_VuoDistribution3d.cc.

◆ VuoListGetData_VuoDistribution3d()

VuoDistribution3d * VuoListGetData_VuoDistribution3d ( const VuoList_VuoDistribution3d 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 232 of file VuoList_VuoDistribution3d.cc.

◆ VuoListGetValue_VuoDistribution3d()

VuoDistribution3d VuoListGetValue_VuoDistribution3d	(	const VuoList_VuoDistribution3d	list,
		const unsigned long	index
	)

Returns the VuoDistribution3d 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_VuoDistribution3d or VuoListForeach_VuoDistribution3d.

Definition at line 216 of file VuoList_VuoDistribution3d.cc.

◆ VuoListIndexToCArrayIndex()

static unsigned long VuoListIndexToCArrayIndex	(	long	index,
		unsigned long	listCount
	)		const

inlinestatic

Converts a Vuo-style [1..n] list index into a C-style [0..n-1] list index.

If the index is less than 1, or larger than the size of the list, the returned index is clamped.

Definition at line 70 of file VuoList_VuoDistribution3d.h.

◆ VuoListInsertValue_VuoDistribution3d()

void VuoListInsertValue_VuoDistribution3d	(	const VuoList_VuoDistribution3d	list,
		const VuoDistribution3d	value,
		const unsigned long	index
	)

Inserts the VuoDistribution3d 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 289 of file VuoList_VuoDistribution3d.cc.

◆ VuoListPrependValue_VuoDistribution3d()

void VuoListPrependValue_VuoDistribution3d	(	VuoList_VuoDistribution3d	list,
		const VuoDistribution3d	value
	)

Prepends value to list.

Definition at line 311 of file VuoList_VuoDistribution3d.cc.

◆ VuoListRemoveAll_VuoDistribution3d()

void VuoListRemoveAll_VuoDistribution3d ( VuoList_VuoDistribution3d list )

Removes all values from list.

Definition at line 540 of file VuoList_VuoDistribution3d.cc.

◆ VuoListRemoveFirstValue_VuoDistribution3d()

void VuoListRemoveFirstValue_VuoDistribution3d ( VuoList_VuoDistribution3d list )

Removes the first value from list.

Definition at line 512 of file VuoList_VuoDistribution3d.cc.

◆ VuoListRemoveLastValue_VuoDistribution3d()

void VuoListRemoveLastValue_VuoDistribution3d ( VuoList_VuoDistribution3d list )

Removes the last value from list.

Definition at line 526 of file VuoList_VuoDistribution3d.cc.

◆ VuoListRemoveValue_VuoDistribution3d()

void VuoListRemoveValue_VuoDistribution3d	(	VuoList_VuoDistribution3d	list,
		const unsigned long	index
	)

Removes the VuoDistribution3d 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 549 of file VuoList_VuoDistribution3d.cc.

◆ VuoListReverse_VuoDistribution3d()

void VuoListReverse_VuoDistribution3d ( VuoList_VuoDistribution3d list )

Reverses the order of the items in list.

Definition at line 435 of file VuoList_VuoDistribution3d.cc.

◆ VuoListSetValue_VuoDistribution3d()

void VuoListSetValue_VuoDistribution3d	(	const VuoList_VuoDistribution3d	list,
		const VuoDistribution3d	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoDistribution3d 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 254 of file VuoList_VuoDistribution3d.cc.

◆ VuoListShuffle_VuoDistribution3d()

void VuoListShuffle_VuoDistribution3d	(	VuoList_VuoDistribution3d	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 414 of file VuoList_VuoDistribution3d.cc.

◆ VuoListSubset_VuoDistribution3d()

VuoList_VuoDistribution3d VuoListSubset_VuoDistribution3d	(	VuoList_VuoDistribution3d	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 444 of file VuoList_VuoDistribution3d.cc.