BooleanColumn (tablesaw-core 0.41.0 API)

java.lang.Object
- tech.tablesaw.columns.AbstractColumn<BooleanColumn,Boolean>
- - tech.tablesaw.api.BooleanColumn

All Implemented Interfaces:

Iterable<Selection>, Comparator<Selection>, CategoricalColumn<Boolean>, BooleanFillers<BooleanColumn>, BooleanFilters, BooleanMapUtils, Column<Selection>, BooleanFilterSpec<Selection>, FilterSpec<Selection>
```
public class BooleanColumn
extends AbstractColumn<BooleanColumn,Boolean>
implements BooleanFilterSpec<Selection>, BooleanMapUtils, CategoricalColumn<Boolean>, BooleanFillers<BooleanColumn>, BooleanFilters
```
A column in a base table that contains float values

Field Summary

Fields
Modifier and Type Field Description

protected it.unimi.dsi.fastutil.bytes.ByteArrayList data
- Fields inherited from class tech.tablesaw.columns.AbstractColumn
  DEFAULT_ARRAY_SIZE

Fields
Modifier and Type	Field	Description
`protected it.unimi.dsi.fastutil.bytes.ByteArrayList`	`data`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`all()`	Returns true if the column contains only true values, and false otherwise.
`boolean`	`any()`	Returns true if the column contains any true values, and false otherwise
`BooleanColumn`	`append(boolean b)`
`BooleanColumn`	`append(byte b)`
`BooleanColumn`	`append(Boolean b)`	Appends value to the bottom of this column and return this column
`BooleanColumn`	`append(Column<Boolean> column)`	Appends all the values in the argument to the bottom of this column and return this column
`Column<Boolean>`	`append(Column<Boolean> column, int row)`	Appends the value at the given row in the given column to the bottom of this column and return this column
`BooleanColumn`	`appendCell(String object)`	Add one element to the bottom of this column and set its value to the parsed value of the given String.
`BooleanColumn`	`appendCell(String object, 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
`BooleanColumn`	`appendMissing()`	Appends a missing value appropriate to the column
`BooleanColumn`	`appendObj(Object obj)`	Appends the given value to the bottom of this column and return this column
`byte[]`	`asBytes(int row)`	Returns the contents of the cell at rowNumber as a byte[].
`double[]`	`asDoubleArray()`
`DoubleColumn`	`asDoubleColumn()`
`Boolean[]`	`asObjectArray()`	Returns an array of objects as appropriate for my type of column
`Selection`	`asSelection()`
`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()`	Removes all elements TODO: Make this return this column
`int`	`compare(Boolean o1, Boolean o2)`
`boolean`	`contains(boolean aBoolean)`
`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(String name)`
`static BooleanColumn`	`create(String name, boolean... values)`
`static BooleanColumn`	`create(String name, int initialSize)`
`static BooleanColumn`	`create(String name, Boolean[] arr)`
`static BooleanColumn`	`create(String name, Collection<Boolean> values)`
`static BooleanColumn`	`create(String name, Stream<Boolean> stream)`
`static BooleanColumn`	`create(String name, Selection hits, int columnSize)`
`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.
`Selection`	`eval(BiPredicate<Boolean,Boolean> predicate, Boolean valueToCompare)`
`Selection`	`eval(Predicate<Boolean> predicate)`
`Selection`	`eval(BytePredicate predicate)`
`BooleanColumn`	`fillWith(it.unimi.dsi.fastutil.booleans.BooleanIterable iterable)`
`BooleanColumn`	`fillWith(it.unimi.dsi.fastutil.booleans.BooleanIterator iterator)`
`BooleanColumn`	`fillWith(Supplier<Boolean> supplier)`
`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)
`double`	`getDouble(int row)`
`BooleanFormatter`	`getPrintFormatter()`
`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
`boolean`	`isEmpty()`	Returns true if the column has no data
`Selection`	`isEqualTo(BooleanColumn other)`
`Selection`	`isFalse()`
`Selection`	`isMissing()`	Returns a selection containing an index for every missing value in this column
`boolean`	`isMissing(int rowNumber)`	Returns true if the value at rowNumber is missing
`Selection`	`isNotMissing()`	Returns a selection containing an index for every non-missing value in this column
`Selection`	`isTrue()`
`Iterator<Boolean>`	`iterator()`
`BooleanColumn`	`lag(int n)`	Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
`BooleanColumn`	`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.
`boolean`	`none()`	Returns true if the column contains no true values, and false otherwise
`double`	`proportionFalse()`	Returns the proportion of non-missing row elements that contain true
`double`	`proportionTrue()`	Returns the proportion of non-missing row elements that contain true
`BooleanColumn`	`removeMissing()`	Returns a copy of this column with the missing values removed
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`	Returns an IntComparator for sorting my rows
`BooleanColumn`	`set(int i, boolean b)`
`BooleanColumn`	`set(int i, Boolean val)`	Sets the value at index row to the given value and return this column
`BooleanColumn`	`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
`Column<Boolean>`	`set(int row, Column<Boolean> column, int sourceRow)`	Sets the value at row to the value at sourceRow in the given column and return this column
`BooleanColumn`	`set(Selection rowSelection, boolean newValue)`	Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
`BooleanColumn`	`setMissing(int i)`	Sets the value at index i to the missing-value indicator for this column type, and return this column
`void`	`setPrintFormatter(BooleanFormatter formatter)`
`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
`Table`	`summary()`	Returns a table containing a ColumnType specific summary of the data in this column
`BooleanColumn`	`unique()`	Returns a column of the same type containing only the unique values
`static boolean`	`valueIsMissing(byte b)`
`BooleanColumn`	`where(Selection selection)`	Returns a new column containing the subset referenced by the `Selection`

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, subset, toString, type

