→ home

→ index of namespace default

→ index of project core

→ index of module core

Class `core.PointerArray`

Synopsis: An heterogenous array of objects.

Base classes:

core.Object

Methods:

add(Object o) : boolean - Add the given object to the arraylist.
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(int index) - Delete the element at the given index.
empty() - Reset the number of used elements, numElements, to 0.
free() - Free array elements.
get(int index) : Object - Return a reference to the given array element.
getDeref(int index) : Object - Return a (deletable) reference to the given array element.
getFirst() : Object - Return first array element.
getLast() : Object - Return last used array element.
getMaxElements() : int - Return the total number of elements.
getNextFree() : Object - Return a reference to the next free array element.
getNumElements() : int - Return the number of used elements.
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(int index, Object o) : boolean - Insert the given object into the arraylist.
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.
remove(Object o) : boolean - Remove the given object from the arraylist.
reverse() - Reverse element order.
setNumElements(int num) - Set the number of used elements.
swap(int indexA, indexB) : boolean - Swap two array elements.
useAll() - Mark all array elements used, i.e. set numElements = maxElements.

Description:

A "deleteme" flag is stored with each element.
Object class types may be arbitrarily mixed.

See also:

ObjectArray

→ top of page

Method add

Add the given object to the arraylist.

Signature

add	(	Object	o	)
	:	boolean

Arguments

Object o – The object to add to the arraylist. If o is a Value object, the contained (deletable) object will be released from the Value container.

Returns

boolean

–

true if the object has been added successfully, false otherwise.

Description

The array will be resized as required.

See also:

→ 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 if the allocation succeeded, false otherwise.

Description

The number of used elements, numElements, will be reset to 0.

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 the element at the given index.

Signature

delete

(

int

index

)

Arguments

int

index

–

Which element to delete

See also:

→ top of page

Method empty

Reset the number of used elements, numElements, to 0.

Signature

empty

(

)

Description

This will reset the number of used elements, numElements, back to 0.

See also:

→ top of page

Method free

Free array elements.

Signature

free

(

)

See also:

→ top of page

Method get

Return a reference to the given array element.

Signature

get	(	int	index	)
	:	Object

Arguments

int

index

–

Which element to return

Returns

Object

–

Reference to array element.

Description

This will silently return null if "index" is out of bounds.

See also:

getDeref()

→ top of page

Method getDeref

Return a (deletable) reference to the given array element.

Signature

getDeref	(	int	index	)
	:	Object

Arguments

int

index

–

Which element to return

Returns

Object

–

(deletable) reference to array element

Description

This will silently return null if "index" is out of bounds.

See also:

get()

→ top of page

Method getFirst

Return first array element.

Signature

getFirst

(

)

Object

Returns

Object

–

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

→ top of page

Method getLast

Return last used array element.

Signature

getLast

(

)

Object

Returns

Object

–

Last used array element (numElements - 1) or null 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 getNextFree

Return a reference to the next free array element.

Signature

getNextFree

(

)

Object

Returns

Object

–

Reference to next free element.

Description

This will increase the number of used elements, numElements.

See also:

→ top of page

Method getNumElements

Return the number of used elements.

Signature

getNumElements

(

)

int

Returns

int

–

Number of used elements

See also:

→ 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 the given object into the arraylist.

Signature

insert	(	int	index	,
		Object	o
		)
	:	boolean

Arguments

int	index	–	Where to insert the object
Object	o	–	The object to add. If "o" is a `Value` object, the contained (deletable) object will be released from the Value container.

Returns

boolean

–

true if the object has been inserted successfully, false otherwise.

Description

The array will be resized as required.

See also:

→ 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 provided for 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 if the reallocation succeeded, false otherwise.

Description

Element will be discarded/added as required.

See also:

→ top of page

Method remove

Remove the given object from the arraylist.

Signature

remove	(	Object	o	)
	:	boolean

Arguments

Object

–

The object to remove.

Returns

boolean

–

true if the object has been removed successfully, false otherwise.

Description

The array will be searched for an entry matching the given object address.

See also:

→ top of page

Method reverse

Reverse element order.

Signature

reverse

(

)

→ top of page

Method setNumElements

Set the number of used elements.

Signature

setNumElements

(

int

num

)

Arguments

int

num

–

New number of used elements

Description

This will not reallocate the array.

See also:

→ top of page

Method swap

Swap two array elements.

Signature

swap	(	int	indexA	,
		int	indexB
		)
	:	boolean

Arguments

int	indexA	–	Index of first element
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` , `List` , `ListNode` , `Long` , `Mailbox` , `Mutex` , `Object` , `ObjectArray` , `PakFile` , `PointerArray` , `Pool` , `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` , `mathClampf` , `mathClampi` , `mathDistancePointPlane2d` , `mathLerpf` , `mathMaxf` , `mathMaxi` , `mathMinf` , `mathMini` , `mathPowerf` , `mathPoweri` , `mathSmoothStepf` , `mathWrapf` , `mathWrapi` , `milliSeconds` , `psystem` , `putenv` , `srand` , `system` , `ucchar`
All Namespaces:	`default` , `ui`
All Projects:	`core` , `debugtext` , `tkfreetype2` , `tkmath` , `tkmidi` , `tkopengl` , `tkportaudio` , `tksdl` , `tkui` , `tkunit`

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54

Class core.PointerArray

Class `core.PointerArray`