sidl
Class Integer.Array1

java.lang.Object
  extended by gov.llnl.sidl.BaseArray
      extended by sidl.Integer.Array
          extended by sidl.Integer.Array1
Enclosing class:
Integer

public static class Integer.Array1
extends Integer.Array

Define a one dimensional array of type int. This array representation is used for sidl arrays since it requires no copies to go between Java and sidl. Explicit copies may be made of the array by calling the appropriate get and set methods.


Nested Class Summary
static class Integer.Array1.Holder
           
 
Field Summary
 
Fields inherited from class gov.llnl.sidl.BaseArray
d_array, d_owner
 
Constructor Summary
  Integer.Array1()
          Create an empty one dimensional array.
  Integer.Array1(int[] array)
          Create a one dimensional array using the specified Java array.
  Integer.Array1(int s0, boolean isRow)
          Create a one dimenstional array of the specified size, with the lower index starting at zero.
  Integer.Array1(int l0, int u0, boolean isRow)
          Create a one dimensional array using the specified lower and upper bounds (where both bounds are inclusive).
protected Integer.Array1(long array, boolean owner)
          Create a one dimensional array directly using the sidl pointer and owner flag.
 
Method Summary
 int _get(int i)
          Get the specified array element without bounds checking.
 void _set(int i, int value)
          Set the specified array element without bounds checking.
 void copy(Integer.Array1 dest)
          Method Copy copies the elements of 'this' to an already existing array of the same size.
 void fromArray(int[] array)
          Set the value of the sidl array from the Java array.
 int get(int i)
          Get the specified array element with bounds checking.
 int length()
          Routine gets length of the array
 void reallocate(int l0, int u0, boolean isRow)
          Reallocate array data using the specifed lower and upper bounds.
 void set(int i, int value)
          Set the specified array element with bounds checking.
 Integer.Array1 smartCopy()
          Method smartCopy returns a a copy of a borrowed array, or increments the reference count of an array that manages it's own data.
 int[] toArray()
          Convert the sidl array into a Java array.
 
Methods inherited from class sidl.Integer.Array
_copy, _dcast, _get, _reallocate, _set, _slice
 
Methods inherited from class gov.llnl.sidl.BaseArray
_addRef, _deallocate, _destroy, _dim, _isColumnOrder, _isRowOrder, _length, _lower, _smartCopy, _stride, _type, _upper, checkBounds, checkBounds, checkBounds, checkBounds, checkBounds, checkBounds, checkBounds, checkDimension, checkIndexBounds, checkNullArray, destroy, dim, finalize, get_ior_pointer, get_owner, isNull, lower, reallocate, reset, set_ior_pointer, set_owner, stride, upper
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Integer.Array1

public Integer.Array1()
Create an empty one dimensional array. The array will need to be initialized before use.


Integer.Array1

protected Integer.Array1(long array,
                         boolean owner)
Create a one dimensional array directly using the sidl pointer and owner flag. This constructor should only be called by the sidl runtime.


Integer.Array1

public Integer.Array1(int l0,
                      int u0,
                      boolean isRow)
Create a one dimensional array using the specified lower and upper bounds (where both bounds are inclusive). This constructor will throw an array bounds out of range exception if the array bounds are invalid.


Integer.Array1

public Integer.Array1(int s0,
                      boolean isRow)
Create a one dimenstional array of the specified size, with the lower index starting at zero. This constructor will throw an array bounds out of range exception if the array bounds are invalid.


Integer.Array1

public Integer.Array1(int[] array)
Create a one dimensional array using the specified Java array. The lower bound(s) of the constructed array will start at zero. An array index out of range exception will be thrown if the bounds are invalid.

Method Detail

length

public int length()
Routine gets length of the array


_get

public int _get(int i)
Get the specified array element without bounds checking. If the index is invalid, then bad things may happen. If you are unsure whether the index is valid, then use get instead.


get

public int get(int i)
Get the specified array element with bounds checking. If the index is invalid, then an array index out of bounds exception will be thrown.


reallocate

public void reallocate(int l0,
                       int u0,
                       boolean isRow)
Reallocate array data using the specifed lower and upper bounds. The upper bound is inclusive. Previous array data will be freed.


smartCopy

public Integer.Array1 smartCopy()
Method smartCopy returns a a copy of a borrowed array, or increments the reference count of an array that manages it's own data. Useful if you wish to keep a copy of an incoming array


copy

public void copy(Integer.Array1 dest)
Method Copy copies the elements of 'this' to an already existing array of the same size.


_set

public void _set(int i,
                 int value)
Set the specified array element without bounds checking. If the index is invalid, then bad things may happen. If you are unsure whether the index is valid, then use set instead.


set

public void set(int i,
                int value)
Set the specified array element with bounds checking. If the index is invalid, then an array index out of bounds exception will be thrown.


toArray

public int[] toArray()
Convert the sidl array into a Java array. This method will copy the sidl array into the Java array. The resulting Java array will (obviously) start with a zero lower bound. If the sidl array is empty (null), then a null Java array will be returned.


fromArray

public void fromArray(int[] array)
Set the value of the sidl array from the Java array. This method will copy the Java array values into the sidl array, reallocating the memory of the sidl array as necessary. The resulting sidl array will start with a zero lower bound. If the Java array is null, then the sidl array will be null, as well. Note that multidimensional Java arrays must not be ragged; that is, all sub-arrays in a particular dimension must have the same size. Otherwise, some data may be missed or this method may throw an array index out of bounds exception.