stec.jenie
Class FLOATArray

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

public class FLOATArray
extends NativeArray

Represents a native array of 32-bit floating point values.

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

FLOATArray(FLOATArray array)
Constructs a new n-dimensional array of 32-bit floating point values with the same number of dimensions and size of each dimension as the specified 32-bit floating point native array.

FLOATArray(int size)
Constructs a new one dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

FLOATArray(int[] dimensions)
Constructs a new n-dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

FLOATArray(int size1, int size2)
Constructs a new two dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

FLOATArray(int size1, int size2, int size3)
Constructs a new three dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

FLOATArray(Pointer pointer, FLOATArray array)
Constructs a new n-dimensional array of 32-bit floating point values from the specified pointer to a n-dimensional array of 32-bit floating point values with the same number of dimensions and size of each dimension as the specified signed 32-bit floating point native array.

FLOATArray(Pointer pointer, int size)
Constructs a new one dimensional array of 32-bit floating point values from the specified pointer to a one dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

FLOATArray(Pointer pointer, int[] dimensions)
Constructs a new n-dimensional array of 32-bit floating point values from the specified pointer to a n-dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

FLOATArray(Pointer pointer, int size1, int size2)
Constructs a new two dimensional array of 32-bit floating point values from the specified pointer to a two dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

FLOATArray(Pointer pointer, int size1, int size2, int size3)
Constructs a new three dimensional array of 32-bit floating point values from the specified pointer to a three dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

Method Summary

java.lang.Object	clone() Returns a clone of this array of 32-bit floating point values.
boolean	equals(java.lang.Object object) Returns whether this array of 32-bit floating point values equals the specified object.
float	getValueAt(int index) Returns the value at the specified index.
float	getValueAt(int[] indexes) Returns the value at the specified index.
float	getValueAt(int index1, int index2) Returns the value at the specified index.
float	getValueAt(int index1, int index2, int index3) Returns the value at the specified index.
void	setValueAt(int[] indexes, float value) Sets the value at the specified index.
void	setValueAt(int[] indexes, FLOAT value) Sets the value at the specified index.
void	setValueAt(int index, float value) Sets the value at the specified index.
void	setValueAt(int index, FLOAT value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, float value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, FLOAT value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, int index3, float value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, int index3, FLOAT 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

FLOATArray

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

Constructs a new one dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

Parameters:

size - the number of 32-bit floating point values 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.

FLOATArray

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

Constructs a new two dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

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.

FLOATArray

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

Constructs a new three dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

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.

FLOATArray

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

Constructs a new n-dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

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.

FLOATArray

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

Constructs a new n-dimensional array of 32-bit floating point values with the same number of dimensions and size of each dimension as the specified 32-bit floating point native array.

Parameters:

array - the n-dimensional array of 32-bit floating point values to use.

Throws:

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

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

FLOATArray

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

Constructs a new one dimensional array of 32-bit floating point values from the specified pointer to a one dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

Parameters:

pointer - the pointer to the one dimensional array of 32-bit floating point values.

size - the number of 32-bit floating point values in the array.

Throws:

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

FLOATArray

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

Constructs a new two dimensional array of 32-bit floating point values from the specified pointer to a two dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

Parameters:

pointer - the pointer to the two dimensional array of 32-bit floating point values.

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.

FLOATArray

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

Constructs a new three dimensional array of 32-bit floating point values from the specified pointer to a three dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

Parameters:

pointer - the pointer to the three dimensional array of 32-bit floating point values.

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.

FLOATArray

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

Constructs a new n-dimensional array of 32-bit floating point values from the specified pointer to a n-dimensional array of 32-bit floating point values of the specified number of 32-bit floating point values.

Parameters:

pointer - the pointer to the n-dimensional array of 32-bit floating point values.

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.

FLOATArray

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

Constructs a new n-dimensional array of 32-bit floating point values from the specified pointer to a n-dimensional array of 32-bit floating point values with the same number of dimensions and size of each dimension as the specified signed 32-bit floating point native array.

Parameters:

pointer - the pointer to the n-dimensional array of 32-bit floating point values.

array - the n-dimensional array of 32-bit floating point values to use.

Throws:

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

Method Detail

getValueAt

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

Returns the value at the specified index.

For use with one dimensional array of 32-bit floating point values.

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 float getValueAt(int index1,
                        int index2)
                 throws java.lang.ArrayIndexOutOfBoundsException

Returns the value at the specified index.

For use with two dimensional array of 32-bit floating point values.

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 float 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 32-bit floating point values.

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 float getValueAt(int[] indexes)
                 throws java.lang.ArrayIndexOutOfBoundsException

Returns the value at the specified index.

For use with n-dimensional array of 32-bit floating point values.

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,
                       float value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with one dimensional array of 32-bit floating point values.

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,
                       float value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with two dimensional array of 32-bit floating point values.

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,
                       float value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with three dimensional array of 32-bit floating point values.

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,
                       float value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with n-dimensional array of 32-bit floating point values.

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,
                       FLOAT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with one dimensional array of 32-bit floating point values.

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,
                       FLOAT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with two dimensional array of 32-bit floating point values.

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,
                       FLOAT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with three dimensional array of 32-bit floating point values.

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,
                       FLOAT value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with n-dimensional array of 32-bit floating point values.

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 32-bit floating point values equals the specified object.

Overrides:

equals in class NativeArray

Parameters:

object - the object to compare against.

Returns:

whether this array of 32-bit floating point values equals the specified object.

clone

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

Returns a clone of this array of 32-bit floating point values.

Specified by:

clone in class NativeObject

Returns:

the clone of this array of 32-bit floating point values.

Throws:

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