tech.tablesaw.api

Class DoubleColumn

java.lang.Object

tech.tablesaw.columns.AbstractColumn

tech.tablesaw.api.DoubleColumn

All Implemented Interfaces:

it.unimi.dsi.fastutil.doubles.DoubleIterable, Iterable<Double>, CategoricalColumn, NumberColumn, Column, NumberFillers<NumberColumn>, NumberFilters, NumberMapFunctions

public class DoubleColumn
extends AbstractColumn
implements NumberColumn

A column in a base table that contains double precision floating point values

Field Summary

Fields inherited from class tech.tablesaw.columns.AbstractColumn

DEFAULT_ARRAY_SIZE

Fields inherited from interface tech.tablesaw.api.NumberColumn

MISSING_VALUE

Method Summary

Modifier and Type	Method and Description
void	append(Column column)
DoubleColumn	append(double d) Adds the given double to this column
DoubleColumn	append(float f) Adds the given float to this column
DoubleColumn	appendCell(String object)
DoubleColumn	appendMissing() Appends a missing value appropriate to the column
byte[]	asBytes(int rowNumber) Returns the contents of the cell at rowNumber as a byte[]
DateTimeColumn	asDateTimes(ZoneOffset offset) Returns a DateTimeColumn where each value is the LocalDateTime represented by the values in this column The values in this column must be longs that represent the time in milliseconds from the epoch as in standard Java date/time calculations
double[]	asDoubleArray()
int[]	asIntArray()
it.unimi.dsi.fastutil.ints.IntSet	asIntegerSet()
it.unimi.dsi.fastutil.doubles.DoubleSet	asSet()
it.unimi.dsi.fastutil.doubles.DoubleArrayList	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.
void	clear()
boolean	contains(double value)
static double	convert(String stringValue) Returns a double that is parsed from the given String
NumberColumn	copy() Returns a deep copy of the receiver
static DoubleColumn	create(String columnName)
static DoubleColumn	create(String name, double[] arr)
static DoubleColumn	create(String name, float[] arr)
static DoubleColumn	create(String name, int initialSize)
static DoubleColumn	create(String name, int[] arr)
static DoubleColumn	create(String name, List<Number> numberList)
static DoubleColumn	create(String name, long[] arr)
static DoubleColumn	create(String name, Number[] numbers)
it.unimi.dsi.fastutil.doubles.DoubleList	dataInternal() Returns a clone of the internal data structure
NumberColumn	emptyCopy() Returns a copy of the receiver with no data.
DoubleColumn	emptyCopy(int rowSize) Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
Selection	eval(BiPredicate<Number,Number> predicate, Number number)
Selection	eval(DoubleBiPredicate predicate, Number number)
Selection	eval(DoubleBiPredicate predicate, NumberColumn otherColumn)
Selection	eval(DoublePredicate predicate)
Selection	eval(DoubleRangePredicate predicate, Number rangeStart, Number rangeEnd)
DoubleColumn	fillWith(it.unimi.dsi.fastutil.doubles.DoubleIterable iterable)
DoubleColumn	fillWith(it.unimi.dsi.fastutil.doubles.DoubleIterator iterator)
DoubleColumn	fillWith(DoubleSupplier supplier)
double	firstElement()
double	get(int index)
double	getDouble(int row) Returns a double representation of the value at the given row.
long	getLong(int i) Returns the value of the ith element rounded to the nearest long
String	getString(int row) Returns a string representation of the value at the given row.
String	getUnformattedString(int row)
static DoubleColumn	indexColumn(String columnName, int size, int startsWith) Returns a new numeric column initialized with the given name and size.
boolean	isEmpty() Returns true if the column has no data
Selection	isIn(double... doubles)
Selection	isIn(Number... numbers)
boolean	isMissing(int rowNumber)
Selection	isNotIn(double... doubles)
Selection	isNotIn(Number... numbers)
it.unimi.dsi.fastutil.doubles.DoubleIterator	iterator()
NumberColumn	lag(int n) Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
NumberColumn	lead(int n) Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.
DoubleColumn	removeMissing()
Integer	roundInt(int i) Returns the rounded value as an int
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
DoubleColumn	set(int r, double value)
DoubleColumn	set(Selection rowSelection, double newValue) Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
void	setPrintFormatter(NumberColumnFormatter formatter)
void	setPrintFormatter(NumberFormat format, String missingValueString)
int	size()
void	sortAscending()
void	sortDescending()
Stats	stats()
Table	summary()
it.unimi.dsi.fastutil.doubles.DoubleArrayList	top(int n) Returns the largest ("top") n values in the column TODO(lwhite): Consider whether this should exclude missing
Column	unique() TODO(lwhite): Ensure proper handling of missing values.
NumberColumn	where(Selection selection)

