stec.jenie
Class INTArray

java.lang.Object
  stec.jenie.NativeObject
      stec.jenie.NativeArray
          stec.jenie.INTArray

public class INTArray
extends NativeArray

Represents a native array of signed integers.

Depending on the platform values are native signed 32-bit or 64-bit integers.

Arrays can only be passed or returned by functions and callbacks as a pointer to the array.

Since:

1.0.0 12/05/2004

Constructor Summary

INTArray(int size)
Constructs a new one dimensional array of signed integers of the specified number of signed integers.

INTArray(int[] dimensions)
Constructs a new n-dimensional array of signed integers of the specified number of signed integers.

INTArray(INTArray array)
Constructs a new n-dimensional array of signed integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of signed integers.

INTArray(int size1, int size2)
Constructs a new two dimensional array of signed integers of the specified number of signed integers.

INTArray(int size1, int size2, int size3)
Constructs a new three dimensional array of signed integers of the specified number of signed integers.

INTArray(Pointer pointer, int size)
Constructs a new one dimensional array of signed integers from the specified pointer to a one dimensional array of signed integers of the specified number of signed integers.

INTArray(Pointer pointer, int[] dimensions)
Constructs a new n-dimensional array of signed integers from the specified pointer to a n-dimensional array of signed integers of the specified number of signed integers.

INTArray(Pointer pointer, INTArray array)
Constructs a new n-dimensional array of signed integers from the specified pointer to a n-dimensional array of signed integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of signed integers.

INTArray(Pointer pointer, int size1, int size2)
Constructs a new two dimensional array of signed integers from the specified pointer to a two dimensional array of signed integers of the specified number of signed integers.

INTArray(Pointer pointer, int size1, int size2, int size3)
Constructs a new three dimensional array of signed integers from the specified pointer to a three dimensional array of signed integers of the specified number of signed integers.

Method Summary

java.lang.Object	clone() Returns a clone of this array of signed integers.
boolean	equals(java.lang.Object object) Returns whether this array of signed integers equals the specified object.
long	getValueAt(int index) Returns the value at the specified index.
long	getValueAt(int[] indexes) Returns the value at the specified index.
long	getValueAt(int index1, int index2) Returns the value at the specified index.
long	getValueAt(int index1, int index2, int index3) Returns the value at the specified index.
void	setValueAt(int[] indexes, INT value) Sets the value at the specified index.
void	setValueAt(int[] indexes, long value) Sets the value at the specified index.
void	setValueAt(int index, INT value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, INT value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, int index3, INT value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, int index3, long value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, long value) Sets the value at the specified index.
void	setValueAt(int index, long value) Sets the value at the specified index.

Methods inherited from class stec.jenie.NativeArray

getDimensions, getElementSize, getOffset, getOffset, getOffset, getOffset, i2a, i2a, i2a

Methods inherited from class stec.jenie.NativeObject

getAlignment, getNativeAddress, getNativeBuffer, getNativeBufferHandle, hashCode, setNativeBuffer, setNativeBuffer, setNativeBuffer, size

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

INTArray

public INTArray(int size)
         throws java.lang.OutOfMemoryError,
                java.lang.IllegalArgumentException

Constructs a new one dimensional array of signed integers of the specified number of signed integers.

Parameters:

size - the number of signed integers in the array.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(int size1,
                int size2)
         throws java.lang.OutOfMemoryError,
                java.lang.IllegalArgumentException

Constructs a new two dimensional array of signed integers of the specified number of signed integers.

Parameters:

size1 - the size of the first dimension.

size2 - the size of the second dimension.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(int size1,
                int size2,
                int size3)
         throws java.lang.OutOfMemoryError,
                java.lang.IllegalArgumentException

Constructs a new three dimensional array of signed integers of the specified number of signed integers.

Parameters:

size1 - the size of the first dimension.

size2 - the size of the second dimension.

size3 - the size of the third dimension.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(int[] dimensions)
         throws java.lang.OutOfMemoryError,
                java.lang.IllegalArgumentException

Constructs a new n-dimensional array of signed integers of the specified number of signed integers.

Parameters:

dimensions - an array of integers representing the number of dimensions and the size of each dimension.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(INTArray array)
         throws java.lang.OutOfMemoryError,
                java.lang.IllegalArgumentException

