Package tech.tablesaw.api

Class IntColumn

java.lang.Object

tech.tablesaw.columns.AbstractColumn<C,T>

tech.tablesaw.api.NumberColumn<IntColumn,Integer>

tech.tablesaw.api.IntColumn

All Implemented Interfaces:

Iterable<Integer>, Comparator<Integer>, CategoricalColumn<Integer>, NumericColumn<Integer>, Column<Integer>, NumberFilters, NumberMapFunctions, FilterSpec<Selection>, NumberFilterSpec<Selection>

public class IntColumn
extends NumberColumn<IntColumn,Integer>
implements CategoricalColumn<Integer>

A column that contains int values

Field Summary

Fields

Modifier and Type	Field	Description
protected final it.unimi.dsi.fastutil.ints.IntArrayList	data

Fields inherited from class tech.tablesaw.api.NumberColumn

comparator, locale

Fields inherited from class tech.tablesaw.columns.AbstractColumn

DEFAULT_ARRAY_SIZE, DEFAULT_COLUMN_TYPE_MISMATCH_MESSAGE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IntColumn(String name, it.unimi.dsi.fastutil.ints.IntArrayList data)

Method Summary

Modifier and Type	Method	Description
IntColumn	append(int i)
IntColumn	append(Integer val)	Appends value to the bottom of this column and return this column
IntColumn	append(Column<Integer> column)	Appends all the values in the argument to the bottom of this column and return this column
IntColumn	append(Column<Integer> column, int row)	Appends the value at the given row in the given column to the bottom of this column and return this column
IntColumn	appendCell(String value)	Add one element to the bottom of this column and set its value to the parsed value of the given String.
IntColumn	appendCell(String value, AbstractColumnParser<?> parser)	Add one element to the bottom of this column and set its value to the parsed value of the given String, as performed by the given parser
IntColumn	appendMissing()	Appends a missing value appropriate to the column
IntColumn	appendObj(Object obj)	Appends the given value to the bottom of this column and return this column
byte[]	asBytes(int rowNumber)	Returns the contents of the cell at rowNumber as a byte[].
DoubleColumn	asDoubleColumn()	Returns a new DoubleColumn containing a value for each value in this column, truncating if necessary.
FloatColumn	asFloatColumn()	Returns a new FloatColumn containing a value for each value in this column, truncating if necessary.
int[]	asIntArray()
LongColumn	asLongColumn()	Returns a new LongColumn containing a value for each value in this column
Integer[]	asObjectArray()	Returns an array of objects as appropriate for my type of column
Set<Integer>	asSet()	Returns a Set containing all the unique values in this column
ShortColumn	asShortColumn()	Returns a new ShortColumn containing a value for each value in this column
IntColumn	bottom(int n)	Returns the smallest ("bottom") n values in the column TODO(lwhite): Consider whether this should exclude missing
void	clear()	Removes all elements TODO: Make this return this column
int	compare(Integer o1, Integer o2)
IntColumn	copy()	Returns a deep copy of the receiver
int	countUnique()	Returns the count of unique values in this column.
static IntColumn	create(String name)
static IntColumn	create(String name, int initialSize)
static IntColumn	create(String name, int... arr)
static IntColumn	create(String name, Integer[] arr)
static IntColumn	create(String name, IntStream stream)
IntColumn	createCol(String name)
IntColumn	createCol(String name, int initialSize)
boolean	equals(int rowNumber1, int rowNumber2)	Returns true if the value in this column at rowNumber1 is equal to the value at rowNumber2
Integer	get(int index)	Returns the value at the given zero-based index
double	getDouble(int row)	Returns a double representation of the number at index
int	getInt(int row)	Returns the value at the given index.
String	getString(int row)	Returns a string representation of the value at the given row.
String	getUnformattedString(int row)	Returns a String representation of the value at index r, without any formatting applied
static IntColumn	indexColumn(String columnName, int size, int startsWith)	Returns a new numeric column initialized with the given name and size.
it.unimi.dsi.fastutil.ints.IntIterator	intIterator()
Selection	isIn(int... numbers)
boolean	isMissing(int rowNumber)	Returns true if the value at rowNumber is missing
boolean	isMissingValue(int value)
Selection	isNotIn(int... numbers)
Selection	isNotIn(IntColumn ints)
Iterator<Integer>	iterator()
IntColumn	lag(int n)	Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
IntColumn	removeMissing()	Returns a copy of this column with the missing values removed
IntColumn	set(int i, int val)
IntColumn	set(int i, Integer val)	Sets the value at index row to the given value and return this column
Column<Integer>	set(int row, String stringValue, AbstractColumnParser<?> parser)	Sets the value at row to the parsed value of the given String using the given parser and returns this column
IntColumn	set(int row, Column<Integer> column, int sourceRow)	Sets the value at row to the value at sourceRow in the given column and return this column
IntColumn	setMissing(int r)	Sets the value at index i to the missing-value indicator for this column type, and return this column
int	size()	Returns the number of elements in this column, including missing values
void	sortAscending()	Sorts my values in ascending order
void	sortDescending()	Sorts my values in descending order
IntColumn	subset(int[] rows)	Return a column of the same type containing just those elements whose indexes are included in the given array
IntColumn	top(int n)	Returns the largest ("top") n values in the column TODO(lwhite): Consider whether this should exclude missing
IntColumn	unique()	Returns a column of the same type containing only the unique values
int	valueHash(int rowNumber)	Returns an int suitable as a hash for the value in this column at the given index
static boolean	valueIsMissing(int value)