Methods inherited from class tech.tablesaw.columns.AbstractColumn

columnWidth, name, print, 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.NumberColumn

countMissing, countUnique, geometricMean, kendalls, kurtosis, max, mean, median, min, pearsons, percentile, populationVariance, product, quadraticMean, quartile1, quartile3, range, skewness, spearmans, standardDeviation, sum, sumOfLogs, sumOfSquares, valueIsMissing, variance

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, neg, normalize, pctChange, remainder, round, roundInt, sqrt, square, subtract, subtract, subtract

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleIterable

forEach, forEach

Methods inherited from interface java.lang.Iterable

spliterator

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

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

Methods inherited from interface tech.tablesaw.api.CategoricalColumn

countByCategory

Methods inherited from interface tech.tablesaw.columns.Column

columnWidth, create, first, inRange, last, name, print, rolling, rows, sampleN, sampleX, setName, subset, summarizeIf, title, type

Method Detail

create

public static DoubleColumn create(String name,
                                  int initialSize)

create

public static DoubleColumn create(String name,
                                  double[] arr)

create

public static DoubleColumn create(String name,
                                  float[] arr)

create

public static DoubleColumn create(String name,
                                  int[] arr)

create

public static DoubleColumn create(String name,
                                  long[] arr)

create

public static DoubleColumn create(String name,
                                  List<Number> numberList)

create

public static DoubleColumn create(String name,
                                  Number[] numbers)

convert

public static double convert(String stringValue)

Returns a double that is parsed from the given String

We remove any commas before parsing

removeMissing

public DoubleColumn removeMissing()

Specified by:

removeMissing in interface Column

indexColumn

public static DoubleColumn indexColumn(String columnName,
                                       int size,
                                       int startsWith)

Returns a new numeric column initialized with the given name and size. The values in the column are integers beginning at startsWith and continuing through size (exclusive), monotonically increasing by 1 TODO consider a generic fill function including steps or random samples from various distributions

create

public static DoubleColumn create(String columnName)

isMissing

public boolean isMissing(int rowNumber)

Specified by:

isMissing in interface NumberColumn

Specified by:

isMissing in interface Column

setPrintFormatter

public void setPrintFormatter(NumberFormat format,
                              String missingValueString)

Specified by:

setPrintFormatter in interface NumberColumn

appendMissing

public DoubleColumn appendMissing()

Description copied from interface: Column

Appends a missing value appropriate to the column

Specified by:

appendMissing in interface NumberColumn

Specified by:

appendMissing in interface Column

setPrintFormatter

public void setPrintFormatter(NumberColumnFormatter formatter)

Specified by:

setPrintFormatter in interface NumberColumn

size

public int size()

Specified by:

size in interface NumberColumn

Specified by:

size in interface Column

summary

public Table summary()

Specified by:

summary in interface NumberColumn

Specified by:

summary in interface Column

stats

public Stats stats()

Specified by:

stats in interface NumberColumn

top

public it.unimi.dsi.fastutil.doubles.DoubleArrayList top(int n)

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

Specified by:

top in interface NumberColumn

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 it.unimi.dsi.fastutil.doubles.DoubleArrayList bottom(int n)

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

