→ index of namespace default

→ index of project core

→ index of module core

Class `core.ValueArray`

Synopsis: An array of dynamically typed script values.

Base classes:

core.Object

Methods:

add(Value val) - Add new Value.
addVoid() - Add void value.
alloc(int max) : boolean - Allocate the given number of array elements.
containsObject(Object o) : boolean - Check whether array contains an object that equals the given object.
containsPointer(Object o) : boolean - Check whether array contains the given object address.
delete() - Delete Value at index
empty() - Reset number of elements.
free() - Free all array elements.
get(int index) : var - Return the given array element.
getDeref(int index) : var - Return the given (deletable) array element.
getFirst() : var - Return first array element.
getLast() : var - Return last used array element.
getMaxElements() : int - Return the total number of elements.
getNumElements() : int - Return the number of used elements, numElements.
getRev(int index) : var - Return the array element at (numElements - 1 - index).
getString() : String - Return a string representation of this array.
indexOfObject(Object o) : int - Return the index of the element that equals the given object.
indexOfPointer(Object o) : int - Return the index of the element that points to the given object.
insert() - Insert Value at index
isEmpty() : boolean - Check if array is empty (numElements == 0).
joinArrays(Object a, b, boolean bCopyA, bCopyB, bUnlinkA, bUnlinkB) : boolean - Join arrays 'a' and 'b'.
joinCC(Object a, b) : boolean - Join arrays a and b. Copy elements.
joinCD(Object a, b) : boolean - Join arrays a and b. Copy 'A' elements, dereference 'B' elements.
joinCR(Object a, b) : boolean - Join arrays a and b. Copy 'A' elements, reference 'B' elements.
joinDC(Object a, b) : boolean - Join arrays a and b. Dereference 'A' elements, copy 'B' elements.
joinDD(Object a, b) : boolean - Join arrays a and b. Dereference elements.
joinDR(Object a, b) : boolean - Join arrays a and b. Dereference 'A' elements, reference 'B' elements.
joinRC(Object a, b) : boolean - Join arrays a and b. Reference 'A' elements, copy 'B' elements.
joinRD(Object a, b) : boolean - Join arrays a and b. Reference 'A' elements, dereference 'B' elements.
joinRR(Object a, b) : boolean - Join arrays a and b. Reference elements.
realloc(int max) : boolean - Resize array.
reverse() - Reverse element order
set(int index, Object val) - Set element at "index" to "val".
setNumElements(int num) - Set the number of used elements.
setRev(int index, Object val) - Set element at (numElements - 1 - index) to "val".
swap(int indexB) : boolean - Swap two array elements.
useAll() - Mark all array elements used, i.e. set numElements = maxElements.

See also:

Value

Method add

Add new Value.

Signature

add

(

Value

val

)

Arguments

Value

val

–

→ top of page

Method addVoid

Add void value.

Signature

addVoid

(

)

→ top of page

Method alloc

Allocate the given number of array elements.

Signature

alloc	(	int	max	)
	:	boolean

Arguments

int

max

–

Total number of elements to allocate

Returns

boolean

–

true when the allocation succeeded, false otherwise.

See also:

→ top of page

Method containsObject

Check whether array contains an object that equals the given object.

Signature

containsObject	(	Object	o	)
	:	boolean

Arguments

Object o – The object to compare with. Object.yacEquals() is used for comparisons.

Returns

boolean

–

true if a matching object was found, false otherwise.

See also:

indexOfObject()

→ top of page

Method containsPointer

Check whether array contains the given object address.

Signature

containsPointer	(	Object	o	)
	:	boolean

Arguments

Object

–

The object (address) to compare with.

Returns

boolean

–

true if a matching object was found, false otherwise.

See also:

indexOfPointer()

→ top of page

Method delete

Delete Value at index

Signature

delete

(

)

→ top of page

Method empty

Reset number of elements.

Signature

empty

(

)

See also:

→ top of page

Method free

Free all array elements.

Signature

free

(

)

See also:

→ top of page

Method get

Return the given array element.

Signature

get	(	int	index	)
	:	var

Arguments

int

index

–

Which array element to return

Returns

var – element value (non-deletable reference if the element holds an Object)

Description

Silently return void if the given index is out of bounds.

See also:

getDeref()

→ top of page

Method getDeref

Return the given (deletable) array element.

Signature

getDeref	(	int	index	)
	:	var

Arguments

int

index

–

Which array element to return

Returns

var – element value (deletable reference if the elements holds an Object)

Description

