BooleanColumn (tablesaw-core 0.32.4 API)

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

All Implemented Interfaces:

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

Field Summary
- Fields inherited from class tech.tablesaw.columns.AbstractColumn
  DEFAULT_ARRAY_SIZE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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(Boolean b)`
`BooleanColumn`	`append(byte b)`
`BooleanColumn`	`append(Column<Boolean> column)`
`Column<Boolean>`	`append(Column<Boolean> column, int row)`
`BooleanColumn`	`appendCell(String object)`
`BooleanColumn`	`appendCell(String object, AbstractColumnParser<?> parser)`
`BooleanColumn`	`appendMissing()` Appends a missing value appropriate to the column
`BooleanColumn`	`appendObj(Object obj)`
`byte[]`	`asBytes(int row)` Returns the contents of the cell at rowNumber as a byte[].
`double[]`	`asDoubleArray()`
`DoubleColumn`	`asDoubleColumn()`
`Boolean[]`	`asObjectArray()`
`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()`
`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, Boolean[] objects)`
`static BooleanColumn`	`create(String name, int initialSize)`
`static BooleanColumn`	`create(String name, List<Boolean> values)`
`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.
`boolean`	`equals(Object o)`
`Selection`	`eval(BiPredicate<Boolean,Boolean> predicate, Boolean valueToCompare)`
`Selection`	`eval(BytePredicate predicate)`
`Selection`	`eval(Predicate<Boolean> predicate)`
`BooleanColumn`	`fillWith(it.unimi.dsi.fastutil.booleans.BooleanIterable iterable)`
`BooleanColumn`	`fillWith(it.unimi.dsi.fastutil.booleans.BooleanIterator iterator)`
`BooleanColumn`	`fillWith(Supplier<Boolean> supplier)`
`BooleanColumn`	`filter(Predicate<? super Boolean> test)` Returns a new Column of the same type with only those rows satisfying the predicate
`BooleanColumn`	`first(int numRows)`
`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)`
`int`	`hashCode()`
`BooleanColumn`	`inRange(int start, int end)` Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
`boolean`	`isEmpty()` Returns true if the column has no data
`Selection`	`isEqualTo(BooleanColumn other)`
`Selection`	`isFalse()`
`Selection`	`isMissing()`
`boolean`	`isMissing(int rowNumber)`
`Selection`	`isNotMissing()`
`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`	`last(int numRows)`
`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.
`BooleanColumn`	`map(Function<? super Boolean,? extends Boolean> fun)` Maps the function across all rows, appending the results to a new Column of the same type
`BooleanColumn`	`max(Column<Boolean> other)` Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
`BooleanColumn`	`min(Column<Boolean> other)` Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
`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()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`BooleanColumn`	`sampleN(int n)` Returns a column containing a random sample of the values in this column
`BooleanColumn`	`sampleX(double proportion)` Returns a table consisting of randomly selected values from this column.
`BooleanColumn`	`set(int i, boolean b)`
`BooleanColumn`	`set(int i, Boolean val)`
`Column<Boolean>`	`set(int row, Column<Boolean> column, int sourceRow)`
`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`	`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`	`set(Selection condition, Column<Boolean> other)` Updates this column where values matching the selection are replaced with the corresponding value from the given column
`Column<Boolean>`	`setMissing(int i)`
`BooleanColumn`	`setName(String name)` Sets the columns name to the given string
`void`	`setPrintFormatter(BooleanFormatter formatter)`
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`BooleanColumn`	`sorted(Comparator<? super Boolean> comp)` Returns a new Column of the same type sorted according to the provided Comparator
`BooleanColumn`	`subset(int[] rows)`
`Table`	`summary()`
`BooleanColumn`	`unique()` Returns a column of the same type as the receiver, containing only the unique values of the receiver.
`static boolean`	`valueIsMissing(byte b)`
`BooleanColumn`	`where(Selection selection)`

Methods inherited from class tech.tablesaw.columns.AbstractColumn
asStringColumn, name, toString, type

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

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, mapInto, max, min, name, noneMatch, print, reduce, reduce, rolling, title, type

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

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

- Method Detail
  - valueIsMissing