Methods inherited from interface tech.tablesaw.columns.booleans.BooleanMapUtils
and, andNot, or

Methods inherited from interface tech.tablesaw.api.CategoricalColumn
countByCategory

Methods inherited from interface tech.tablesaw.columns.Column
allMatch, anyMatch, asList, asStringColumn, columnWidth, contains, count, count, filter, first, indexOf, inRange, interpolate, last, map, map, mapInto, max, max, min, min, name, noneMatch, parser, print, reduce, reduce, rolling, sampleN, sampleX, set, set, set, setMissingTo, setName, setParser, sorted, subset, title, type

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - data
```
protected it.unimi.dsi.fastutil.bytes.ByteArrayList data
```
- Method Detail
  - valueIsMissing
```
public static boolean valueIsMissing(byte b)
```
  - isMissing
```
public boolean isMissing(int rowNumber)
```
    Description copied from interface: Column
    
    Returns true if the value at rowNumber is missing
    
    Specified by:
    
    isMissing in interface Column<Selection>
  - setMissing
```
public BooleanColumn setMissing(int i)
```
    Description copied from interface: Column
    
    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<Selection>
  - create
```
public static BooleanColumn create(String name,
                                   Selection hits,
                                   int columnSize)
```
  - create
```
public static BooleanColumn create(String name)
```
  - create
```
public static BooleanColumn create(String name,
                                   int initialSize)
```
  - create
```
public static BooleanColumn create(String name,
                                   boolean... values)
```
  - create
```
public static BooleanColumn create(String name,
                                   Collection<Boolean> values)
```
  - create
```
public static BooleanColumn create(String name,
                                   Boolean[] arr)
```
  - create
```
public static BooleanColumn create(String name,
                                   Stream<Boolean> stream)
```
  - setPrintFormatter
```
public void setPrintFormatter(BooleanFormatter formatter)
```
  - getPrintFormatter
```
public BooleanFormatter getPrintFormatter()
```
  - size
```
public int size()
```
    Description copied from interface: Column
    
    Returns the number of elements in this column, including missing values
    
    Specified by:
    
    size in interface Column<Selection>
  - summary
```
public Table summary()
```
    Description copied from interface: Column
    
    Returns a table containing a ColumnType specific summary of the data in this column
    
    Specified by:
    
    summary in interface Column<Selection>
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column<Selection>
    
    Returns:
    
    missing values as int
  - countUnique
```
public int countUnique()
```
    Description copied from interface: Column
    
    Returns the count of unique values in this column.
    
    Specified by:
    
    countUnique in interface Column<Selection>
    
    Returns:
    
    unique values as int
  - unique
```
public BooleanColumn unique()
```
    Description copied from interface: Column
    
    Returns a column of the same type containing only the unique values
    
    Specified by:
    
    unique in interface Column<Selection>
    
    Returns:
    
    a Column
  - append
```
public BooleanColumn append(boolean b)
```
  - append
```
public BooleanColumn append(Boolean b)
```
    Description copied from interface: Column
    
    Appends value to the bottom of this column and return this column
    
    Specified by:
    
    append in interface Column<Selection>
  - appendObj
```
public BooleanColumn appendObj(Object obj)
```
    Description copied from interface: Column
    
    Appends the given value to the bottom of this column and return this column
    
    Specified by:
    
    appendObj in interface Column<Selection>
  - append
```
public BooleanColumn append(byte b)
```
  - appendMissing
