sidl
Class Character.Array7

java.lang.Object
  extended by gov.llnl.sidl.BaseArray
      extended by sidl.Character.Array
          extended by sidl.Character.Array7
Enclosing class:
Character

public static class Character.Array7
extends Character.Array

Define a seven dimensional array of type char. 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 Character.Array7.Holder
           
 
Field Summary
 
Fields inherited from class gov.llnl.sidl.BaseArray
d_array, d_owner
 
Constructor Summary
  Character.Array7()
          Create an empty seven dimensional array.
  Character.Array7(char[][][][][][][] array)
          Create a seven dimensional array using the specified Java array.
  Character.Array7(int s0, int s1, int s2, int s3, int s4, int s5, int s6, boolean isRow)
          Create a seven dimenstional array of the specified size, with the lower index starting at zero.
  Character.Array7(int l0, int l1, int l2, int l3, int l4, int l5, int l6, int u0, int u1, int u2, int u3, int u4, int u5, int u6, boolean isRow)
          Create a seven dimensional array using the specified lower and upper bounds (where both bounds are inclusive).
protected Character.Array7(long array, boolean owner)
          Create a seven dimensional array directly using the sidl pointer and owner flag.
 
Method Summary
 char _get(int i, int j, int k, int l, int m, int n, int o)
          Get the specified array element without bounds checking.
 void _set(int i, int j, int k, int l, int m, int n, int o, char value)
          Set the specified array element without bounds checking.
 void copy(Character.Array7 dest)
          Method Copy copies the elements of 'this' to an already existing array of the same size.
 void fromArray(char[][][][][][][] array)
          Set the value of the sidl array from the Java array.
 char get(int i, int j, int k, int l, int m, int n, int o)
          Get the specified array element with bounds checking.
 int length(int dim)
          Routine gets length of the array in the specified dimension
 void reallocate(int l0, int l1, int l2, int l3, int l4, int l5, int l6, int u0, int u1, int u2, int u3, int u4, int u5, int u6, boolean isRow)
          Reallocate array data using the specifed lower and upper bounds.
 void set(int i, int j, int k, int l, int m, int n, int o, char value)
          Set the specified array element with bounds checking.
 Character.Array7 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.
 char[][][][][][][] toArray()
          Convert the sidl array into a Java array.
 
Methods inherited from class sidl.Character.Array
_copy, _dcast, _reallocate, _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

Character.Array7

public Character.Array7()
Create an empty seven dimensional array. The array will need to be initialized before use.


Character.Array7

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


Character.Array7

public Character.Array7(int l0,
                        int l1,
                        int l2,
                        int l3,
                        int l4,
                        int l5,
                        int l6,
                        int u0,
                        int u1,
                        int u2,
                        int u3,
                        int u4,
                        int u5,
                        int u6,
                        boolean isRow)
Create a seven 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.


Character.Array7

public Character.Array7(int s0,
                        int s1,
                        int s2,
                        int s3,
                        int s4,
                        int s5,
                        int s6,
                        boolean isRow)
Create a seven 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.


Character.Array7

public Character.Array7(char[][][][][][][] array)
Create a seven 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(int dim)
Routine gets length of the array in the specified dimension


_get

public char _get(int i,
                 int j,
                 int k,
                 int l,
                 int m,
                 int n,
                 int o)
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.

Overrides:
_get in class Character.Array

get

public char get(int i,
                int j,
                int k,
                int l,
                int m,
                int n,
                int o)
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 l1,
                       int l2,
                       int l3,
                       int l4,
                       int l5,
                       int l6,
                       int u0,
                       int u1,
                       int u2,
                       int u3,
                       int u4,
                       int u5,
                       int u6,
                       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 Character.Array7 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(Character.Array7 dest)
Method Copy copies the elements of 'this' to an already existing array of the same size.


_set

public void _set(int i,
                 int j,
                 int k,
                 int l,
                 int m,
                 int n,
                 int o,
                 char 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.

Overrides:
_set in class Character.Array

set

public void set(int i,
                int j,
                int k,
                int l,
                int m,
                int n,
                int o,
                char 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 char[][][][][][][] 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(char[][][][][][][] 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.