org.datavec.dataframe.api

Class TimeColumn

java.lang.Object

org.datavec.dataframe.columns.AbstractColumn

org.datavec.dataframe.api.TimeColumn

All Implemented Interfaces:

java.lang.Iterable<java.time.LocalTime>, Column, TimeColumnUtils, TimeMapUtils

public class TimeColumn
extends AbstractColumn
implements java.lang.Iterable<java.time.LocalTime>, TimeMapUtils

A column in a base table that contains float values

Field Summary

Fields

Modifier and Type	Field and Description
static int	MISSING_VALUE

Fields inherited from interface org.datavec.dataframe.columns.TimeColumnUtils

isMissing, isNotMissing

Constructor Summary

Constructors

Constructor and Description
TimeColumn(ColumnMetadata metadata)
TimeColumn(java.lang.String name, int initialSize)

Method Summary

Modifier and Type	Method and Description
void	add(int f)
void	addCell(java.lang.String object)
void	append(Column column)
byte[]	asBytes(int rowNumber) Returns the contents of the cell at rowNumber as a byte[]
java.util.List<java.time.LocalTime>	bottom(int n) Returns the smallest ("bottom") n values in the column
int	byteSize() Returns the width of a cell in this column, in bytes
void	clear()
boolean	contains(java.time.LocalTime time)
int	convert(java.lang.String value) Returns a PackedTime as converted from the given string
TimeColumn	copy() Returns a deep copy of the receiver
int	countMissing() Returns the count of missing values in this column
int	countUnique() Returns the count of unique values in this column
static TimeColumn	create(java.lang.String name)
static TimeColumn	create(java.lang.String fileName, it.unimi.dsi.fastutil.ints.IntArrayList times)
it.unimi.dsi.fastutil.ints.IntArrayList	data()
TimeColumn	emptyCopy() Returns a copy of the receiver with no data.
TimeColumn	emptyCopy(int rowSize) Returns an empty copy of the receiver, with its internal storage initialized to the given row size
java.time.LocalTime	get(int index)
int	getInt(int index)
java.lang.String	getString(int row) Returns a string representation of the value at the given row
it.unimi.dsi.fastutil.ints.IntIterator	intIterator()
Selection	isAfter(java.time.LocalTime time)
Selection	isAfterNoon() Applies a function to every value in this column that returns true if the time is in the PM or "after noon".
Selection	isBefore(java.time.LocalTime time)
Selection	isBeforeNoon() Applies a function to every value in this column that returns true if the time is in the AM or "before noon".
boolean	isEmpty() Returns true if the column has no data
Selection	isEqualTo(java.time.LocalTime value)
Selection	isMidnight()
Selection	isMissing()
Selection	isNoon()
Selection	isNotEqualTo(java.time.LocalTime value)
Selection	isNotMissing()
java.util.Iterator<java.time.LocalTime>	iterator() Returns an iterator over elements of type T.
java.time.LocalTime	max()
java.time.LocalTime	min()
java.lang.String	print()
it.unimi.dsi.fastutil.ints.IntComparator	rowComparator()
Selection	select(IntBiPredicate predicate, int value)
Selection	select(IntPredicate predicate)
TimeColumn	selectIf(IntPredicate predicate) This version operates on predicates that treat the given IntPredicate as operating on a packed local time This is much more efficient that using a LocalTimePredicate, but requires that the developer understand the semantics of packedLocalTimes
TimeColumn	selectIf(LocalTimePredicate predicate)
int	size()
void	sortAscending()
void	sortDescending()
Table	summary()
java.util.List<java.time.LocalTime>	top(int n) Returns the largest ("top") n values in the column
java.lang.String	toString()
ColumnType	type() Returns this column's ColumnType
TimeColumn	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.TimeMapUtils

difference, difference, differenceInHours, differenceInMilliseconds, differenceInMinutes, differenceInSeconds, hour, minuteOfDay, secondOfDay

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

MISSING_VALUE

public static final int MISSING_VALUE

Constructor Detail

TimeColumn