```
public static boolean valueIsMissing(byte b)
```
  - isMissing
```
public boolean isMissing(int rowNumber)
```
    Specified by:
    
    isMissing in interface Column<Boolean>
  - setMissing
```
public Column<Boolean> setMissing(int i)
```
    Specified by:
    
    setMissing in interface Column<Boolean>
  - 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,
                                   List<Boolean> values)
```
  - create
```
public static BooleanColumn create(String name,
                                   Boolean[] objects)
```
  - setName
```
public BooleanColumn setName(String name)
```
    Description copied from interface: Column
    
    Sets the columns name to the given string
    
    Specified by:
    
    setName in interface Column<Boolean>
    
    Overrides:
    
    setName in class AbstractColumn<Boolean>
    
    Parameters:
    
    name - The new name MUST be unique for any table containing this column
    
    Returns:
    
    this Column to allow method chaining
  - subset
```
public BooleanColumn subset(int[] rows)
```
    Specified by:
    
    subset in interface Column<Boolean>
  - set
```
public BooleanColumn set(Selection rowSelection,
                         Boolean newValue)
```
    Description copied from interface: Column
    
    Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
    
    Specified by:
    
    set in interface Column<Boolean>
  - first
```
public BooleanColumn first(int numRows)
```
    Specified by:
    
    first in interface Column<Boolean>
  - last
```
public BooleanColumn last(int numRows)
```
    Specified by:
    
    last in interface Column<Boolean>
  - inRange
```
public BooleanColumn 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<Boolean>
  - sampleN
```
public BooleanColumn sampleN(int n)
```
    Description copied from interface: Column
    
    Returns a column containing a random sample of the values in this column
    
    Specified by:
    
    sampleN in interface Column<Boolean>
    
    Parameters:
    
    n - the number of values to select
    
    Returns:
    
    A column of the same type as the receiver
  - sampleX
```
public BooleanColumn sampleX(double proportion)
```
    Description copied from interface: Column
    
    Returns a table consisting of randomly selected values from this column. The sample size is based on the given proportion of the total number of cells in this column
    
    Specified by:
    
    sampleX in interface Column<Boolean>
    
    Parameters:
    
    proportion - The proportion to go in the sample
  - set
```
public BooleanColumn set(Selection condition,
                         Column<Boolean> other)
```
    Description copied from interface: Column
    
    Updates this column where values matching the selection are replaced with the corresponding value from the given column
    
    Specified by:
    
    set in interface Column<Boolean>
  - min
```
public BooleanColumn min(Column<Boolean> other)
```
    Description copied from interface: Column
    
    Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
    
    Specified by:
    
    min in interface Column<Boolean>
  - max
```
public BooleanColumn max(Column<Boolean> other)
```
    Description copied from interface: Column
    
    Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
    
    Specified by:
    
    max in interface Column<Boolean>
  - map
```
public BooleanColumn map(Function<? super Boolean,? extends Boolean> fun)
```
    Description copied from interface: Column
    
    Maps the function across all rows, appending the results to a new Column of the same type
    
    Specified by:
    
    map in interface Column<Boolean>
    
    Parameters:
    
    fun - function to map
    
    Returns:
    
    the Column with the results
  - sorted
```
public BooleanColumn sorted(Comparator<? super Boolean> comp)
```
    Description copied from interface: Column
    
    Returns a new Column of the same type sorted according to the provided Comparator
    
    Specified by:
    
    sorted in interface Column<Boolean>
    
    Parameters:
    
    comp - the Comparator
    
    Returns:
    
    a sorted Column
  - setPrintFormatter
```
public void setPrintFormatter(BooleanFormatter formatter)
```
  - getPrintFormatter
```
public BooleanFormatter getPrintFormatter()
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface Column<Boolean>
  - summary
```
public Table summary()
```
    Specified by:
    
    summary in interface Column<Boolean>
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column<Boolean>
    
    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<Boolean>
    
    Returns:
    
    unique values as int
  - unique
```
public BooleanColumn 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<Boolean>
    
    Returns:
    
    a Column
  - append
```
public BooleanColumn append(boolean b)
```
  - append
```
public BooleanColumn append(Boolean b)
```
    Specified by:
    
    append in interface Column<Boolean>
  - appendObj
