org.abora.white.collection.arrays
Class IntegerVarArray

java.lang.Object
  |
  +--org.abora.white.xpp.basic.Heaper
        |
        +--org.abora.white.collection.arrays.PrimArray
              |
              +--org.abora.white.collection.arrays.PrimArithmeticArray
                    |
                    +--org.abora.white.collection.arrays.PrimIntegerArray
                          |
                          +--org.abora.white.collection.arrays.IntegerVarArray

public class IntegerVarArray

extends PrimIntegerArray

Constructor Summary

protected	IntegerVarArray(int count)
protected	IntegerVarArray(IntegerValue[] source)
protected	IntegerVarArray(int size, PrimArray from, int sourceOffset, int count, int destOffset)

Method Summary

protected void	addData(int start, PrimArithmeticArray other, int otherStart, int count) Arithmetic addition of the respective elements of other to this over the specified index range.
protected int	compareData(int start, PrimArithmeticArray other, int otherStart, int count) Over given range, returns - if this < other; 0 if this == other; + if this > other.
protected void	copyElements(int to, PrimArray source, int from, int count) Copy the respective elements of other to this over the specified index range.
void	copyToBuffer(IntegerValue[] buffer, int count, int start)
int	count() Return the number of elements the array can hold.
Heaper	fetchValue(int index) Fetch a value; may be a Heaper, null, or a PrimValue as appropriate to PrimArray subclass.
IntegerValue	integerAt(int index) Fetch an integer value at the specified index.
IntegerValue	integerVarAt(int index) Get an actual integer value
static IntegerVarArray	make(int count) create an IntegerVarArray filled with zeros
static IntegerVarArray	make(IntegerValue[] buffer) create an IntegerVarArray filled with the data at 'buffer'
static IntegerVarArray	make(int size, PrimArray from)
static IntegerVarArray	make(int size, PrimArray from, int sourceOffset)
static IntegerVarArray	make(int size, PrimArray from, int sourceOffset, int count)
static IntegerVarArray	make(int size, PrimArray from, int sourceOffset, int count, int destOffset) create an IntegerVarArray filled with the indicated data in 'from'
static IntegerVarArray	make(PrimArray from)
protected PrimArray	makeNew(int size, PrimArray source, int sourceOffset, int count, int destOffset) Return a new array of the same type as this initialized with the elements of source specified by the index range, prepended by destOffset and postpended by null or 0 elements.
protected void	printElementOn(int index, java.io.PrintWriter oo) Print a representation of the element at the given index.
protected int	signOfNonZeroAfter(int index) Return the sign, -1 or +1, of the next non-zero element after start, or 0 if no such element.
PrimSpec	spec() A description of the kinds of things which can be stored in this array
void	storeInteger(int index, IntegerValue value) Store an integer value at the specified index.
void	storeIntegerVar(int index, IntegerValue value) Store an actual integer value
void	storeValue(int index, Heaper value) Store a value; may be a Heaper, null, or a PrimValue as appropriate to PrimArray subclass.
protected void	subtractData(int start, PrimArithmeticArray other, int otherStart, int count) Subtract the respective elements of other from this over the given index range.

Methods inherited from class org.abora.white.collection.arrays.PrimIntegerArray

elementsHash, hold, hold, indexOf, indexOfInteger, indexOfInteger, indexOfInteger, indexPast, indexPastInteger, indexPastInteger, indexPastInteger, storeAll, zeroElement

Methods inherited from class org.abora.white.collection.arrays.PrimArithmeticArray

addElements, addElements, addElements, compare, compare, compare, compare, contentsEqual, elementsEqual, subtractElements, subtractElements, subtractElements

Methods inherited from class org.abora.white.collection.arrays.PrimArray

contentsHash, copy, copy, copy, copy, copy, copyGrow, elementsEqual, elementsEqual, elementsHash, elementsHash, getValue, indexOf, indexOf, indexOfElements, indexOfElements, indexOfElements, indexOfElements, indexOfElements, indexPast, indexPast, isEqual, printOn, storeAll, storeAll, storeMany, storeMany, storeMany, zeroElements, zeroElements, zeroElements

Methods inherited from class org.abora.white.xpp.basic.Heaper

actualHashForEqual, destroy, destruct, equals, hashForEqual, printContentsOn, sendSelfTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegerVarArray

protected IntegerVarArray(int count)

IntegerVarArray

protected IntegerVarArray(int size,
                          PrimArray from,
                          int sourceOffset,
                          int count,
                          int destOffset)

IntegerVarArray

protected IntegerVarArray(IntegerValue[] source)

Method Detail

make

public static IntegerVarArray make(int count)

create an IntegerVarArray filled with zeros

make

public static IntegerVarArray make(int size,
                                   PrimArray from,
                                   int sourceOffset,
                                   int count,
                                   int destOffset)

create an IntegerVarArray filled with the indicated data in 'from'

make

public static IntegerVarArray make(int size,
                                   PrimArray from,
                                   int sourceOffset,
                                   int count)

