default
core
core
core.PointerArray
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.
A "deleteme" flag is stored with each element.
Object class types may be arbitrarily mixed.
Method add | ||||||||||
Add the given object to the arraylist. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
The array will be resized as required. |
Method alloc | ||||||||||
Allocate the given number of array elements. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
The number of used elements, numElements, will be reset to 0. |
Method containsObject | ||||||||||
Check whether array contains an object that equals the given object. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method containsPointer | ||||||||||
Check whether array contains the given object address. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method delete | |||||
Delete the element at the given index. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method empty | |||
Reset the number of used elements, numElements, to 0. | |||
Signature | |||
| |||
Description | |||
This will reset the number of used elements, numElements, back to 0. |
Method free | |||
Free array elements. | |||
Signature | |||
|
Method get | ||||||||||
Return a reference to the given array element. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
This will silently return null if "index" is out of bounds. |
Method getDeref | ||||||||||
Return a (deletable) reference to the given array element. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
This will silently return null if "index" is out of bounds. |
Method getFirst | |||||
Return first array element. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getLast | |||||
Return last used array element. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMaxElements | |||||
Return the total number of elements. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getNextFree | |||||
Return a reference to the next free array element. | |||||
Signature | |||||
| |||||
Returns | |||||
| |||||
Description | |||||
This will increase the number of used elements, numElements. |
Method getNumElements | |||||
Return the number of used elements. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getString | |||||
Return a string representation of this array. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method indexOfObject | ||||||||||
Return the index of the element that equals the given object. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method indexOfPointer | ||||||||||
Return the index of the element that points to the given object. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method insert | ||||||||||||||||||||
Insert the given object into the arraylist. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Description | ||||||||||||||||||||
The array will be resized as required. |
Method joinArrays | ||||||||||||||||||||||||
Join arrays 'a' and 'b'. | ||||||||||||||||||||||||
Signature | ||||||||||||||||||||||||
Arguments | ||||||||||||||||||||||||
| ||||||||||||||||||||||||
Returns | ||||||||||||||||||||||||
| ||||||||||||||||||||||||
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)) |
Method joinCC | |||
Join arrays a and b. Copy elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinCD | |||
Join arrays a and b. Copy 'A' elements, dereference 'B' elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinCR | |||
Join arrays a and b. Copy 'A' elements, reference 'B' elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinDC | |||
Join arrays a and b. Dereference 'A' elements, copy 'B' elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinDD | |||
Join arrays a and b. Dereference elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinDR | |||
Join arrays a and b. Dereference 'A' elements, reference 'B' elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinRC | |||
Join arrays a and b. Reference 'A' elements, copy 'B' elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinRD | |||
Join arrays a and b. Reference 'A' elements, dereference 'B' elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method joinRR | |||
Join arrays a and b. Reference elements. | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method realloc | ||||||||||
Resize array. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
Element will be discarded/added as required. |
Method remove | ||||||||||
Remove the given object from the arraylist. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Description | ||||||||||
The array will be searched for an entry matching the given object address. |
Method reverse | |||
Reverse element order. | |||
Signature | |||
|
Method setNumElements | |||||
Set the number of used elements. | |||||
Signature | |||||
| |||||
Arguments | |||||
| |||||
Description | |||||
This will not reallocate the array. |
Method swap | ||||||||||||||||||||
Swap two array elements. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method useAll | |||
Mark all array elements used, i.e. set numElements = maxElements. | |||
Signature | |||
|
auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54