Specified by:

bottom in interface NumberColumn

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

unique

public Column unique()

TODO(lwhite): Ensure proper handling of missing values. They should not end up in the result set

Specified by:

unique in interface NumberColumn

Specified by:

unique in interface Column

Returns:

a Column

firstElement

public double firstElement()

Specified by:

firstElement in interface NumberColumn

append

public DoubleColumn append(float f)

Adds the given float to this column

Specified by:

append in interface NumberColumn

append

public DoubleColumn append(double d)

Adds the given double to this column

Specified by:

append in interface NumberColumn

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 NumberColumn

Specified by:

getString in interface Column

Parameters:

row - The index of the row.

Returns:

value as String

getDouble

public double getDouble(int row)

Description copied from interface: Column

Returns a double representation of the value at the given row. The nature of the returned value is column-specific. The double returned MAY be the actual value (for Number columns) but is more likely a number that maps to the column value in some way.

Specified by:

getDouble in interface NumberColumn

Specified by:

getDouble in interface Column

Parameters:

row - The index of the row.

Returns:

value as String

getUnformattedString

public String getUnformattedString(int row)

Specified by:

getUnformattedString in interface NumberColumn

Specified by:

getUnformattedString in interface Column

emptyCopy

public NumberColumn 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 NumberColumn

Specified by:

emptyCopy in interface Column

Returns:

a empty copy of Column

emptyCopy

public DoubleColumn 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 NumberColumn

Specified by:

emptyCopy in interface Column

Parameters:

rowSize - the initial row size

Returns:

a Column

lead

public NumberColumn lead(int n)

Description copied from interface: Column

Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.

Specified by:

lead in interface NumberColumn

Specified by:

lead in interface Column

lag

public NumberColumn lag(int n)

Description copied from interface: Column

Returns a column of the same type and size as the receiver, containing the receivers values offset by n.

For example if you lag a column containing 2, 3, 4 by 1, you get a column containing NA, 2, 3

Specified by:

lag in interface NumberColumn

Specified by:

lag in interface Column

copy

public NumberColumn copy()

Description copied from interface: Column

Returns a deep copy of the receiver

Specified by:

copy in interface NumberColumn

Specified by:

copy in interface Column

Returns:

a Column

clear

public void clear()

Specified by:

clear in interface NumberColumn

Specified by:

clear in interface Column

sortAscending

public void sortAscending()

Specified by:

sortAscending in interface NumberColumn

Specified by:

sortAscending in interface Column

sortDescending

public void sortDescending()

Specified by:

sortDescending in interface NumberColumn

Specified by:

sortDescending 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 NumberColumn

Specified by:

isEmpty in interface Column

Returns:

true if empty, false if not

appendCell

public DoubleColumn appendCell(String object)

Specified by:

appendCell in interface NumberColumn

Specified by:

appendCell in interface Column

Specified by:

appendCell in class AbstractColumn

roundInt

public Integer roundInt(int i)

Returns the rounded value as an int

Specified by:

roundInt in interface NumberColumn

Throws:

ClassCastException - if the returned value will not fit in an int

getLong

public long getLong(int i)

Returns the value of the ith element rounded to the nearest long

Specified by:

getLong in interface NumberColumn

Parameters:

i - the index in the column

Returns:

the value at i, rounded to the nearest integer

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 NumberColumn

Specified by:

rowComparator in interface Column

get

public double get(int index)

Specified by:

get in interface NumberColumn

Specified by:

get in interface NumberMapFunctions

set

public DoubleColumn set(int r,
                        double value)

Specified by:

set in interface NumberColumn

set

public DoubleColumn set(Selection rowSelection,
                        double newValue)

Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria

Example: myColumn.set(4.0, myColumn.valueIsMissing()); // no more missing values

Specified by:

set in interface NumberColumn

asDoubleArray

public double[] asDoubleArray()

Specified by:

asDoubleArray in interface NumberColumn

Specified by:

asDoubleArray in interface Column

