VuoList_VuoTextComparison

Description

A list of VuoTextComparison elements.

Classes
struct	VuoList_VuoTextComparison_struct
	A list of VuoTextComparison elements. More...

Typedefs
typedef struct VuoList_VuoTextComparison_struct *	VuoList_VuoTextComparison
	A list of VuoTextComparison elements.

Functions
VuoList_VuoTextComparison	VuoListCreate_VuoTextComparison (void)
	Creates a new list of VuoTextComparison elements.
VuoList_VuoTextComparison	VuoListCreateWithCount_VuoTextComparison (const unsigned long count, const VuoTextComparison value)
	Creates a new list of count instances of value.
VuoList_VuoTextComparison	VuoListCopy_VuoTextComparison (const VuoList_VuoTextComparison list)
	Makes a shallow copy of list — its items are retained (not copied) by the new list.
VuoTextComparison	VuoListGetValue_VuoTextComparison (const VuoList_VuoTextComparison list, const unsigned long index)
	Returns the VuoTextComparison at index.
VuoTextComparison *	VuoListGetData_VuoTextComparison (const VuoList_VuoTextComparison list)
	Returns a pointer to a C array containing the list items.
void	VuoListSetValue_VuoTextComparison (const VuoList_VuoTextComparison list, const VuoTextComparison value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoTextComparison at index.
void	VuoListInsertValue_VuoTextComparison (const VuoList_VuoTextComparison list, const VuoTextComparison value, const unsigned long index)
	Inserts the VuoTextComparison immediately before index.
void	VuoListPrependValue_VuoTextComparison (VuoList_VuoTextComparison list, const VuoTextComparison value)
	Prepends value to list.
void	VuoListAppendValue_VuoTextComparison (VuoList_VuoTextComparison list, const VuoTextComparison value)
	Appends value to list.
void	VuoListExchangeValues_VuoTextComparison (VuoList_VuoTextComparison list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at indexA with the value at indexB.
void	VuoListShuffle_VuoTextComparison (VuoList_VuoTextComparison list, const double chaos)
	Generates a random permutation of list.
void	VuoListReverse_VuoTextComparison (VuoList_VuoTextComparison list)
	Reverses the order of the items in list.
VuoList_VuoTextComparison	VuoListSubset_VuoTextComparison (VuoList_VuoTextComparison 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_VuoTextComparison (VuoList_VuoTextComparison list)
	Removes the first value from list.
void	VuoListRemoveLastValue_VuoTextComparison (VuoList_VuoTextComparison list)
	Removes the last value from list.
void	VuoListRemoveAll_VuoTextComparison (VuoList_VuoTextComparison list)
	Removes all values from list.
void	VuoListRemoveValue_VuoTextComparison (VuoList_VuoTextComparison list, const unsigned long index)
	Removes the VuoTextComparison at index.
unsigned long	VuoListGetCount_VuoTextComparison (const VuoList_VuoTextComparison list)
	Returns the number of elements in list.
VuoList_VuoTextComparison	VuoList_VuoTextComparison_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value.
struct json_object *	VuoList_VuoTextComparison_getJson (const VuoList_VuoTextComparison value)
	Encodes value as a JSON object.
char *	VuoList_VuoTextComparison_getSummary (const VuoList_VuoTextComparison value)
	Produces a brief human-readable summary of value.
VuoList_VuoTextComparison	VuoList_VuoTextComparison_makeFromString (const char *str)
	Automatically generated function.
char *	VuoList_VuoTextComparison_getString (const VuoList_VuoTextComparison value)
	Automatically generated function.

---

Class Documentation

struct VuoList_VuoTextComparison_struct

Class Members
void *	l

Typedef Documentation

typedef struct VuoList_VuoTextComparison_struct * VuoList_VuoTextComparison

A list of VuoTextComparison elements.

Function Documentation

struct json_object* VuoList_VuoTextComparison_getJson ( const VuoList_VuoTextComparison  value )

read

Encodes value as a JSON object.

char* VuoList_VuoTextComparison_getString

(

const VuoList_VuoTextComparison

value

)

Automatically generated function.

char* VuoList_VuoTextComparison_getSummary

(

const VuoList_VuoTextComparison

value

)

Produces a brief human-readable summary of value.

VuoList_VuoTextComparison VuoList_VuoTextComparison_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

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

VuoList_VuoTextComparison VuoList_VuoTextComparison_makeFromString

(

const char *

str

)

Automatically generated function.

void VuoListAppendValue_VuoTextComparison	(	VuoList_VuoTextComparison	list,
		const VuoTextComparison	value
	)

Appends value to list.

VuoList_VuoTextComparison VuoListCopy_VuoTextComparison

(

const VuoList_VuoTextComparison

list

)

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

VuoList_VuoTextComparison VuoListCreate_VuoTextComparison

(

void

)

Creates a new list of VuoTextComparison elements.

VuoList_VuoTextComparison VuoListCreateWithCount_VuoTextComparison	(	const unsigned long	count,
		const VuoTextComparison	value
	)

Creates a new list of count instances of value.

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

void VuoListExchangeValues_VuoTextComparison	(	VuoList_VuoTextComparison	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoTextComparison

(

const VuoList_VuoTextComparison

list

)

Returns the number of elements in list.

VuoTextComparison* VuoListGetData_VuoTextComparison

(

const VuoList_VuoTextComparison

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.

VuoTextComparison VuoListGetValue_VuoTextComparison	(	const VuoList_VuoTextComparison	list,
		const unsigned long	index
	)

Returns the VuoTextComparison 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_VuoTextComparison	(	const VuoList_VuoTextComparison	list,
		const VuoTextComparison	value,
		const unsigned long	index
	)

Inserts the VuoTextComparison 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_VuoTextComparison	(	VuoList_VuoTextComparison	list,
		const VuoTextComparison	value
	)

Prepends value to list.

void VuoListRemoveAll_VuoTextComparison

(

VuoList_VuoTextComparison

list

)

Removes all values from list.

void VuoListRemoveFirstValue_VuoTextComparison

(

VuoList_VuoTextComparison

list

)

Removes the first value from list.

void VuoListRemoveLastValue_VuoTextComparison

(

VuoList_VuoTextComparison

list

)

Removes the last value from list.

void VuoListRemoveValue_VuoTextComparison	(	VuoList_VuoTextComparison	list,
		const unsigned long	index
	)

Removes the VuoTextComparison 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_VuoTextComparison

(

VuoList_VuoTextComparison

list

)

Reverses the order of the items in list.

void VuoListSetValue_VuoTextComparison	(	const VuoList_VuoTextComparison	list,
		const VuoTextComparison	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoTextComparison 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.

void VuoListShuffle_VuoTextComparison	(	VuoList_VuoTextComparison	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.

VuoList_VuoTextComparison VuoListSubset_VuoTextComparison	(	VuoList_VuoTextComparison	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.