VuoList_VuoInteraction.h File Reference

Description

VuoList interface.

Copyright

Copyright © 2012–2023 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see https://vuo.org/license.

Definition in file VuoList_VuoInteraction.h.

Go to the source code of this file.

Classes
struct	VuoList_VuoInteraction
	An ordered list of items, all of the same type. More...

Functions
VuoList_VuoInteraction	VuoListCreate_VuoInteraction (void)
	Creates a new list of VuoInteraction items.
VuoList_VuoInteraction	VuoListCreateWithCount_VuoInteraction (const unsigned long count, const VuoInteraction value)
	Creates a new list of count instances of value.
VuoList_VuoInteraction	VuoListCreateWithValueArray_VuoInteraction (const VuoInteraction *values, const unsigned long valueCount)
	Creates a new list containing the items in the C array values.
VuoList_VuoInteraction	VuoListCopy_VuoInteraction (const VuoList_VuoInteraction list)
	Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoInteraction	VuoListGetValue_VuoInteraction (const VuoList_VuoInteraction list, const unsigned long index)
	Returns the item at index.
VuoInteraction *	VuoListGetData_VuoInteraction (const VuoList_VuoInteraction list)
	Returns a pointer to a C array containing the list items.
void	VuoListForeach_VuoInteraction (const VuoList_VuoInteraction list, bool(^function)(const VuoInteraction value))
	Applies function to each item in list, serially in order of index.
void	VuoListSetValue_VuoInteraction (const VuoList_VuoInteraction list, const VuoInteraction value, const unsigned long index, bool expandListIfNeeded)
	Changes the item at index.
void	VuoListInsertValue_VuoInteraction (const VuoList_VuoInteraction list, const VuoInteraction value, const unsigned long index)
	Inserts value immediately before index.
void	VuoListPrependValue_VuoInteraction (VuoList_VuoInteraction list, const VuoInteraction value)
	Prepends value to list.
void	VuoListAppendValue_VuoInteraction (VuoList_VuoInteraction list, const VuoInteraction value)
	Appends value to list.
