VuoList_VuoLoopType.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_VuoLoopType.h.

Go to the source code of this file.

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

Functions
VuoList_VuoLoopType	VuoListCreate_VuoLoopType (void)
	Creates a new list of VuoLoopType items.
VuoList_VuoLoopType	VuoListCreateWithCount_VuoLoopType (const unsigned long count, const VuoLoopType value)
	Creates a new list of count instances of value.
VuoList_VuoLoopType	VuoListCreateWithValueArray_VuoLoopType (const VuoLoopType *values, const unsigned long valueCount)
	Creates a new list containing the items in the C array values.
VuoList_VuoLoopType	VuoListCopy_VuoLoopType (const VuoList_VuoLoopType list)
	Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoLoopType	VuoListGetValue_VuoLoopType (const VuoList_VuoLoopType list, const unsigned long index)
	Returns the item at index.
VuoLoopType *	VuoListGetData_VuoLoopType (const VuoList_VuoLoopType list)
	Returns a pointer to a C array containing the list items.
void	VuoListForeach_VuoLoopType (const VuoList_VuoLoopType list, bool(^function)(const VuoLoopType value))
	Applies function to each item in list, serially in order of index.
void	VuoListSetValue_VuoLoopType (const VuoList_VuoLoopType list, const VuoLoopType value, const unsigned long index, bool expandListIfNeeded)
	Changes the item at index.
void	VuoListInsertValue_VuoLoopType (const VuoList_VuoLoopType list, const VuoLoopType value, const unsigned long index)
	Inserts value immediately before index.
void	VuoListPrependValue_VuoLoopType (VuoList_VuoLoopType list, const VuoLoopType value)
	Prepends value to list.
void	VuoListAppendValue_VuoLoopType (VuoList_VuoLoopType list, const VuoLoopType value)
	Appends value to list.