Silently return void if the given index is out of bounds.

See also:

get()

→ top of page

Method getFirst

Return first array element.

Signature

getFirst

(

)

var

Returns

var

–

First array element or void if the array is empty. Objects are returned as non-deletable references.

→ top of page

Method getLast

Return last used array element.

Signature

getLast

(

)

var

Returns

var

–

Last used array element (numElements - 1) or void if the array is empty. Objects are returned as non-deletable references.

→ top of page

Method getMaxElements

Return the total number of elements.

Signature

getMaxElements

(

)

int

Returns

int

–

Total number of elements

See also:

→ top of page

Method getNumElements

Return the number of used elements, numElements.

Signature

getNumElements

(

)

int

Returns

int

–

Number of used elements

See also:

→ top of page

Method getRev

Return the array element at (numElements - 1 - index).

Signature

getRev	(	int	index	)
	:	var

Arguments

int

index

–

Which array element to return

Returns

var – element value (non-deletable reference if the element holds an Object)

Description

Silently return void if the given index is out of bounds.

See also:

getDeref()

→ top of page

Method getString

Return a string representation of this array.

Signature

getString

(

)

String

Returns

String

–

new String instance holding a string representation of this array.

→ top of page

Method indexOfObject

Return the index of the element that equals the given object.

Signature

indexOfObject	(	Object	o	)
	:	int

Arguments

Object

–

The object to look for

Returns

int

–

Array index or -1 if no matching object was found in this array

See also:

containsObject()

→ top of page

Method indexOfPointer

Return the index of the element that points to the given object.

Signature

indexOfPointer	(	Object	o	)
	:	int

Arguments

Object

–

The object pointer to look for

Returns

int

–

Array index or -1 if the object address was not found in this array

See also:

containsPointer()

→ top of page

Method insert

Insert Value at index

Signature

insert

(

)

→ top of page

Method isEmpty

Check if array is empty (numElements == 0).

Signature

isEmpty

(

)

boolean

Returns

boolean

–

→ top of page

Method joinArrays

Join arrays 'a' and 'b'.

Signature

joinArrays	(	Object	a	,
		Object	b	,
		boolean	bCopyA	,
		boolean	bCopyB	,
		boolean	bUnlinkA	,
		boolean	bUnlinkB
		)
	:	boolean

Arguments

Object	a	–	Other array (or this, or null)
Object	b	–	Other array (or this, or null)
boolean	bCopyA	–	If true, copy/duplicate array 'a' object values
boolean	bCopyB	–	If true, copy/duplicate array 'b' object values
boolean	bUnlinkA	–	If true, unlink object values from array 'a'. Takes precedence over bCopyA.
boolean	bUnlinkB	–	If true, unlink object values from array 'b'. Takes precedence over bCopyA.

Returns

boolean

–

True if arrays were joined. False when new array elements could not be allocated.

Description

If none of the copy/unlink flags is set, object values will be copied by reference.
In case that 'a' or 'b' is 'this', object values will always be unlinked ("deref").
The joinCC(), joinCR(), joinCD(), joinRR(), joinRC(), joinRC(), joinRD(), joinDD(), joinDC(), joinDC() are providedfor reasons of convenience (permutations of the copyA/copyB/unlinkA/unlinkB arguments).
(C=copy, R=reference, D=deref (unlink))

→ top of page

Method joinCC

Join arrays a and b. Copy elements.

Signature

joinCC	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinCD

Join arrays a and b. Copy 'A' elements, dereference 'B' elements.

Signature

joinCD	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinCR

Join arrays a and b. Copy 'A' elements, reference 'B' elements.

Signature

joinCR	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinDC

Join arrays a and b. Dereference 'A' elements, copy 'B' elements.

Signature

joinDC	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinDD

Join arrays a and b. Dereference elements.

Signature

joinDD	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinDR

Join arrays a and b. Dereference 'A' elements, reference 'B' elements.

Signature

joinDR	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinRC

Join arrays a and b. Reference 'A' elements, copy 'B' elements.

Signature

joinRC	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinRD

Join arrays a and b. Reference 'A' elements, dereference 'B' elements.

Signature

joinRD	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method joinRR

Join arrays a and b. Reference elements.

Signature

joinRR	(	Object	a	,
		Object	b
		)
	:	boolean

Arguments

Object	a	–
Object	b	–

Returns

boolean

–

→ top of page

Method realloc

Resize array.

Signature

realloc	(	int	max	)
	:	boolean

Arguments

int

max

–

New total number of elements

Returns

