tech.tablesaw.api

Class NumberColumn<T extends Number>

java.lang.Object

tech.tablesaw.columns.AbstractColumn<T>

tech.tablesaw.api.NumberColumn<T>

All Implemented Interfaces:

Iterable<T>, Comparator<T>, NumericColumn<T>, Column<T>, NumberFilters, NumberMapFunctions

Direct Known Subclasses:

DoubleColumn, FloatColumn, IntColumn, LongColumn, ShortColumn

public abstract class NumberColumn<T extends Number>
extends AbstractColumn<T>
implements NumericColumn<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected it.unimi.dsi.fastutil.ints.IntComparator	comparator
protected Locale	locale
protected NumberColumnFormatter	printFormatter

Fields inherited from class tech.tablesaw.columns.AbstractColumn

DEFAULT_ARRAY_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NumberColumn(ColumnType type, String name)

Method Summary

Modifier and Type	Method and Description
boolean	allMatch(DoublePredicate test) Returns true if all rows satisfy the predicate, false otherwise
boolean	anyMatch(DoublePredicate test) Returns true if any row satisfies the predicate, false otherwise
abstract NumberColumn<T>	appendMissing() Appends a missing value appropriate to the column
abstract byte[]	asBytes(int rowNumber) Returns the contents of the cell at rowNumber as a byte[]
abstract NumericColumn<T>	bottom(int n) Returns the smallest ("bottom") n values in the column TODO(lwhite): Consider whether this should exclude missing
int	byteSize() Returns the width of a cell in this column, in bytes.
abstract NumberColumn<T>	copy() Returns a deep copy of the receiver
int	countMissing() Returns the count of missing values in this column
protected abstract NumberColumn<T>	createCol(String name)
protected abstract NumberColumn<T>	createCol(String name, int size)
NumberColumn<T>	emptyCopy() Returns a copy of the receiver with no data.
NumberColumn<T>	emptyCopy(int rowSize) Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
String	getString(int row) Returns a string representation of the value at the given row.
NumberColumn<T>	inRange(int start, int end) Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
boolean	noneMatch(DoublePredicate test) Returns true if no row satisfies the predicate, false otherwise
it.unimi.dsi.fastutil.ints.IntComparator	rowComparator() Compares the given ints, which refer to the indexes of the doubles in this column, according to the values of the doubles themselves
void	setPrintFormatter(NumberColumnFormatter formatter)
void	setPrintFormatter(NumberFormat format, String missingValueString)
abstract NumericColumn<T>	top(int n) Returns the largest ("top") n values in the column TODO(lwhite): Consider whether this should exclude missing

Methods inherited from class tech.tablesaw.columns.AbstractColumn

asStringColumn, name, setName, toString, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface tech.tablesaw.api.NumericColumn

asDoubleArray, asDoubleColumn, asFloatColumn, asIntColumn, asLongColumn, asShortColumn, asStringColumn, count, count, eval, eval, eval, eval, eval, geometricMean, getDouble, isEmpty, isIn, isIn, isMissing, isNotIn, isNotIn, isNotMissing, kendalls, kurtosis, lag, lead, mapInto, max, max, mean, median, min, min, pearsons, percentile, populationVariance, product, quadraticMean, quartile1, quartile3, range, reduce, reduce, rolling, skewness, spearmans, standardDeviation, stats, sum, summarize, summary, sumOfLogs, sumOfSquares, variance, where

Methods inherited from interface tech.tablesaw.columns.Column

allMatch, anyMatch, append, append, append, appendCell, appendCell, appendObj, asList, asObjectArray, clear, columnWidth, contains, count, count, countUnique, filter, first, get, getUnformattedString, isMissing, last, map, mapInto, max, max, min, min, name, noneMatch, print, reduce, reduce, removeMissing, sampleN, sampleX, set, set, set, set, setMissing, setName, size, sortAscending, sortDescending, sorted, subset, title, type, unique

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.Comparator

compare, comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface tech.tablesaw.columns.numbers.NumberMapFunctions

