BooleanColumn (tablesaw-core 0.24.10 API)

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

All Implemented Interfaces:: Iterable<Boolean>, CategoricalColumn, BooleanFillers<BooleanColumn>, BooleanMapUtils, Column

public class BooleanColumn
extends AbstractColumn<Boolean,BooleanColumn>
implements BooleanMapUtils, CategoricalColumn, BooleanFillers<BooleanColumn>, Iterable<Boolean>

A column in a base table that contains float values

Field Summary

Fields
Modifier and Type Field Description

static byte BYTE_FALSE

static byte BYTE_TRUE

static byte MISSING_VALUE
- Fields inherited from class tech.tablesaw.columns.AbstractColumn
  DEFAULT_ARRAY_SIZE

Fields
Modifier and Type	Field	Description
`static byte`	`BYTE_FALSE`
`static byte`	`BYTE_TRUE`
`static byte`	`MISSING_VALUE`

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)`
`void`	`append(Column column)`
`BooleanColumn`	`appendCell(String object)`
`BooleanColumn`	`appendCell(String object, StringParser parser)`
`BooleanColumn`	`appendMissing()`	Appends a missing value appropriate to the column
`byte[]`	`asBytes(int row)`	Returns the contents of the cell at rowNumber as a byte[].
`double[]`	`asDoubleArray()`
`int[]`	`asIntArray()`
`NumberColumn`	`asNumberColumn()`
`Object[]`	`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()`
`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[] objects)`
`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(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)`	Returns a double representation of the value at the given row.
`Boolean`	`getObject(int index)`
`BooleanFormatter`	`getPrintFormatter()`
`String`	`getString(int row)`	Returns a string representation of the value at the given row.
`String`	`getUnformattedString(int row)`
`int`	`hashCode()`
`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`	`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()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`BooleanColumn`	`set(int i, boolean b)`
`BooleanColumn`	`set(int i, Boolean val)`
`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
`void`	`setPrintFormatter(BooleanFormatter formatter)`
`int`	`size()`
`void`	`sortAscending()`
`void`	`sortDescending()`
`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
columnWidth, doWithEach, fillMissing, fillMissing, name, print, setName, toString, type

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

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

Methods inherited from interface tech.tablesaw.columns.Column
columnWidth, create, first, inRange, last, name, print, rolling, rows, sampleN, sampleX, setName, subset, title, type

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

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

- Field Detail
  - MISSING_VALUE
```
public static final byte MISSING_VALUE
```
  - BYTE_TRUE
```
public static final byte BYTE_TRUE
```
    See Also:
    
    Constant Field Values
  - BYTE_FALSE
```
public static final byte BYTE_FALSE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - valueIsMissing
```
public static boolean valueIsMissing(byte b)
```
  - isMissing
```
public boolean isMissing(int rowNumber)
```
    Specified by:
    
    isMissing in interface Column
  - 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)
```
  - setPrintFormatter
```
public void setPrintFormatter(BooleanFormatter formatter)
```
  - getPrintFormatter
```
public BooleanFormatter getPrintFormatter()
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface Column
  - summary
```
public Table summary()
```
    Specified by:
    
    summary in interface Column
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column
    
    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
    
    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
    
    Returns:
    
    a Column
  - append
```
public BooleanColumn append(boolean b)
```
  - append
```
public BooleanColumn append(Boolean b)
```
    Specified by:
    
    append in class AbstractColumn<Boolean,BooleanColumn>
  - 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
  - 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
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - getUnformattedString
```
public String getUnformattedString(int row)
```
    Specified by:
    
    getUnformattedString in interface Column
  - 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
    
    Specified by:
    
    emptyCopy in class AbstractColumn<Boolean,BooleanColumn>
    
    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
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a Column
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Column
  - copy
```
public BooleanColumn copy()
```
    Description copied from interface: Column
    
    Returns a deep copy of the receiver
    
    Specified by:
    
    copy in interface Column
    
    Returns:
    
    a Column
  - sortAscending
```
public void sortAscending()
```
    Specified by:
    
    sortAscending in interface Column
  - sortDescending
```
public void sortDescending()
```
    Specified by:
    
    sortDescending in interface Column
  - appendCell
```
public BooleanColumn appendCell(String object)
```
    Specified by:
    
    appendCell in interface Column
  - appendCell
```
public BooleanColumn appendCell(String object,
                                StringParser parser)
```
    Specified by:
    
    appendCell in interface Column
  - get
```
public Boolean get(int i)
```
    Returns the value in row i as a 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
    
    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 class AbstractColumn<Boolean,BooleanColumn>
  - 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
  - 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
  - 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)
```
    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 Column
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - asDoubleArray
```
public double[] asDoubleArray()
```
    Specified by:
    
    asDoubleArray in interface Column
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column
  - append
```
public void append(Column column)
```
    Specified by:
    
    append in interface Column
  - asSelection
```
public Selection asSelection()
```
    Specified by:
    
    asSelection in interface BooleanMapUtils
  - isMissing
```
public Selection isMissing()
```
    Specified by:
    
    isMissing in interface Column
  - isNotMissing
```
public Selection isNotMissing()
```
    Specified by:
    
    isNotMissing in interface Column
  - 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
    
    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
    
    Parameters:
    
    row - index of the row
    
    Returns:
    
    content as byte[]
  - where
```
public BooleanColumn where(Selection selection)
```
    Specified by:
    
    where in interface Column
  - removeMissing
```
public BooleanColumn removeMissing()
```
    Specified by:
    
    removeMissing in interface Column
  - eval
```
public Selection eval(BytePredicate predicate)
```
  - eval
```
public Selection eval(Predicate<Boolean> predicate)
```
  - eval
```
public Selection eval(BiPredicate<Boolean,Boolean> predicate,
                      Boolean valueToCompare)
```
  - asIntArray
```
public int[] asIntArray()
```
    Specified by:
    
    asIntArray in interface CategoricalColumn
  - asNumberColumn
```
public NumberColumn asNumberColumn()
```
  - equals
```
public boolean equals(Object o)
```
    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 Object[] asObjectArray()
```
    Specified by:
    
    asObjectArray in interface Column
  - getObject
```
public Boolean getObject(int index)
```
    Specified by:
    
    getObject in interface Column
    
    Specified by:
    
    getObject in class AbstractColumn<Boolean,BooleanColumn>

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

Methods inherited from class java.lang.Object

Field Detail

MISSING_VALUE

BYTE_TRUE

BYTE_FALSE

Method Detail

valueIsMissing

isMissing

create

create

create

create

create

create

setPrintFormatter

getPrintFormatter

size

summary

countMissing

countUnique

unique

append

append

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

getDouble

asDoubleArray

rowComparator

append

asSelection

isMissing

isNotMissing

iterator

byteIterator

asSet

contains

byteSize

asBytes

where

removeMissing

eval

eval