Methods inherited from class tech.tablesaw.api.NumberColumn

byteSize, countMissing, emptyCopy, emptyCopy, getPrintFormatter, rowComparator, set, set, setPrintFormatter, setPrintFormatter

Methods inherited from class tech.tablesaw.columns.AbstractColumn

asStringColumn, filter, first, indexOf, inRange, last, map, max, min, name, parser, sampleN, sampleX, set, set, setName, setParser, sorted, 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.CategoricalColumn

countByCategory

Methods inherited from interface tech.tablesaw.columns.Column

allMatch, anyMatch, asList, byteSize, columnWidth, contains, count, count, countMissing, emptyCopy, emptyCopy, filter, first, indexOf, inRange, last, map, map, mapInto, max, max, min, min, name, noneMatch, parser, print, reduce, reduce, rowComparator, sampleN, sampleX, set, set, set, setMissingTo, setName, setParser, sorted, title, type

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

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

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

Methods inherited from interface tech.tablesaw.api.NumericColumn

allMatch, anyMatch, asDoubleArray, asIntColumn, asStringColumn, autoCorrelation, autoCorrelation, count, count, eval, eval, geometricMean, interpolate, isEmpty, isIn, isMissing, isNotIn, isNotMissing, kendalls, kurtosis, lead, mapInto, max, max, mean, median, min, min, noneMatch, pctChange, pearsons, percentile, populationVariance, product, quadraticMean, quartile1, quartile3, range, reduce, reduce, rolling, skewness, spearmans, standardDeviation, stats, sum, summarize, summary, sumOfLogs, sumOfSquares, variance, where

Field Details

data

protected final it.unimi.dsi.fastutil.ints.IntArrayList data

Constructor Details

IntColumn

protected IntColumn(String name,
 it.unimi.dsi.fastutil.ints.IntArrayList data)

Method Details

create

public static IntColumn create(String name)

create

public static IntColumn create(String name,
 int... arr)

create

public static IntColumn create(String name,
 Integer[] arr)

create

public static IntColumn create(String name,
 int initialSize)

create

public static IntColumn create(String name,
 IntStream stream)

createCol

public IntColumn createCol(String name,
 int initialSize)

Specified by:

createCol in class NumberColumn<IntColumn,Integer>

createCol

public IntColumn createCol(String name)

Specified by:

createCol in class NumberColumn<IntColumn,Integer>

indexColumn

public static IntColumn 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

size

public int size()

Returns the number of elements in this column, including missing values

Specified by:

size in interface Column<Integer>

Specified by:

size in interface NumberFilters

Specified by:

size in interface NumberMapFunctions

valueHash

public int valueHash(int rowNumber)

Returns an int suitable as a hash for the value in this column at the given index

Specified by:

valueHash in interface Column<Integer>

equals

public boolean equals(int rowNumber1,
 int rowNumber2)

Returns true if the value in this column at rowNumber1 is equal to the value at rowNumber2

Specified by:

equals in interface Column<Integer>

clear

public void clear()