void	VuoListExchangeValues_VuoInteraction (VuoList_VuoInteraction list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at indexA with the value at indexB.
void	VuoListShuffle_VuoInteraction (VuoList_VuoInteraction list, const double chaos)
	Generates a random permutation of list.
void	VuoListReverse_VuoInteraction (VuoList_VuoInteraction list)
	Reverses the order of the items in list.
VuoList_VuoInteraction	VuoListSubset_VuoInteraction (VuoList_VuoInteraction 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.
void	VuoListRemoveFirstValue_VuoInteraction (VuoList_VuoInteraction list)
	Removes the first item from list.
void	VuoListRemoveLastValue_VuoInteraction (VuoList_VuoInteraction list)
	Removes the last item from list.
void	VuoListRemoveAll_VuoInteraction (VuoList_VuoInteraction list)
	Removes all items from list.
void	VuoListRemoveValue_VuoInteraction (VuoList_VuoInteraction list, const unsigned long index)
	Removes the item at index.
unsigned long	VuoListGetCount_VuoInteraction (const VuoList_VuoInteraction list)
	Returns the number of items in list.
VuoList_VuoInteraction	VuoList_VuoInteraction_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new list.
struct json_object *	VuoList_VuoInteraction_getJson (const VuoList_VuoInteraction list)
	Encodes list as a JSON object.
char *	VuoList_VuoInteraction_getSummary (const VuoList_VuoInteraction list)
	Produces a brief human-readable summary of list.
void	VuoList_VuoInteraction_retain (VuoList_VuoInteraction list)
	Retains the list.
void	VuoList_VuoInteraction_release (VuoList_VuoInteraction list)
	Releases the list.
char *	VuoList_VuoInteraction_getString (const VuoList_VuoInteraction list)
	Automatically generated function.

Function Documentation

VuoList_VuoInteraction_getJson()

struct json_object * VuoList_VuoInteraction_getJson

(

const VuoList_VuoInteraction

list

)

Encodes list as a JSON object.

VuoList_VuoInteraction_getString()

char * VuoList_VuoInteraction_getString

(

const VuoList_VuoInteraction

list

)

Automatically generated function.

VuoList_VuoInteraction_getSummary()

char * VuoList_VuoInteraction_getSummary

(

const VuoList_VuoInteraction

list

)

Produces a brief human-readable summary of list.

VuoList_VuoInteraction_makeFromJson()

VuoList_VuoInteraction VuoList_VuoInteraction_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new list.

Example:

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

VuoList_VuoInteraction_release()

void VuoList_VuoInteraction_release

(

VuoList_VuoInteraction

list

)

Releases the list.

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

VuoList_VuoInteraction_retain()

void VuoList_VuoInteraction_retain

(

VuoList_VuoInteraction

list

)

Retains the list.

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

VuoListAppendValue_VuoInteraction()

void VuoListAppendValue_VuoInteraction	(	VuoList_VuoInteraction	list,
		const VuoInteraction	value
	)

Appends value to list.

VuoListCopy_VuoInteraction()

VuoList_VuoInteraction VuoListCopy_VuoInteraction

(

const VuoList_VuoInteraction

list

)

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

VuoListCreate_VuoInteraction()

VuoList_VuoInteraction VuoListCreate_VuoInteraction

(

void

)

Creates a new list of VuoInteraction items.

VuoListCreateWithCount_VuoInteraction()

VuoList_VuoInteraction VuoListCreateWithCount_VuoInteraction	(	const unsigned long	count,
		const VuoInteraction	value
	)

Creates a new list of count instances of value.

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

VuoListCreateWithValueArray_VuoInteraction()

VuoList_VuoInteraction VuoListCreateWithValueArray_VuoInteraction	(	const VuoInteraction *	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.

VuoListExchangeValues_VuoInteraction()

void VuoListExchangeValues_VuoInteraction	(	VuoList_VuoInteraction	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

VuoListForeach_VuoInteraction()

void VuoListForeach_VuoInteraction	(	const VuoList_VuoInteraction	list,
		bool(^)(const VuoInteraction value)	function
	)

Applies function to each item in list, 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.

VuoListGetCount_VuoInteraction()

unsigned long VuoListGetCount_VuoInteraction

(

const VuoList_VuoInteraction

list

)

Returns the number of items in list.

VuoListGetData_VuoInteraction()

VuoInteraction * VuoListGetData_VuoInteraction

(

const VuoList_VuoInteraction

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.

VuoListGetValue_VuoInteraction()

VuoInteraction VuoListGetValue_VuoInteraction	(	const VuoList_VuoInteraction	list,
		const unsigned long	index
	)

Returns the item at index.

Index values start at 1.

If the list has no items, returns a default value (an empty/zero value of VuoInteraction).

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_VuoInteraction or VuoListForeach_VuoInteraction.

VuoListInsertValue_VuoInteraction()

void VuoListInsertValue_VuoInteraction	(	const VuoList_VuoInteraction	list,
		const VuoInteraction	value,
		const unsigned long	index
	)

Inserts value 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.

VuoListPrependValue_VuoInteraction()

void VuoListPrependValue_VuoInteraction	(	VuoList_VuoInteraction	list,
		const VuoInteraction	value
	)

Prepends value to list.

VuoListRemoveAll_VuoInteraction()

void VuoListRemoveAll_VuoInteraction

(

VuoList_VuoInteraction

list

)

Removes all items from list.

VuoListRemoveFirstValue_VuoInteraction()

void VuoListRemoveFirstValue_VuoInteraction

(

VuoList_VuoInteraction

list

)

Removes the first item from list.

VuoListRemoveLastValue_VuoInteraction()

void VuoListRemoveLastValue_VuoInteraction

(

VuoList_VuoInteraction

list

)

Removes the last item from list.

VuoListRemoveValue_VuoInteraction()

void VuoListRemoveValue_VuoInteraction	(	VuoList_VuoInteraction	list,
		const unsigned long	index
	)

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

VuoListReverse_VuoInteraction()

void VuoListReverse_VuoInteraction

(

VuoList_VuoInteraction

list

)

Reverses the order of the items in list.

VuoListSetValue_VuoInteraction()

void VuoListSetValue_VuoInteraction	(	const VuoList_VuoInteraction	list,
		const VuoInteraction	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the item 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 items, it is expanded to accommodate the specified index. If index is 0, the list is resized to contain 1 item set to value.

VuoListShuffle_VuoInteraction()

void VuoListShuffle_VuoInteraction	(	VuoList_VuoInteraction	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.

VuoListSubset_VuoInteraction()

VuoList_VuoInteraction VuoListSubset_VuoInteraction	(	VuoList_VuoInteraction	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.