```
public BooleanColumn appendObj(Object obj)
```
    Specified by:
    
    appendObj in interface Column<Boolean>
  - 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<Boolean>
  - 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<Boolean>
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - getUnformattedString
```
public String getUnformattedString(int row)
```
    Specified by:
    
    getUnformattedString in interface Column<Boolean>
  - emptyCopy
```
public BooleanColumn 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<Boolean>
    
    Specified by:
    
    emptyCopy in class AbstractColumn<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<Boolean>
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a Column
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Column<Boolean>
  - copy
```
public BooleanColumn copy()
```
    Description copied from interface: Column
    
    Returns a deep copy of the receiver
    
    Specified by:
    
    copy in interface Column<Boolean>
    
    Returns:
    
    a Column
  - sortAscending
```
public void sortAscending()
```
    Specified by:
    
    sortAscending in interface Column<Boolean>
  - sortDescending
```
public void sortDescending()
```
    Specified by:
    
    sortDescending in interface Column<Boolean>
  - appendCell
```
public BooleanColumn appendCell(String object)
```
    Specified by:
    
    appendCell in interface Column<Boolean>
  - appendCell
```
public BooleanColumn appendCell(String object,
                                AbstractColumnParser<?> parser)
```
    Specified by:
    
    appendCell in interface Column<Boolean>
  - get
```
public Boolean get(int i)
```
    Returns the value in row i as a Boolean
    
    Specified by:
    
    get in interface Column<Boolean>
    
    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<Boolean>
    
    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()
```
  - isTrue
```
public Selection isTrue()
```
  - isEqualTo
```
public Selection isEqualTo(BooleanColumn other)
```
  - 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)
```
    Specified by:
    
    set in interface Column<Boolean>
  - 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<Boolean>
  - 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<Boolean>
  - 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
  - filter
```
public BooleanColumn filter(Predicate<? super Boolean> test)
```
    Description copied from interface: Column
    
    Returns a new Column of the same type with only those rows satisfying the predicate
    
    Specified by:
    
    filter in interface Column<Boolean>
    
    Parameters:
    
    test - the predicate
    
    Returns:
    
    a new Column of the same type with only those rows satisfying the predicate
  - getDouble
```
public double getDouble(int row)
```
  - asDoubleArray
```
public double[] asDoubleArray()
```
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column<Boolean>
  - append
```
public BooleanColumn append(Column<Boolean> column)
```
    Specified by:
    
    append in interface Column<Boolean>
  - append
```
public Column<Boolean> append(Column<Boolean> column,
                              int row)
```
    Specified by:
    
    append in interface Column<Boolean>
  - set
```
public Column<Boolean> set(int row,
                           Column<Boolean> column,
                           int sourceRow)
```
    Specified by:
    
    set in interface Column<Boolean>
  - asSelection
```
public Selection asSelection()
```
    Specified by:
    
    asSelection in interface BooleanMapUtils
  - isMissing
```
public Selection isMissing()
```
    Specified by:
    
    isMissing in interface Column<Boolean>
  - isNotMissing
```
public Selection isNotMissing()
```
    Specified by:
    
    isNotMissing in interface Column<Boolean>
  - iterator
```
public Iterator<Boolean> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Boolean>
  - 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<Boolean>
    
    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<Boolean>
    
    Parameters:
    
    row - index of the row
    
    Returns:
    
    content as byte[]
  - where
```
public BooleanColumn where(Selection selection)
```
    Specified by:
    
    where in interface Column<Boolean>
  - removeMissing
```
public BooleanColumn removeMissing()
```
    Specified by:
    
    removeMissing in interface Column<Boolean>
  - 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<Boolean>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Comparator<Boolean>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - 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()
```
    Specified by:
    
    asObjectArray in interface Column<Boolean>

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 class java.lang.Object

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.lang.Iterable

Methods inherited from interface java.util.Comparator

Method Detail

valueIsMissing

isMissing

setMissing

create

create

create

create

create

create

setName

subset

set

first

last

inRange

sampleN

sampleX

set

min

max

map

sorted

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

lead

lag

set

filter

getDouble

asDoubleArray

rowComparator

append