org.datavec.dataframe.api

Class BooleanColumn

java.lang.Object

org.datavec.dataframe.columns.AbstractColumn

org.datavec.dataframe.api.BooleanColumn

All Implemented Interfaces:

Column, BooleanMapUtils

public class BooleanColumn
extends AbstractColumn
implements BooleanMapUtils

A column in a base table that contains float values

Field Summary

Fields

Modifier and Type	Field and Description
static byte	MISSING_VALUE

Constructor Summary

Constructors

Constructor and Description
BooleanColumn(ColumnMetadata metadata)
BooleanColumn(java.lang.String name, int initialSize)
BooleanColumn(java.lang.String name, Selection hits, int columnSize)

Method Summary

Modifier and Type	Method and Description
void	add(boolean b)
void	add(byte b)
void	addCell(java.lang.String object)
void	append(Column column)
byte[]	asBytes(int row) Returns the contents of the cell at rowNumber as a byte[]
it.unimi.dsi.fastutil.booleans.BooleanSet	asSet()
it.unimi.dsi.fastutil.bytes.ByteIterator	byteIterator()
int	byteSize() Returns the width of a cell in this column, in bytes
void	clear()
boolean	contains(boolean aBoolean)
static boolean	convert(java.lang.String stringValue)
BooleanColumn	copy() Returns a deep copy of the receiver
int	countFalse()
int	countMissing() Returns the count of missing values in this column
int	countTrue()
int	countUnique() Returns the count of unique values in this column
static BooleanColumn	create(java.lang.String name)
static BooleanColumn	create(java.lang.String fileName, it.unimi.dsi.fastutil.bytes.ByteArrayList bools)
static BooleanColumn	create(java.lang.String name, int rowSize)
static BooleanColumn	create(java.lang.String name, Selection selection, int rowSize)
it.unimi.dsi.fastutil.bytes.ByteArrayList	data() Returns a ByteArrayList containing 0 (false), 1 (true) or Byte.MIN_VALUE (missing)
BooleanColumn	emptyCopy() Returns a copy of the receiver with no data.
BooleanColumn	emptyCopy(int rowSize) Returns an empty copy of the receiver, with its internal storage initialized to the given row size
java.lang.Boolean	get(int i) Returns the value in row i as a Boolean
byte	getByte(int i) Returns the value in row i as a byte (0, 1, or Byte.MIN_VALUE representing missing data)
java.lang.String	getString(int row) Returns a string representation of the value at the given row
boolean	isEmpty() Returns true if the column has no data
Selection	isEqualTo(BooleanColumn other)
Selection	isFalse()
Selection	isMissing()
Selection	isNotMissing()
Selection	isTrue()
java.util.Iterator<java.lang.Boolean>	iterator()
java.lang.String	print()
it.unimi.dsi.fastutil.ints.IntComparator	rowComparator()
Selection	select(BooleanPredicate predicate)
void	set(int i, boolean b)
int	size()
void	sortAscending()
void	sortDescending()
Table	summary()
int[]	toIntArray()
IntColumn	toIntColumn()
java.lang.String	toString()
ColumnType	type() Returns this column's ColumnType
BooleanColumn	unique() Returns a column of the same type as the receiver, containing only the unique values of the receiver

Methods inherited from class org.datavec.dataframe.columns.AbstractColumn

columnMetadata, columnWidth, comment, difference, id, metadata, name, setComment, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.datavec.dataframe.mapping.BooleanMapUtils

and, or

Methods inherited from interface org.datavec.dataframe.columns.Column

columnMetadata, columnWidth, comment, difference, first, first, id, last, last, metadata, name, setComment, setName, subset, title, toDoubleArray

Field Detail

MISSING_VALUE

public static final byte MISSING_VALUE

See Also:

Constant Field Values

Constructor Detail

BooleanColumn

public BooleanColumn(ColumnMetadata metadata)

BooleanColumn

public BooleanColumn(java.lang.String name,
                     int initialSize)

BooleanColumn

public BooleanColumn(java.lang.String name,
                     Selection hits,
                     int columnSize)

Method Detail

create

public static BooleanColumn create(java.lang.String name)

create