boolean

–

true when the reallocation succeeded, false otherwise.

Description

Elements will be discarded/added as required.

See also:

→ top of page

Method reverse

Reverse element order

Signature

reverse

(

)

→ top of page

Method set

Set element at "index" to "val".

Signature

set	(	int	index	,
		Object	val
		)

Arguments

int	index	–	Array index
Object	val	–	New value

Description

Updates numElements when index exceeds it (>=).
Silently do nothing when index exceed array size (>= maxElements).
Transfers pointer ownership if "val" is a Value object which stores a deletable object.

→ top of page

Method setNumElements

Set the number of used elements.

Signature

setNumElements

(

int

num

)

Arguments

int

num

–

New number of used elements

See also:

→ top of page

Method setRev

Set element at (numElements - 1 - index) to "val".

Signature

setRev	(	int	index	,
		Object	val
		)

Arguments

int	index	–	Array index
Object	val	–	New value

Description

Silently do nothing when index exceed array size (>= maxElements).
Transfers pointer ownership if "val" is a Value object which stores a deletable object.

→ top of page

Method swap

Swap two array elements.

Signature

swap	(	int	indexB	)
	:	boolean

Arguments

int

indexB

–

Index of second element

Returns

boolean

–

true if the elements have been swapped successfully, false otherwise.

→ top of page

Method useAll

Mark all array elements used, i.e. set numElements = maxElements.

Signature

useAll

(

)

→ top of page

Project Modules:	`core`
Project Classes:	`Boolean` , `Buffer` , `Byte` , `Class` , `ClassArray` , `Condition` , `Configuration` , `Double` , `DummyStream` , `Envelope` , `Event` , `Exception` , `File` , `Float` , `FloatArray` , `FloatArray128` , `FloatArray16` , `FloatArray32` , `FloatArray64` , `FloatArray8` , `Function` , `HashTable` , `IntArray` , `IntArray128` , `IntArray16` , `IntArray32` , `IntArray64` , `IntArray8` , `Integer` , `LFSR` , `LFSR_NR` , `List` , `ListNode` , `Long` , `Mailbox` , `Mutex` , `Object` , `ObjectArray` , `PakFile` , `PointerArray` , `Pool` , `Process` , `Script` , `SharedBuffer` , `Short` , `Stack` , `StdErrStream` , `StdInStream` , `StdOutStream` , `Stream` , `String` , `String128` , `String16` , `String32` , `String64` , `String8` , `StringArray` , `StringIterator` , `Thread` , `Time` , `TKS` , `TreeNode` , `UnsignedByte` , `UnsignedInteger` , `UnsignedLong` , `UnsignedShort` , `Value` , `ValueArray` , `Variable`
Project Functions:	`ceil` , `exit` , `floor` , `GetCurrentThread` , `getenv` , `lcchar` , `mathAbsMaxf` , `mathAbsMinf` , `mathAbsMini` , `mathAbsMini` , `mathCerpf` , `mathClampf` , `mathClampi` , `mathDistancePointPlane2d` , `mathFoldf` , `mathFoldi` , `mathGCD` , `mathLerpCyclicf` , `mathLerpf` , `mathMaxf` , `mathMaxi` , `mathMinf` , `mathMini` , `mathNextCyclicf` , `mathPowerf` , `mathPowerfC` , `mathPoweri` , `mathSerpf` , `mathSmoothStepf` , `mathSmoothStepNf` , `mathWrapf` , `mathWrapi` , `milliSeconds` , `milliSecondsDouble` , `psystem` , `putenv` , `srand` , `system` , `ucchar`
All Namespaces:	`default` , `graph` , `ui`
All Projects:	`core` , `eqxmms` , `ShaderVG` , `ShaderVG_Text` , `tkanalogrytm` , `tkchipmunk` , `tkclap` , `tkfileutils` , `tkfreeglut` , `tkfreetype2` , `tkfreeverb` , `tkmath` , `tkmidi` , `tkmidipipe` , `tkminnie` , `tkoldmath` , `tkopengl` , `tkportaudio` , `tkradiastools` , `tksamplechain` , `tksampleedit` , `tksampler` , `tksdl` , `tksdl_net` , `tksidplay2` , `tkspeexdsp` , `tksqlite` , `tktriangulate` , `tkui` , `tkvst2` , `tkzip` , `ui` , `yingtest`

auto-generated by "DOG", the TkScript document generator. Thu, 11/Dec/2025 13:41:59

Class core.ValueArray

Class `core.ValueArray`