Removes all elements TODO: Make this return this column

Specified by:

clear in interface Column<Integer>

valueIsMissing

public static boolean valueIsMissing(int value)

get

public Integer get(int index)

Returns the value at the given zero-based index

Specified by:

get in interface Column<Integer>

asIntArray

public int[] asIntArray()

subset

public IntColumn subset(int[] rows)

Return a column of the same type containing just those elements whose indexes are included in the given array

Specified by:

subset in interface Column<Integer>

Overrides:

subset in class AbstractColumn<IntColumn,Integer>

unique

public IntColumn unique()

Returns a column of the same type containing only the unique values

Specified by:

unique in interface Column<Integer>

Returns:

a Column

top

public IntColumn top(int n)

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

Specified by:

top in class NumberColumn<IntColumn,Integer>

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 IntColumn bottom(int n)

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

Specified by:

bottom in class NumberColumn<IntColumn,Integer>

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

lag

public IntColumn lag(int n)

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 Column<Integer>

Specified by:

lag in interface NumericColumn<Integer>

removeMissing

public IntColumn removeMissing()

Returns a copy of this column with the missing values removed

Specified by:

removeMissing in interface Column<Integer>

append

public IntColumn append(int i)

append

public IntColumn append(Integer val)

Appends value to the bottom of this column and return this column

Specified by:

append in interface Column<Integer>

copy

public IntColumn copy()

Returns a deep copy of the receiver

Specified by:

copy in interface Column<Integer>

Specified by:

copy in interface NumericColumn<Integer>

Returns:

a Column

iterator

public Iterator<Integer> iterator()

Specified by:

iterator in interface Iterable<Integer>

intIterator

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

asObjectArray

public Integer[] asObjectArray()

Returns an array of objects as appropriate for my type of column

Specified by:

asObjectArray in interface Column<Integer>

compare

public int compare(Integer o1,
 Integer o2)

Specified by:

compare in interface Comparator<Integer>

set

public IntColumn set(int i,
 Integer val)

Sets the value at index row to the given value and return this column

Specified by:

set in interface Column<Integer>

set

public IntColumn set(int i,
 int val)

append

public IntColumn append(Column<Integer> column)

Appends all the values in the argument to the bottom of this column and return this column

Specified by:

append in interface Column<Integer>

append

public IntColumn append(Column<Integer> column,
 int row)

Appends the value at the given row in the given column to the bottom of this column and return this column

Specified by:

append in interface Column<Integer>

set

public IntColumn set(int row,
 Column<Integer> column,
 int sourceRow)

Sets the value at row to the value at sourceRow in the given column and return this column

Specified by:

set in interface Column<Integer>

set

public Column<Integer> set(int row,
 String stringValue,
 AbstractColumnParser<?> parser)

Sets the value at row to the parsed value of the given String using the given parser and returns this column

Specified by:

set in interface Column<Integer>

appendMissing

public IntColumn appendMissing()

Appends a missing value appropriate to the column

Specified by:

appendMissing in interface Column<Integer>

asBytes

public byte[] asBytes(int rowNumber)

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

Specified by:

asBytes in interface Column<Integer>

Parameters:

rowNumber - index of the row

Returns:

content as byte[]

getString

public String getString(int row)

Returns a string representation of the value at the given row.

Specified by:

getString in interface Column<Integer>

Overrides:

getString in class NumberColumn<IntColumn,Integer>

Parameters:

row - The index of the row.

Returns:

value as String

countUnique

public int countUnique()

Returns the count of unique values in this column.

Specified by:

countUnique in interface Column<Integer>

Returns:

unique values as int

getInt

public int getInt(int row)

Returns the value at the given index. The actual value is returned if the ColumnType is INTEGER. Otherwise the value is rounded as described below.

Returns the closest int to the argument, with ties rounding to positive infinity.

Special cases:

• If the argument is NaN, the result is 0.
• If the argument is positive infinity or any value greater than or equal to the value of Integer.MAX_VALUE, an error will be thrown

Parameters:

row - the index of the value to be rounded to an integer.

Returns:

the value of the argument rounded to the nearest int value.

Throws:

ClassCastException - if the absolute value of the value to be rounded is too large to be cast to an int

getDouble

public double getDouble(int row)

Returns a double representation of the number at index

Specified by:

getDouble in interface NumberFilters

Specified by:

getDouble in interface NumberMapFunctions

Specified by:

getDouble in interface NumericColumn<Integer>

isMissingValue

public boolean isMissingValue(int value)

isMissing

public boolean isMissing(int rowNumber)

Returns true if the value at rowNumber is missing

Specified by:

isMissing in interface Column<Integer>

Specified by:

isMissing in interface NumberMapFunctions

sortAscending

public void sortAscending()

Sorts my values in ascending order

Specified by:

sortAscending in interface Column<Integer>

sortDescending

public void sortDescending()

Sorts my values in descending order

Specified by:

sortDescending in interface Column<Integer>

appendObj

public IntColumn appendObj(Object obj)

Appends the given value to the bottom of this column and return this column

Specified by:

appendObj in interface Column<Integer>

appendCell

public IntColumn appendCell(String value)

Add one element to the bottom of this column and set its value to the parsed value of the given String. Parsing is type-specific

Specified by:

appendCell in interface Column<Integer>

appendCell

public IntColumn appendCell(String value,
 AbstractColumnParser<?> parser)

Add one element to the bottom of this column and set its value to the parsed value of the given String, as performed by the given parser

Specified by:

appendCell in interface Column<Integer>

getUnformattedString

public String getUnformattedString(int row)

Returns a String representation of the value at index r, without any formatting applied

Specified by:

getUnformattedString in interface Column<Integer>

asLongColumn

public LongColumn asLongColumn()

Returns a new LongColumn containing a value for each value in this column

A widening primitive conversion from int to long does not lose any information at all; the numeric value is preserved exactly.

A missing value in the receiver is converted to a missing value in the result

Specified by:

asLongColumn in interface NumericColumn<Integer>

asFloatColumn

public FloatColumn asFloatColumn()

Returns a new FloatColumn containing a value for each value in this column, truncating if necessary.

A widening primitive conversion from an int to a float does not lose information about the overall magnitude of a numeric value. It may, however, result in loss of precision - that is, the result may lose some of the least significant bits of the value. In this case, the resulting floating-point value will be a correctly rounded version of the integer value, using IEEE 754 round-to-nearest mode.

Despite the fact that a loss of precision may occur, a widening primitive conversion never results in a run-time exception.

A missing value in the receiver is converted to a missing value in the result

Specified by:

asFloatColumn in interface NumericColumn<Integer>

isIn

public Selection isIn(int... numbers)

isNotIn

public Selection isNotIn(int... numbers)

isNotIn

public Selection isNotIn(IntColumn ints)

asDoubleColumn

public DoubleColumn asDoubleColumn()

Returns a new DoubleColumn containing a value for each value in this column, truncating if necessary.

A widening primitive conversion from an int to a double does not lose information about the overall magnitude of a numeric value. It may, however, result in loss of precision - that is, the result may lose some of the least significant bits of the value. In this case, the resulting floating-point value will be a correctly rounded version of the integer value, using IEEE 754 round-to-nearest mode.

Despite the fact that a loss of precision may occur, a widening primitive conversion never results in a run-time exception.

A missing value in the receiver is converted to a missing value in the result

Specified by:

asDoubleColumn in interface NumericColumn<Integer>

asShortColumn

public ShortColumn asShortColumn()

Returns a new ShortColumn containing a value for each value in this column

A narrowing conversion of a signed integer to an integral type T simply discards all but the n lowest order bits, where n is the number of bits used to represent type T. In addition to a possible loss of information about the magnitude of the numeric value, this may cause the sign of the resulting value to differ from the sign of the input value.

In other words, if the element being converted is larger (or smaller) than Short.MAX_VALUE (or Short.MIN_VALUE) you will not get a conventionally good conversion.

Despite the fact that overflow, underflow, or other loss of information may occur, a narrowing primitive conversion never results in a run-time exception.

A missing value in the receiver is converted to a missing value in the result

Specified by:

asShortColumn in interface NumericColumn<Integer>

setMissing

public IntColumn setMissing(int r)

Sets the value at index i to the missing-value indicator for this column type, and return this column

Specified by:

setMissing in interface Column<Integer>

asSet

public Set<Integer> asSet()

Returns a Set containing all the unique values in this column

Specified by:

asSet in interface Column<Integer>