void	VuoListExchangeValues_VuoLoopType (VuoList_VuoLoopType list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at indexA with the value at indexB.
void	VuoListShuffle_VuoLoopType (VuoList_VuoLoopType list, const double chaos)
	Generates a random permutation of list.
void	VuoListReverse_VuoLoopType (VuoList_VuoLoopType list)
	Reverses the order of the items in list.
VuoList_VuoLoopType	VuoListSubset_VuoLoopType (VuoList_VuoLoopType 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_VuoLoopType (VuoList_VuoLoopType list)
	Removes the first item from list.
void	VuoListRemoveLastValue_VuoLoopType (VuoList_VuoLoopType list)
	Removes the last item from list.
void	VuoListRemoveAll_VuoLoopType (VuoList_VuoLoopType list)
	Removes all items from list.
void	VuoListRemoveValue_VuoLoopType (VuoList_VuoLoopType list, const unsigned long index)
	Removes the item at index.
unsigned long	VuoListGetCount_VuoLoopType (const VuoList_VuoLoopType list)
	Returns the number of items in list.
VuoList_VuoLoopType	VuoList_VuoLoopType_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new list.
struct json_object *	VuoList_VuoLoopType_getJson (const VuoList_VuoLoopType list)
	Encodes list as a JSON object.
char *	VuoList_VuoLoopType_getSummary (const VuoList_VuoLoopType list)
	Produces a brief human-readable summary of list.
void	VuoList_VuoLoopType_retain (VuoList_VuoLoopType list)
	Retains the list.
void	VuoList_VuoLoopType_release (VuoList_VuoLoopType list)
	Releases the list.
char *	VuoList_VuoLoopType_getString (const VuoList_VuoLoopType list)
	Automatically generated function.

Function Documentation

VuoList_VuoLoopType_getJson()

struct json_object * VuoList_VuoLoopType_getJson

(

const VuoList_VuoLoopType

list

)

Encodes list as a JSON object.

VuoList_VuoLoopType_getString()

char * VuoList_VuoLoopType_getString

(

const VuoList_VuoLoopType

list

)

Automatically generated function.

VuoList_VuoLoopType_getSummary()

char * VuoList_VuoLoopType_getSummary

(

const VuoList_VuoLoopType

list

)

Produces a brief human-readable summary of list.

VuoList_VuoLoopType_makeFromJson()

VuoList_VuoLoopType VuoList_VuoLoopType_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new list.

Example:

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

VuoList_VuoLoopType_release()

void VuoList_VuoLoopType_release

(

VuoList_VuoLoopType

list

)

Releases the list.

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

VuoList_VuoLoopType_retain()

void VuoList_VuoLoopType_retain

(

VuoList_VuoLoopType

list

)

Retains the list.

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

VuoListAppendValue_VuoLoopType()

void VuoListAppendValue_VuoLoopType	(	VuoList_VuoLoopType	list,
		const VuoLoopType	value
	)

Appends value to list.

VuoListCopy_VuoLoopType()

VuoList_VuoLoopType VuoListCopy_VuoLoopType

(

const VuoList_VuoLoopType

list

)

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

VuoListCreate_VuoLoopType()

VuoList_VuoLoopType VuoListCreate_VuoLoopType

(

void

)

Creates a new list of VuoLoopType items.

VuoListCreateWithCount_VuoLoopType()

VuoList_VuoLoopType VuoListCreateWithCount_VuoLoopType	(	const unsigned long	count,
		const VuoLoopType	value
	)

Creates a new list of count instances of value.

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

VuoListCreateWithValueArray_VuoLoopType()

VuoList_VuoLoopType VuoListCreateWithValueArray_VuoLoopType	(	const VuoLoopType *	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_VuoLoopType()

void VuoListExchangeValues_VuoLoopType	(	VuoList_VuoLoopType	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

VuoListForeach_VuoLoopType()

void VuoListForeach_VuoLoopType	(	const VuoList_VuoLoopType	list,
		bool(^)(const VuoLoopType 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_VuoLoopType()

unsigned long VuoListGetCount_VuoLoopType

(

const VuoList_VuoLoopType

list

)

Returns the number of items in list.

VuoListGetData_VuoLoopType()

VuoLoopType * VuoListGetData_VuoLoopType

(

const VuoList_VuoLoopType

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_VuoLoopType()

VuoLoopType VuoListGetValue_VuoLoopType	(	const VuoList_VuoLoopType	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 VuoLoopType).

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_VuoLoopType or VuoListForeach_VuoLoopType.

VuoListInsertValue_VuoLoopType()

void VuoListInsertValue_VuoLoopType	(	const VuoList_VuoLoopType	list,
		const VuoLoopType	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_VuoLoopType()

void VuoListPrependValue_VuoLoopType	(	VuoList_VuoLoopType	list,
		const VuoLoopType	value
	)

Prepends value to list.

VuoListRemoveAll_VuoLoopType()

void VuoListRemoveAll_VuoLoopType

(

VuoList_VuoLoopType

list

)

Removes all items from list.

VuoListRemoveFirstValue_VuoLoopType()

void VuoListRemoveFirstValue_VuoLoopType

(

VuoList_VuoLoopType

list

)

Removes the first item from list.

VuoListRemoveLastValue_VuoLoopType()

void VuoListRemoveLastValue_VuoLoopType

(

VuoList_VuoLoopType

list

)

Removes the last item from list.

VuoListRemoveValue_VuoLoopType()

void VuoListRemoveValue_VuoLoopType	(	VuoList_VuoLoopType	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_VuoLoopType()

void VuoListReverse_VuoLoopType

(

VuoList_VuoLoopType

list

)

Reverses the order of the items in list.

VuoListSetValue_VuoLoopType()

void VuoListSetValue_VuoLoopType	(	const VuoList_VuoLoopType	list,
		const VuoLoopType	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_VuoLoopType()

void VuoListShuffle_VuoLoopType	(	VuoList_VuoLoopType	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_VuoLoopType()

VuoList_VuoLoopType VuoListSubset_VuoLoopType	(	VuoList_VuoLoopType	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.