APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xml.internal.utils

public Class SuballocatedIntVector

extends Object
Class Inheritance

A very simple table that stores a list of int. Very similar API to our IntVector class (same API); different internal storage. This version uses an array-of-arrays solution. Read/write access is thus a bit slower than the simple IntVector, and basic storage is a trifle higher due to the top-level array -- but appending is O(1) fast rather than O(N**2) slow, which will swamp those costs in situations where long vectors are being built up. Known issues: Some methods are private because they haven't yet been tested properly. Retrieval performance is critical, since this is used at the core of the DTM model. (Append performance is almost as important.) That's pushing me toward just letting reads from unset indices throw exceptions or return stale data; safer behavior would have performance costs.

Field Summary

Modifier and TypeField and Description
protected int
m_blocksize

Size of blocks to allocate

protected int[]
m_buildCache

"Shortcut" handle to most recently added row of m_map.

protected int
protected int
m_firstFree

Number of ints in array

protected int[][]
m_map

Array of arrays of ints

protected int[]
m_map0

"Shortcut" handle to m_map[0].

protected int
m_MASK

Bitwise addressing (much faster than div/remainder

protected int
m_numblocks

The number of blocks to (over)allocate by

protected int
m_SHIFT

Bitwise addressing (much faster than div/remainder

protected static final int
NUMBLOCKS_DEFAULT

The default number of blocks to (over)allocate by

Constructor Summary

AccessConstructor and Description
public
SuballocatedIntVector()

Default constructor.

public
SuballocatedIntVector(int
Size of block to allocate
blocksize
,
int
Number of blocks to allocate
numblocks
)

Construct a IntVector, using the given block size and number of blocks.

public
SuballocatedIntVector(int
Size of block to allocate
blocksize
)

Construct a IntVector, using the given block size and the default number of blocks (32).

Method Summary

Modifier and TypeMethod and Description
public void
addElement(int
Int to add to the list
value
)

Append a int onto the vector.

private void
addElements(int
Int to add to the list
value
,
int numberOfElements)

Append several int values onto the vector.

private void
addElements(int
Int to add to the list
numberOfElements
)

Append several slots onto the vector, but do not set the values.

private boolean

Returns:

true if the object is in the list
contains
(int
object to look for
s
)

Tell if the table contains the given node.

public int

Returns:

value at given index. If that value wasn't previously set, the result is undefined for performance reasons. It may throw an exception (see below), may return zero, or (if setSize has previously been used) may return stale data.
elementAt
(int
index of value to get
i
)

Get the nth element.

public final int[][]

Returns:

the internal map of array of arrays
getMap
()

Return the m_map double array

public final int[]

Returns:

the m_map0 array
getMap0
()

Return the internal m_map0 array

public int

Returns:

the index of the first occurrence of the object argument in this vector at position index or later in the vector; returns -1 if the object is not found.
indexOf
(int
object to look for
elem
,
int
Index of where to begin search
index
)

Searches for the first occurence of the given argument, beginning the search at index, and testing for equality using the equals method.

public int

Returns:

the index of the first occurrence of the object argument in this vector at position index or later in the vector; returns -1 if the object is not found.
indexOf
(int
object to look for
elem
)

Searches for the first occurence of the given argument, beginning the search at index, and testing for equality using the equals method.

private void
insertElementAt(int
Int to insert
value
,
int
Index of where to insert
at
)

Inserts the specified node in this vector at the specified index.

private int

Returns:

the index of the first occurrence of the object argument in this vector at position index or later in the vector; returns -1 if the object is not found.
lastIndexOf
(int
Object to look for
elem
)

Searches for the first occurence of the given argument, beginning the search at index, and testing for equality using the equals method.

public void
removeAllElements()

Wipe it out.

private boolean

Returns:

True if the int was removed, false if it was not found
removeElement
(int
Int to remove from array
s
)

Removes the first occurrence of the argument from this vector.

private void
removeElementAt(int
index of where to remove and int
at
)

Deletes the component at the specified index.

public void
setElementAt(int
object to set
value
,
int
Index of where to set the object
at
)

Sets the component at the specified index of this vector to be the specified object.

public void

Returns:

length of the list
setSize
(int sz)

Set the length of the list.

public int

Returns:

length of the list
size
()

Get the length of the list.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

m_blocksizeback to summary
protected int m_blocksize

Size of blocks to allocate

m_buildCacheback to summary
protected int[] m_buildCache

"Shortcut" handle to most recently added row of m_map. Very helpful during construction.

m_buildCacheStartIndexback to summary
protected int m_buildCacheStartIndex
m_firstFreeback to summary
protected int m_firstFree

Number of ints in array

m_mapback to summary
protected int[][] m_map

Array of arrays of ints

m_map0back to summary
protected int[] m_map0

"Shortcut" handle to m_map[0]. Surprisingly helpful for short vectors.

m_MASKback to summary
protected int m_MASK

Bitwise addressing (much faster than div/remainder

m_numblocksback to summary
protected int m_numblocks

The number of blocks to (over)allocate by

m_SHIFTback to summary
protected int m_SHIFT

Bitwise addressing (much faster than div/remainder

NUMBLOCKS_DEFAULTback to summary
protected static final int NUMBLOCKS_DEFAULT

The default number of blocks to (over)allocate by

Constructor Detail

SuballocatedIntVectorback to summary
public SuballocatedIntVector()

Default constructor. Note that the default block size is currently 2K, which may be overkill for small lists and undershootng for large ones.

SuballocatedIntVectorback to summary
public SuballocatedIntVector(int blocksize, int numblocks)

Construct a IntVector, using the given block size and number of blocks. For efficiency, we will round the requested size off to a power of two.

Parameters
blocksize:int

Size of block to allocate

numblocks:int

Number of blocks to allocate

SuballocatedIntVectorback to summary
public SuballocatedIntVector(int blocksize)

Construct a IntVector, using the given block size and the default number of blocks (32).

Parameters
blocksize:int

Size of block to allocate

Method Detail

addElementback to summary
public void addElement(int value)

Append a int onto the vector.

Parameters
value:int

Int to add to the list

addElementsback to summary
private void addElements(int value, int numberOfElements)

Append several int values onto the vector.

Parameters
value:int

Int to add to the list

addElementsback to summary
private void addElements(int numberOfElements)

Append several slots onto the vector, but do not set the values.

Note

"Not Set" means the value is unspecified.

Parameters
numberOfElements:int

Int to add to the list

containsback to summary
private boolean contains(int s)

Tell if the table contains the given node.

Parameters
s:int

object to look for

Returns:boolean

true if the object is in the list

elementAtback to summary
public int elementAt(int i)

Get the nth element. This is often at the innermost loop of an application, so performance is critical.

Parameters
i:int

index of value to get

Returns:int

value at given index. If that value wasn't previously set, the result is undefined for performance reasons. It may throw an exception (see below), may return zero, or (if setSize has previously been used) may return stale data.

Exceptions
ArrayIndexOutOfBoundsException:
if the index was _clearly_ unreasonable (negative, or past the highest block).
NullPointerException:
if the index points to a block that could have existed (based on the highest index used) but has never had anything set into it. %REVIEW% Could add a catch to create the block in that case, or return 0. Try/Catch is _supposed_ to be nearly free when not thrown to. Do we believe that? Should we have a separate safeElementAt?
getMapback to summary
public final int[][] getMap()

Return the m_map double array

Returns:int[][]

the internal map of array of arrays

getMap0back to summary
public final int[] getMap0()

Return the internal m_map0 array

Returns:int[]

the m_map0 array

indexOfback to summary
public int indexOf(int elem, int index)

Searches for the first occurence of the given argument, beginning the search at index, and testing for equality using the equals method.

Parameters
elem:int

object to look for

index:int

Index of where to begin search

Returns:int

the index of the first occurrence of the object argument in this vector at position index or later in the vector; returns -1 if the object is not found.

indexOfback to summary
public int indexOf(int elem)

Searches for the first occurence of the given argument, beginning the search at index, and testing for equality using the equals method.

Parameters
elem:int

object to look for

Returns:int

the index of the first occurrence of the object argument in this vector at position index or later in the vector; returns -1 if the object is not found.

insertElementAtback to summary
private void insertElementAt(int value, int at)

Inserts the specified node in this vector at the specified index. Each component in this vector with an index greater or equal to the specified index is shifted upward to have an index one greater than the value it had previously. Insertion may be an EXPENSIVE operation!

Parameters
value:int

Int to insert

at:int

Index of where to insert

lastIndexOfback to summary
private int lastIndexOf(int elem)

Searches for the first occurence of the given argument, beginning the search at index, and testing for equality using the equals method.

Parameters
elem:int

Object to look for

Returns:int

the index of the first occurrence of the object argument in this vector at position index or later in the vector; returns -1 if the object is not found.

removeAllElementsback to summary
public void removeAllElements()

Wipe it out. Currently defined as equivalent to setSize(0).

removeElementback to summary
private boolean removeElement(int s)

Removes the first occurrence of the argument from this vector. If the object is found in this vector, each component in the vector with an index greater or equal to the object's index is shifted downward to have an index one smaller than the value it had previously.

Parameters
s:int

Int to remove from array

Returns:boolean

True if the int was removed, false if it was not found

removeElementAtback to summary
private void removeElementAt(int at)

Deletes the component at the specified index. Each component in this vector with an index greater or equal to the specified index is shifted downward to have an index one smaller than the value it had previously.

Parameters
at:int

index of where to remove and int

setElementAtback to summary
public void setElementAt(int value, int at)

Sets the component at the specified index of this vector to be the specified object. The previous component at that position is discarded. The index must be a value greater than or equal to 0 and less than the current size of the vector.

Parameters
value:int

object to set

at:int

Index of where to set the object

setSizeback to summary
public void setSize(int sz)

Set the length of the list. This will only work to truncate the list, and even then it has not been heavily tested and may not be trustworthy.

Returns:void

length of the list

sizeback to summary
public int size()

Get the length of the list.

Returns:int

length of the list