```
public BooleanColumn appendMissing()
```
    Description copied from interface: Column
    
    Appends a missing value appropriate to the column
    
    Specified by:
    
    appendMissing in interface Column<Selection>
  - 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<Selection>
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - getUnformattedString
```
public String getUnformattedString(int row)
```
    Description copied from interface: Column
    
    Returns a String representation of the value at index r, without any formatting applied
    
    Specified by:
    
    getUnformattedString in interface Column<Selection>
  - emptyCopy
```
public BooleanColumn emptyCopy()
```
    Description copied from class: AbstractColumn
    
    Returns a copy of the receiver with no data. The column name and type are the same.
    
    Specified by:
    
    emptyCopy in interface Column<Selection>
    
    Specified by:
    
    emptyCopy in class AbstractColumn<BooleanColumn,Boolean>
    
    Returns:
    
    a empty copy of 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<Selection>
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a Column
  - clear
```
public void clear()
```
    Description copied from interface: Column
    
    Removes all elements TODO: Make this return this column
    
    Specified by:
    
    clear in interface Column<Selection>
  - copy
```
public BooleanColumn copy()
```
    Description copied from interface: Column
    
    Returns a deep copy of the receiver
    
    Specified by:
    
    copy in interface Column<Selection>
    
    Returns:
    
    a Column
  - sortAscending
```
public void sortAscending()
```
    Description copied from interface: Column
    
    Sorts my values in ascending order
    
    Specified by:
    
    sortAscending in interface Column<Selection>
  - sortDescending
```
public void sortDescending()
```
    Description copied from interface: Column
    
    Sorts my values in descending order
    
    Specified by:
    
    sortDescending in interface Column<Selection>
  - appendCell
```
public BooleanColumn appendCell(String object)
```
    Description copied from interface: Column
    
    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<Selection>
  - appendCell
```
public BooleanColumn appendCell(String object,
                                AbstractColumnParser<?> parser)
```
    Description copied from interface: Column
    
    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<Selection>
  - get
```
public Boolean get(int i)
```
    Returns the value in row i as a Boolean
    
    Specified by:
    
    get in interface Column<Selection>
    
    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<Selection>
    
    Returns:
    
    true if empty, false if not
  - countTrue
```
public int countTrue()
```
  - countFalse
```
public int countFalse()
```
  - proportionTrue
```
public double proportionTrue()
```
    Returns the proportion of non-missing row elements that contain true
  - proportionFalse
```
public double proportionFalse()
```
    Returns the proportion of non-missing row elements that contain true
  - any
```
public boolean any()
```
    Returns true if the column contains any true values, and false otherwise
  - all
```
public boolean all()
```
    Returns true if the column contains only true values, and false otherwise. If there are any missing values it returns false.
  - none
```
public boolean none()
```
    Returns true if the column contains no true values, and false otherwise
  - isFalse
```
public Selection isFalse()
```
    Specified by:
    
    isFalse in interface BooleanFilters
    
    Specified by:
    
    isFalse in interface BooleanFilterSpec<Selection>
  - isTrue
```
public Selection isTrue()
```
    Specified by:
    
    isTrue in interface BooleanFilters
    
    Specified by:
    
    isTrue in interface BooleanFilterSpec<Selection>
  - isEqualTo
```
public Selection isEqualTo(BooleanColumn other)
```
    Specified by:
    
    isEqualTo in interface BooleanFilters
    
    Specified by:
    
    isEqualTo in interface BooleanFilterSpec<Selection>
  - data
```
public it.unimi.dsi.fastutil.bytes.ByteArrayList data()
```
    Returns a ByteArrayList containing 0 (false), 1 (true) or Byte.MIN_VALUE (missing)
  - set
```
public BooleanColumn set(int i,
                         boolean b)
```
  - set
```
public BooleanColumn set(int i,
                         Boolean val)
```
    Description copied from interface: Column
    
    Sets the value at index row to the given value and return this column
    
    Specified by:
    
    set in interface Column<Selection>
  - set
```
public BooleanColumn set(int row,
                         String stringValue,
                         AbstractColumnParser<?> parser)
```
    Description copied from interface: Column
    
    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<Selection>
  - lead
```
public BooleanColumn 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 Column<Selection>
  - lag
```
public BooleanColumn 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 Column<Selection>
  - set
```
public BooleanColumn set(Selection rowSelection,
                         boolean newValue)
```
    Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
  - getDouble
```
public double getDouble(int row)
```
  - asDoubleArray
```
public double[] asDoubleArray()
```
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Description copied from interface: Column
    
    Returns an IntComparator for sorting my rows
    
    Specified by:
    
    rowComparator in interface Column<Selection>
  - append