abs, add, add, add, asPercent, asRatio, bin, cube, cubeRoot, cumProd, cumSum, difference, divide, divide, divide, log10, log1p, logN, multiply, multiply, multiply, name, neg, normalize, pctChange, power, remainder, round, roundInt, size, sqrt, square, subtract, subtract, subtract

Methods inherited from interface tech.tablesaw.columns.numbers.NumberFilters

isBetweenExclusive, isBetweenInclusive, isCloseTo, isEqualTo, isEqualTo, isGreaterThan, isGreaterThan, isGreaterThanOrEqualTo, isGreaterThanOrEqualTo, isLessThan, isLessThan, isLessThanOrEqualTo, isLessThanOrEqualTo, isNegative, isNonNegative, isNotEqualTo, isNotEqualTo, isPositive, isZero, size

Field Detail

printFormatter

protected NumberColumnFormatter printFormatter

locale

protected Locale locale

comparator

protected final it.unimi.dsi.fastutil.ints.IntComparator comparator

Constructor Detail

NumberColumn

protected NumberColumn(ColumnType type,
                       String name)

Method Detail

createCol

protected abstract NumberColumn<T> createCol(String name,
                                             int size)

createCol

protected abstract NumberColumn<T> createCol(String name)

setPrintFormatter

public void setPrintFormatter(NumberFormat format,
                              String missingValueString)

setPrintFormatter

public void setPrintFormatter(NumberColumnFormatter formatter)

top

public abstract NumericColumn<T> top(int n)

Returns the largest ("top") n values in the column TODO(lwhite): Consider whether this should exclude missing

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 abstract NumericColumn<T> bottom(int n)

Returns the smallest ("bottom") n values in the column TODO(lwhite): Consider whether this should exclude missing

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

getString

public 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<T extends Number>

Parameters:

row - The index of the row.

Returns:

value as String

inRange

public NumberColumn<T> inRange(int start,
                               int end)

Description copied from interface: Column

Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive

Specified by:

inRange in interface Column<T extends Number>

emptyCopy

public NumberColumn<T> 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<T extends Number>

Specified by:

emptyCopy in class AbstractColumn<T extends Number>

Returns:

a empty copy of Column

emptyCopy

public NumberColumn<T> 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<T extends Number>

Parameters:

rowSize - the initial row size

Returns:

a Column

copy

public abstract NumberColumn<T> copy()

Description copied from interface: Column

Returns a deep copy of the receiver

Specified by:

copy in interface Column<T extends Number>

Returns:

a Column

rowComparator

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

Compares the given ints, which refer to the indexes of the doubles in this column, according to the values of the doubles themselves

Specified by:

rowComparator in interface Column<T extends Number>

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<T extends Number>

Returns:

width in bytes

asBytes

public abstract byte[] asBytes(int rowNumber)

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

Specified by:

asBytes in interface Column<T extends Number>

Parameters:

rowNumber - index of the row

Returns:

content as byte[]

appendMissing

public abstract NumberColumn<T> appendMissing()

Description copied from interface: Column

Appends a missing value appropriate to the column

Specified by:

appendMissing in interface Column<T extends Number>

countMissing

public int countMissing()

Returns the count of missing values in this column

Specified by:

countMissing in interface Column<T extends Number>

Returns:

missing values as int

allMatch

public boolean allMatch(DoublePredicate test)

Returns true if all rows satisfy the predicate, false otherwise

Parameters:

test - the predicate

Returns:

true if all rows satisfy the predicate, false otherwise

anyMatch

public boolean anyMatch(DoublePredicate test)

Returns true if any row satisfies the predicate, false otherwise

Parameters:

test - the predicate

Returns:

true if any rows satisfies the predicate, false otherwise

noneMatch

public boolean noneMatch(DoublePredicate test)

Returns true if no row satisfies the predicate, false otherwise

Parameters:

test - the predicate

Returns:

true if no row satisfies the predicate, false otherwise