Package edu.cmu.tetrad.data

Class ByteDataBox

java.lang.Object

edu.cmu.tetrad.data.ByteDataBox

All Implemented Interfaces:

DataBox, TetradSerializable, Serializable

public class ByteDataBox
extends Object
implements DataBox

Stores a 2D array of byte data. Note that the missing value marker for this box is -99.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ByteDataBox(byte[][] data)	Constructs a new data box using the given 2D byte data array as data.
ByteDataBox(int rows, int cols)	Constructs an 2D byte array consisting entirely of missing values (-99).

Method Summary

Modifier and Type	Method	Description
DataBox	copy()	copy.
Number	get(int row, int col)	get.
DataBox	like()	like.
int	numCols()	numCols.
int	numRows()	numRows.
static BoxDataSet	serializableInstance()	Generates a simple exemplar of this class to test serialization.
void	set(int row, int col, Number value)	Sets the value at the given row and column to the given Number.
DataBox	viewSelection(int[] rows, int[] cols)	viewSelection.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ByteDataBox

public ByteDataBox(int rows,
 int cols)

Constructs an 2D byte array consisting entirely of missing values (-99).

Parameters:

rows - the number of rows.

cols - the number of columns.

ByteDataBox

public ByteDataBox(byte[][] data)

Constructs a new data box using the given 2D byte data array as data.

Parameters:

data - the data to use.

Method Details

serializableInstance

public static BoxDataSet serializableInstance()

Generates a simple exemplar of this class to test serialization.

Returns:

a simple exemplar of this class to test serialization.

numRows

public int numRows()

numRows.

Specified by:

numRows in interface DataBox

Returns:

the number of rows in this data box.

numCols

public int numCols()

numCols.

Specified by:

numCols in interface DataBox

Returns:

the number of columns in this data box.n

set

public void set(int row,
 int col,
 Number value)

Sets the value at the given row and column to the given Number. This number may be interpreted differently depending on how values are stored. A value of null is interpreted as a missing value.

Sets the value at the given row/column to the given Number value. The value used is number.byteValue(). If the value is null, the missing value marker (-99) is used.

Specified by:

set in interface DataBox

Parameters:

row - the row index.

col - the column index.

value - the value to store.

get

public Number get(int row,
 int col)

get.

Specified by:

get in interface DataBox

Parameters:

row - the row index.

col - the column index.

Returns:

the value at the given row and column as a Number. If the value is missing, null is uniformly returned.

copy

public DataBox copy()

copy.

Specified by:

copy in interface DataBox

Returns:

a copy of this data box.

like

public DataBox like()

like.

Specified by:

like in interface DataBox

Returns:

a DataBox of type ByteDataBox, but with the given dimensions.

viewSelection

public DataBox viewSelection(int[] rows,
 int[] cols)

viewSelection.

Specified by:

viewSelection in interface DataBox

Parameters:

rows - the row indices.

cols - the column indices.

Returns:

this data box, restricted to the given rows and columns.