```
public BooleanColumn append(Column<Boolean> column)
```
    Description copied from interface: Column
    
    Appends all the values in the argument to the bottom of this column and return this column
    
    Specified by:
    
    append in interface Column<Selection>
  - append
```
public Column<Boolean> append(Column<Boolean> column,
                              int row)
```
    Description copied from interface: Column
    
    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<Selection>
  - set
```
public Column<Boolean> set(int row,
                           Column<Boolean> column,
                           int sourceRow)
```
    Description copied from interface: Column
    
    Sets the value at row to the value at sourceRow in the given column and return this column
    
    Specified by:
    
    set in interface Column<Selection>
  - asSelection
```
public Selection asSelection()
```
    Specified by:
    
    asSelection in interface BooleanMapUtils
  - isMissing
```
public Selection isMissing()
```
    Description copied from interface: Column
    
    Returns a selection containing an index for every missing value in this column
    
    Specified by:
    
    isMissing in interface BooleanFilters
    
    Specified by:
    
    isMissing in interface Column<Selection>
    
    Specified by:
    
    isMissing in interface FilterSpec<Selection>
  - isNotMissing
```
public Selection isNotMissing()
```
    Description copied from interface: Column
    
    Returns a selection containing an index for every non-missing value in this column
    
    Specified by:
    
    isNotMissing in interface BooleanFilters
    
    Specified by:
    
    isNotMissing in interface Column<Selection>
    
    Specified by:
    
    isNotMissing in interface FilterSpec<Selection>
  - iterator
```
public Iterator<Boolean> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Selection>
  - byteIterator
```
public it.unimi.dsi.fastutil.bytes.ByteIterator byteIterator()
```
  - 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<Selection>
    
    Returns:
    
    width in bytes
  - 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<Selection>
    
    Parameters:
    
    row - index of the row
    
    Returns:
    
    content as byte[]
  - where
```
public BooleanColumn where(Selection selection)
```
    Description copied from interface: Column
    
    Returns a new column containing the subset referenced by the Selection
    
    Specified by:
    
    where in interface Column<Selection>
  - removeMissing
```
public BooleanColumn removeMissing()
```
    Description copied from interface: Column
    
    Returns a copy of this column with the missing values removed
    
    Specified by:
    
    removeMissing in interface Column<Selection>
  - eval
```
public Selection eval(BytePredicate predicate)
```
  - eval
```
public Selection eval(Predicate<Boolean> predicate)
```
  - eval
```
public Selection eval(BiPredicate<Boolean,Boolean> predicate,
                      Boolean valueToCompare)
```
  - asDoubleColumn
```
public DoubleColumn asDoubleColumn()
```
  - compare
```
public int compare(Boolean o1,
                   Boolean o2)
```
    Specified by:
    
    compare in interface Comparator<Selection>
  - fillWith
```
public BooleanColumn fillWith(it.unimi.dsi.fastutil.booleans.BooleanIterator iterator)
```
    Specified by:
    
    fillWith in interface BooleanFillers<BooleanColumn>
  - fillWith
```
public BooleanColumn fillWith(it.unimi.dsi.fastutil.booleans.BooleanIterable iterable)
```
    Specified by:
    
    fillWith in interface BooleanFillers<BooleanColumn>
  - fillWith
```
public BooleanColumn fillWith(Supplier<Boolean> supplier)
```
    Specified by:
    
    fillWith in interface BooleanFillers<BooleanColumn>
  - asObjectArray
```
public Boolean[] asObjectArray()
```
    Description copied from interface: Column
    
    Returns an array of objects as appropriate for my type of column
    
    Specified by:
    
    asObjectArray in interface Column<Selection>

Class BooleanColumn

Field Summary

Fields inherited from class tech.tablesaw.columns.AbstractColumn

Method Summary

Methods inherited from class tech.tablesaw.columns.AbstractColumn

Methods inherited from interface tech.tablesaw.columns.booleans.BooleanMapUtils

Methods inherited from interface tech.tablesaw.api.CategoricalColumn

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.util.Comparator

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Field Detail

data

Method Detail

valueIsMissing

isMissing

setMissing

create

create

create

create

create

create

create

setPrintFormatter

getPrintFormatter

size

summary

countMissing

countUnique

unique

append

append

appendObj

append

appendMissing

getString

getUnformattedString

emptyCopy

emptyCopy

clear

copy

sortAscending

sortDescending

appendCell

appendCell

get

getByte

isEmpty

countTrue

countFalse

proportionTrue

proportionFalse

any

all

none

isFalse

isTrue

isEqualTo

data

set

set

set

lead

lag

set

getDouble

asDoubleArray

rowComparator

append

append

set

asSelection

isMissing

isNotMissing

iterator

byteIterator

asSet

contains

byteSize