Constructs a new n-dimensional array of signed integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of signed integers.

Parameters:

array - the n-dimensional array of signed integers to use.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(Pointer pointer,
                int size)
         throws java.lang.IllegalArgumentException

Constructs a new one dimensional array of signed integers from the specified pointer to a one dimensional array of signed integers of the specified number of signed integers.

Parameters:

pointer - the pointer to the one dimensional array of signed integers.

size - the number of signed integers in the array.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(Pointer pointer,
                int size1,
                int size2)
         throws java.lang.IllegalArgumentException

Constructs a new two dimensional array of signed integers from the specified pointer to a two dimensional array of signed integers of the specified number of signed integers.

Parameters:

pointer - the pointer to the two dimensional array of signed integers.

size1 - the size of the first dimension.

size2 - the size of the second dimension.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(Pointer pointer,
                int size1,
                int size2,
                int size3)
         throws java.lang.IllegalArgumentException

Constructs a new three dimensional array of signed integers from the specified pointer to a three dimensional array of signed integers of the specified number of signed integers.

Parameters:

pointer - the pointer to the three dimensional array of signed integers.

size1 - the size of the first dimension.

size2 - the size of the second dimension.

size3 - the size of the third dimension.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(Pointer pointer,
                int[] dimensions)
         throws java.lang.IllegalArgumentException

Constructs a new n-dimensional array of signed integers from the specified pointer to a n-dimensional array of signed integers of the specified number of signed integers.

Parameters:

pointer - the pointer to the n-dimensional array of signed integers.

dimensions - an array of integers representing the number of dimensions and the size of each dimension.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

INTArray

public INTArray(Pointer pointer,
                INTArray array)
         throws java.lang.IllegalArgumentException

Constructs a new n-dimensional array of signed integers from the specified pointer to a n-dimensional array of signed integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of signed integers.

Parameters:

pointer - the pointer to the n-dimensional array of signed integers.

array - the n-dimensional array of signed integers to use.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

Method Detail

getValueAt

public long getValueAt(int index)
                throws java.lang.ArrayIndexOutOfBoundsException

Returns the value at the specified index.

For use with one dimensional array of signed integers.

Parameters:

index - the index of the value to return.

Returns:

the value at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

getValueAt

public long getValueAt(int index1,
                       int index2)
                throws java.lang.ArrayIndexOutOfBoundsException

Returns the value at the specified index.

For use with two dimensional array of signed integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

Returns:

the value at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

getValueAt

public long getValueAt(int index1,
                       int index2,
                       int index3)
                throws java.lang.ArrayIndexOutOfBoundsException

Returns the value at the specified index.

For use with three dimensional array of signed integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

Returns:

the value at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

getValueAt

public long getValueAt(int[] indexes)
                throws java.lang.ArrayIndexOutOfBoundsException

Returns the value at the specified index.

For use with n-dimensional array of signed integers.

Parameters:

indexes - an array of integers representing the number of indexes and the index into each of the dimensions.

Returns:

the value at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index,
                       long value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with one dimensional array of signed integers.

Parameters:

index - the index of the value to change.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index1,
                       int index2,
                       long value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with two dimensional array of signed integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index1,
                       int index2,
                       int index3,
                       long value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with three dimensional array of signed integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int[] indexes,
                       long value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with n-dimensional array of signed integers.

Parameters:

indexes - an array of integers representing the number of indexes and the index into each of the dimensions.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index,
                       INT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with one dimensional array of signed integers.

Parameters:

index - the index of the value to change.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index1,
                       int index2,
                       INT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with two dimensional array of signed integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index1,
                       int index2,
                       int index3,
                       INT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with three dimensional array of signed integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int[] indexes,
                       INT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with n-dimensional array of signed integers.

Parameters:

indexes - an array of integers representing the number of indexes and the index into each of the dimensions.

value - the value to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

equals

public boolean equals(java.lang.Object object)

Returns whether this array of signed integers equals the specified object.

Overrides:

equals in class NativeArray

Parameters:

object - the object to compare against.

Returns:

whether this array of signed integers equals the specified object.

clone

public java.lang.Object clone()
                       throws java.lang.OutOfMemoryError

Returns a clone of this array of signed integers.

Specified by:

clone in class NativeObject

Returns:

the clone of this array of signed integers.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.