public static BooleanColumn create(java.lang.String name,
                                   int rowSize)

create

public static BooleanColumn create(java.lang.String name,
                                   Selection selection,
                                   int rowSize)

size

public int size()

Specified by:

size in interface Column

summary

public Table summary()

Specified by:

summary in interface Column

countMissing

public int countMissing()

Returns the count of missing values in this column

Specified by:

countMissing in interface Column

countUnique

public int countUnique()

Description copied from interface: Column

Returns the count of unique values in this column

Specified by:

countUnique in interface Column

unique

public BooleanColumn unique()

Description copied from interface: Column

Returns a column of the same type as the receiver, containing only the unique values of the receiver

Specified by:

unique in interface Column

type

public ColumnType type()

Description copied from interface: Column

Returns this column's ColumnType

Specified by:

type in interface Column

add

public void add(boolean b)

add

public void add(byte b)

getString

public java.lang.String getString(int row)

Description copied from interface: Column

Returns a string representation of the value at the given row

Specified by:

getString in interface Column

emptyCopy

public BooleanColumn emptyCopy()

Description copied from interface: Column

Returns a copy of the receiver with no data. The column name and type are the same

Specified by:

emptyCopy in interface Column

emptyCopy

public BooleanColumn emptyCopy(int rowSize)

Description copied from interface: Column

Returns an empty copy of the receiver, with its internal storage initialized to the given row size

Specified by:

emptyCopy in interface Column

clear

public void clear()

Specified by:

clear in interface Column

copy

public BooleanColumn copy()

Description copied from interface: Column

Returns a deep copy of the receiver

Specified by:

copy in interface Column

sortAscending

public void sortAscending()

Specified by:

sortAscending in interface Column

sortDescending

public void sortDescending()

Specified by:

sortDescending in interface Column

convert

public static boolean convert(java.lang.String stringValue)

addCell

public void addCell(java.lang.String object)

Specified by:

addCell in interface Column

Specified by:

addCell in class AbstractColumn

get

public java.lang.Boolean get(int i)

Returns the value in row i as a Boolean

Parameters:

i - the row number

Returns:

A Boolean object (may be null)

getByte

public byte getByte(int i)

Returns the value in row i as a byte (0, 1, or Byte.MIN_VALUE representing missing data)

Parameters:

i - the row number

isEmpty

public boolean isEmpty()

Description copied from interface: Column

Returns true if the column has no data

Specified by:

isEmpty in interface Column

create

public static BooleanColumn create(java.lang.String fileName,
                                   it.unimi.dsi.fastutil.bytes.ByteArrayList bools)

countTrue

public int countTrue()

countFalse

public int countFalse()

isFalse

public Selection isFalse()

isTrue

public Selection isTrue()

isEqualTo

public Selection isEqualTo(BooleanColumn other)

data

public it.unimi.dsi.fastutil.bytes.ByteArrayList data()

Returns a ByteArrayList containing 0 (false), 1 (true) or Byte.MIN_VALUE (missing)

set

public void set(int i,
                boolean b)

rowComparator

public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()

Specified by:

rowComparator in interface Column

append

public void append(Column column)

Specified by:

append in interface Column

print

public java.lang.String print()

Specified by:

print in interface Column

isMissing

public Selection isMissing()

Specified by:

isMissing in interface Column

isNotMissing

public Selection isNotMissing()

Specified by:

isNotMissing in interface Column

iterator

public java.util.Iterator<java.lang.Boolean> iterator()

byteIterator

public it.unimi.dsi.fastutil.bytes.ByteIterator byteIterator()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

asSet

public it.unimi.dsi.fastutil.booleans.BooleanSet asSet()

contains

public boolean contains(boolean aBoolean)

byteSize

public int byteSize()

Description copied from interface: Column

Returns the width of a cell in this column, in bytes

Specified by:

byteSize in interface Column

asBytes

public byte[] asBytes(int row)

Description copied from interface: Column

Returns the contents of the cell at rowNumber as a byte[]

Specified by:

asBytes in interface Column

select

public Selection select(BooleanPredicate predicate)

toIntArray

public int[] toIntArray()

toIntColumn

public IntColumn toIntColumn()