ucar.ma2
Class ArrayBoolean

java.lang.Object
  extended by ucar.ma2.Array
      extended by ucar.ma2.ArrayBoolean
Direct Known Subclasses:
ArrayBoolean.D0, ArrayBoolean.D1, ArrayBoolean.D2, ArrayBoolean.D3, ArrayBoolean.D4, ArrayBoolean.D5, ArrayBoolean.D6, ArrayBoolean.D7

public class ArrayBoolean
extends Array

Concrete implementation of Array specialized for booleans. Data storage is with 1D java array of booleans. issues: what should we do if a conversion loses accuracy? nothing ? Exception ?

Version:
$Revision:51 $ $Date:2006-07-12 17:13:13Z $
Author:
caron
See Also:
Array

Nested Class Summary
static class ArrayBoolean.D0
          Concrete implementation of Array specialized for byte, rank 0.
static class ArrayBoolean.D1
          Concrete implementation of Array specialized for boolean, rank 1.
static class ArrayBoolean.D2
          Concrete implementation of Array specialized for boolean, rank 2.
static class ArrayBoolean.D3
          Concrete implementation of Array specialized for boolean, rank 3.
static class ArrayBoolean.D4
          Concrete implementation of Array specialized for boolean, rank 4.
static class ArrayBoolean.D5
          Concrete implementation of Array specialized for boolean, rank 5.
static class ArrayBoolean.D6
          Concrete implementation of Array specialized for boolean, rank 6.
static class ArrayBoolean.D7
          Concrete implementation of Array specialized for boolean, rank 7.
 
Field Summary
protected  boolean[] storage
           
 
Fields inherited from class ucar.ma2.Array
indexCalc, rank, scalarIndex
 
Constructor Summary
ArrayBoolean(int[] dimensions)
          Create a new Array of type boolean and the given shape.
 
Method Summary
 boolean get(Index i)
          get the value at the specified index.
 boolean getBoolean(Index i)
          Get the array element at the current element of ima, as a boolean.
 byte getByte(Index i)
          not legal, throw ForbiddenConversionException
 char getChar(Index i)
          not legal, throw ForbiddenConversionException
 double getDouble(Index i)
          not legal, throw ForbiddenConversionException
 java.lang.Class getElementType()
          Return the element class type
 float getFloat(Index i)
          not legal, throw ForbiddenConversionException
 int getInt(Index i)
          not legal, throw ForbiddenConversionException
 long getLong(Index i)
          not legal, throw ForbiddenConversionException
 java.lang.Object getObject(Index i)
          Get the array element at index as an Object.
 short getShort(Index i)
          not legal, throw ForbiddenConversionException
 java.lang.Object getStorage()
          Get underlying primitive array storage.
 void set(Index i, boolean value)
          set the value at the sepcified index.
 void setBoolean(Index i, boolean value)
          Set the array element at the current element of ima.
 void setByte(Index i, byte value)
          not legal, throw ForbiddenConversionException
 void setChar(Index i, char value)
          not legal, throw ForbiddenConversionException
 void setDouble(Index i, double value)
          not legal, throw ForbiddenConversionException
 void setFloat(Index i, float value)
          not legal, throw ForbiddenConversionException
 void setInt(Index i, int value)
          not legal, throw ForbiddenConversionException
 void setLong(Index i, long value)
          not legal, throw ForbiddenConversionException
 void setObject(Index i, java.lang.Object value)
          Set the array element at index to the specified value.
 void setShort(Index i, short value)
          not legal, throw ForbiddenConversionException
 
Methods inherited from class ucar.ma2.Array
arraycopy, copy, copyTo1DJavaArray, copyToNDJavaArray, factory, factory, factory, factory, factoryConstant, flip, get1DJavaArray, getIndex, getIndexIterator, getIndexIteratorFast, getIndexName, getRangeIterator, getRank, getShape, getSize, permute, reduce, reduce, reshape, section, section, section, sectionNoReduce, sectionNoReduce, setIndexName, shapeToString, slice, toString, transpose
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

storage

protected boolean[] storage
Constructor Detail

ArrayBoolean

public ArrayBoolean(int[] dimensions)
Create a new Array of type boolean and the given shape. dimensions.length determines the rank of the new Array.

Parameters:
dimensions - the shape of the Array.
Method Detail

getStorage

public java.lang.Object getStorage()
Description copied from class: Array
Get underlying primitive array storage. Exposed for efficiency, use at your own risk.

Specified by:
getStorage in class Array

getElementType

public java.lang.Class getElementType()
Return the element class type

Specified by:
getElementType in class Array

get

public boolean get(Index i)
get the value at the specified index.


set

public void set(Index i,
                boolean value)
set the value at the sepcified index.


getDouble

public double getDouble(Index i)
not legal, throw ForbiddenConversionException

Specified by:
getDouble in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to double if necessary.

setDouble

public void setDouble(Index i,
                      double value)
not legal, throw ForbiddenConversionException

Specified by:
setDouble in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getFloat

public float getFloat(Index i)
not legal, throw ForbiddenConversionException

Specified by:
getFloat in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to float if necessary.

setFloat

public void setFloat(Index i,
                     float value)
not legal, throw ForbiddenConversionException

Specified by:
setFloat in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getLong

public long getLong(Index i)
not legal, throw ForbiddenConversionException

Specified by:
getLong in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to long if necessary.

setLong

public void setLong(Index i,
                    long value)
not legal, throw ForbiddenConversionException

Specified by:
setLong in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getInt

public int getInt(Index i)
not legal, throw ForbiddenConversionException

Specified by:
getInt in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to int if necessary.

setInt

public void setInt(Index i,
                   int value)
not legal, throw ForbiddenConversionException

Specified by:
setInt in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getShort

public short getShort(Index i)
not legal, throw ForbiddenConversionException

Specified by:
getShort in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to short if necessary.

setShort

public void setShort(Index i,
                     short value)
not legal, throw ForbiddenConversionException

Specified by:
setShort in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getByte

public byte getByte(Index i)
not legal, throw ForbiddenConversionException

Specified by:
getByte in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to float if necessary.

setByte

public void setByte(Index i,
                    byte value)
not legal, throw ForbiddenConversionException

Specified by:
setByte in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getBoolean

public boolean getBoolean(Index i)
Description copied from class: Array
Get the array element at the current element of ima, as a boolean.

Specified by:
getBoolean in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to boolean if necessary.

setBoolean

public void setBoolean(Index i,
                       boolean value)
Description copied from class: Array
Set the array element at the current element of ima.

Specified by:
setBoolean in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getChar

public char getChar(Index i)
not legal, throw ForbiddenConversionException

Specified by:
getChar in class Array
Parameters:
i - Index with current element set
Returns:
value at index cast to char if necessary.

setChar

public void setChar(Index i,
                    char value)
not legal, throw ForbiddenConversionException

Specified by:
setChar in class Array
Parameters:
i - Index with current element set
value - the new value; cast to underlying data type if necessary.

getObject

public java.lang.Object getObject(Index i)
Description copied from class: Array
Get the array element at index as an Object. The returned value is wrapped in an object, eg Double for double

Specified by:
getObject in class Array
Parameters:
i - element Index
Returns:
Object value at index

setObject

public void setObject(Index i,
                      java.lang.Object value)
Description copied from class: Array
Set the array element at index to the specified value. the value must be passed wrapped in the appropriate Object (eg Double for double)

Specified by:
setObject in class Array
Parameters:
i - Index with current element set
value - the new value.