make

public static IntegerVarArray make(int size,
                                   PrimArray from,
                                   int sourceOffset)

make

public static IntegerVarArray make(int size,
                                   PrimArray from)

make

public static IntegerVarArray make(PrimArray from)

make

public static IntegerVarArray make(IntegerValue[] buffer)

create an IntegerVarArray filled with the data at 'buffer'

makeNew

protected PrimArray makeNew(int size,
                            PrimArray source,
                            int sourceOffset,
                            int count,
                            int destOffset)

Description copied from class: PrimArray

Return a new array of the same type as this initialized with the elements of source specified by the index range, prepended by destOffset and postpended by null or 0 elements.

Specified by:

makeNew in class PrimArray

Parameters:

size - size of new array.

source - source of elements to be initialized with in the new array.

sourceOffset - first index of the source array to be included in the range.

count - number of elements of source to include in the new array

destOffset - first index of new array to be initialized with source elements.

Returns:

the new array.

storeIntegerVar

public void storeIntegerVar(int index,
                            IntegerValue value)

Store an actual integer value

integerVarAt

public IntegerValue integerVarAt(int index)

Get an actual integer value

storeInteger

public void storeInteger(int index,
                         IntegerValue value)

Description copied from class: PrimIntegerArray

Store an integer value at the specified index.

Specified by:

storeInteger in class PrimIntegerArray

Parameters:

index - index in array the element will be stored at.

value - integer to store in this.

integerAt

public IntegerValue integerAt(int index)

Description copied from class: PrimIntegerArray

Fetch an integer value at the specified index.

Specified by:

integerAt in class PrimIntegerArray

Parameters:

index - index in array whose element will be returned

Returns:

the integer at the specified index.

storeValue

public void storeValue(int index,
                       Heaper value)

Description copied from class: PrimArray

Store a value; may be a Heaper, null, or a PrimValue as appropriate to PrimArray subclass. An exception will be throw if the value is not compatible with the elements this can hold.

It is expected that most PrimArray clients will want to use less abstract access methods

Specified by:

storeValue in class PrimArray

Parameters:

index - index in array the element will be stored at.

value - heaper to store in this.

fetchValue

public Heaper fetchValue(int index)

Description copied from class: PrimArray

Fetch a value; may be a Heaper, null, or a PrimValue as appropriate to PrimArray subclass.

It is expected that most PrimArray clients will want to use less abstract access methods.

Specified by:

fetchValue in class PrimArray

Parameters:

index - index in array whose element will be returned

Returns:

the heaper at the specified index.

spec

public PrimSpec spec()

Description copied from class: PrimArray

A description of the kinds of things which can be stored in this array

Specified by:

spec in class PrimArray

count

public int count()

Description copied from class: PrimArray

Return the number of elements the array can hold.

Specified by:

count in class PrimArray

copyToBuffer

public void copyToBuffer(IntegerValue[] buffer,
                         int count,
                         int start)

copyElements

protected void copyElements(int to,
                            PrimArray source,
                            int from,
                            int count)

Description copied from class: PrimArray

Copy the respective elements of other to this over the specified index range. The other array must be of a compatible type.

Overrides:

copyElements in class PrimArray

Parameters:

to - first index of receiver to be included in the receivers range..

source - other elements to be copied into this.

from - first index of the other array to be included in the range.

count - number of elements from the other array included in range, or -1 for all others elements starting at from. Fail if count is greater than number of available elements.

compareData

protected int compareData(int start,
                          PrimArithmeticArray other,
                          int otherStart,
                          int count)

Description copied from class: PrimArithmeticArray

Over given range, returns - if this < other; 0 if this == other; + if this > other.

Overrides:

compareData in class PrimIntegerArray

signOfNonZeroAfter

protected int signOfNonZeroAfter(int index)

Description copied from class: PrimArithmeticArray

Return the sign, -1 or +1, of the next non-zero element after start, or 0 if no such element. Note that for the unsigned arrays, this will only return 0 or 1.

Specified by:

signOfNonZeroAfter in class PrimArithmeticArray

addData

protected void addData(int start,
                       PrimArithmeticArray other,
                       int otherStart,
                       int count)

Description copied from class: PrimArithmeticArray

Arithmetic addition of the respective elements of other to this over the specified index range.

Note that arithmetic overflows aren't faulted.

Subclasses should override.

Overrides:

addData in class PrimIntegerArray

subtractData

protected void subtractData(int start,
                            PrimArithmeticArray other,
                            int otherStart,
                            int count)

Description copied from class: PrimArithmeticArray

Subtract the respective elements of other from this over the given index range.

Note that arithmetic overflows aren't faulted.

Subclasses should override.

Overrides:

subtractData in class PrimIntegerArray

printElementOn

protected void printElementOn(int index,
                              java.io.PrintWriter oo)

Description copied from class: PrimArray

Print a representation of the element at the given index.

Overrides:

printElementOn in class PrimArray

Parameters:

index - index of element to be printed.

oo - print stream to write element representation to.