append

public void append(Column column)

Specified by:

append in interface NumberColumn

Specified by:

append in interface Column

iterator

public it.unimi.dsi.fastutil.doubles.DoubleIterator iterator()

Specified by:

iterator in interface it.unimi.dsi.fastutil.doubles.DoubleIterable

Specified by:

iterator in interface Iterable<Double>

Specified by:

iterator in interface NumberColumn

where

public NumberColumn where(Selection selection)

Specified by:

where in interface NumberColumn

Specified by:

where in interface Column

eval

public Selection eval(DoublePredicate predicate)

Specified by:

eval in interface NumberColumn

Specified by:

eval in interface NumberFilters

eval

public Selection eval(DoubleBiPredicate predicate,
                      NumberColumn otherColumn)

Specified by:

eval in interface NumberColumn

Specified by:

eval in interface NumberFilters

eval

public Selection eval(DoubleBiPredicate predicate,
                      Number number)

Specified by:

eval in interface NumberColumn

Specified by:

eval in interface NumberFilters

eval

public Selection eval(BiPredicate<Number,Number> predicate,
                      Number number)

Specified by:

eval in interface NumberFilters

eval

public Selection eval(DoubleRangePredicate predicate,
                      Number rangeStart,
                      Number rangeEnd)

Specified by:

eval in interface NumberColumn

Specified by:

eval in interface NumberFilters

isIn

public Selection isIn(Number... numbers)

Specified by:

isIn in interface NumberColumn

Specified by:

isIn in interface NumberFilters

isIn

public Selection isIn(double... doubles)

Specified by:

isIn in interface NumberFilters

isNotIn

public Selection isNotIn(Number... numbers)

Specified by:

isNotIn in interface NumberColumn

Specified by:

isNotIn in interface NumberFilters

isNotIn

public Selection isNotIn(double... doubles)

Specified by:

isNotIn in interface NumberFilters

asSet

public it.unimi.dsi.fastutil.doubles.DoubleSet asSet()

Specified by:

asSet in interface NumberColumn

contains

public boolean contains(double value)

Specified by:

contains in interface NumberColumn

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 NumberColumn

Specified by:

byteSize in interface Column

Returns:

width in bytes

asBytes

public byte[] asBytes(int rowNumber)

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

Specified by:

asBytes in interface NumberColumn

Specified by:

asBytes in interface Column

Parameters:

rowNumber - index of the row

Returns:

content as byte[]

asIntArray

public int[] asIntArray()

Specified by:

asIntArray in interface CategoricalColumn

Specified by:

asIntArray in interface NumberColumn

asIntegerSet

public it.unimi.dsi.fastutil.ints.IntSet asIntegerSet()

dataInternal

public it.unimi.dsi.fastutil.doubles.DoubleList dataInternal()

Description copied from interface: NumberFilters

Returns a clone of the internal data structure

Specified by:

dataInternal in interface NumberColumn

Specified by:

dataInternal in interface NumberFilters

asDateTimes

public DateTimeColumn asDateTimes(ZoneOffset offset)

Description copied from interface: NumberColumn

Returns a DateTimeColumn where each value is the LocalDateTime represented by the values in this column The values in this column must be longs that represent the time in milliseconds from the epoch as in standard Java date/time calculations

Specified by:

asDateTimes in interface NumberColumn

Parameters:

offset - The ZoneOffset to use in the calculation

Returns:

A column of LocalDateTime values

fillWith

public DoubleColumn fillWith(it.unimi.dsi.fastutil.doubles.DoubleIterator iterator)

Specified by:

fillWith in interface NumberFillers<NumberColumn>

fillWith

public DoubleColumn fillWith(it.unimi.dsi.fastutil.doubles.DoubleIterable iterable)

Specified by:

fillWith in interface NumberFillers<NumberColumn>

fillWith

public DoubleColumn fillWith(DoubleSupplier supplier)

Specified by:

fillWith in interface NumberFillers<NumberColumn>