public TimeColumn(ColumnMetadata metadata)

TimeColumn

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

Method Detail

create

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

create

public static TimeColumn create(java.lang.String fileName,
                                it.unimi.dsi.fastutil.ints.IntArrayList times)

size

public int size()

Specified by:

size in interface Column

add

public void add(int f)

type

public ColumnType type()

Description copied from interface: Column

Returns this column's ColumnType

Specified by:

type in interface Column

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 TimeColumn 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 TimeColumn 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 TimeColumn 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

max

public java.time.LocalTime max()

min

public java.time.LocalTime min()

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 TimeColumn 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

isEmpty

public boolean isEmpty()

Description copied from interface: Column

Returns true if the column has no data

Specified by:

isEmpty in interface Column

convert

public int convert(java.lang.String value)

Returns a PackedTime as converted from the given string

Parameters:

value - A string representation of a time

Throws:

java.time.format.DateTimeParseException - if no parser can be found for the time format used

addCell

public void addCell(java.lang.String object)

Specified by:

addCell in interface Column

Specified by:

addCell in class AbstractColumn

getInt

public int getInt(int index)

Specified by:

getInt in interface TimeMapUtils

get

public java.time.LocalTime get(int index)

Specified by:

get in interface TimeMapUtils

rowComparator

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

Specified by:

rowComparator in interface Column

isNotEqualTo

public Selection isNotEqualTo(java.time.LocalTime value)

isEqualTo

public Selection isEqualTo(java.time.LocalTime value)

print

public java.lang.String print()

Specified by:

print in interface Column

data

public it.unimi.dsi.fastutil.ints.IntArrayList data()

Specified by:

data in interface TimeColumnUtils

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

selectIf

public TimeColumn selectIf(LocalTimePredicate predicate)

selectIf

public TimeColumn selectIf(IntPredicate predicate)

This version operates on predicates that treat the given IntPredicate as operating on a packed local time This is much more efficient that using a LocalTimePredicate, but requires that the developer understand the semantics of packedLocalTimes

append

public void append(Column column)

Specified by:

append in interface Column

isMidnight

public Selection isMidnight()

isNoon

public Selection isNoon()

isBefore

public Selection isBefore(java.time.LocalTime time)

isAfter

public Selection isAfter(java.time.LocalTime time)

isBeforeNoon

public Selection isBeforeNoon()

Applies a function to every value in this column that returns true if the time is in the AM or "before noon". Note: we follow the convention that 12:00 NOON is PM and 12 MIDNIGHT is AM

isAfterNoon

public Selection isAfterNoon()

Applies a function to every value in this column that returns true if the time is in the PM or "after noon". Note: we follow the convention that 12:00 NOON is PM and 12 MIDNIGHT is AM

top

public java.util.List<java.time.LocalTime> top(int n)

Returns the largest ("top") n values in the column

Parameters:

n - The maximum number of records to return. The actual number will be smaller if n is greater than the number of observations in the column

Returns:

A list, possibly empty, of the largest observations

bottom

public java.util.List<java.time.LocalTime> bottom(int n)

Returns the smallest ("bottom") n values in the column

Parameters:

n - The maximum number of records to return. The actual number will be smaller if n is greater than the number of observations in the column

Returns:

A list, possibly empty, of the smallest n observations

intIterator

public it.unimi.dsi.fastutil.ints.IntIterator intIterator()

select

public Selection select(IntPredicate predicate)

select

public Selection select(IntBiPredicate predicate,
                        int value)

contains

public boolean contains(java.time.LocalTime time)

isMissing

public Selection isMissing()

Specified by:

isMissing in interface Column

isNotMissing

public Selection isNotMissing()

Specified by:

isNotMissing in interface Column

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 rowNumber)

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

Specified by:

asBytes in interface Column

iterator

public java.util.Iterator<java.time.LocalTime> iterator()

Returns an iterator over elements of type T.

Specified by:

iterator in interface java.lang.Iterable<java.time.LocalTime>

Returns:

an Iterator.