# Classes and Methods for Fast Memory-Efficient Boolean Selections

## Documentation for package ‘bit’ version 4.0.4

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C E F G I K L M N P Q R S U V X misc

bit-package | bit: Classes and methods for fast memory-efficient boolean selections

## -- A --

all.bit | Summaries of boolean vectors
all.bitwhich | Summaries of boolean vectors
all.booltype | Summaries of boolean vectors
all.ri | Summaries of boolean vectors
all.which | Summaries of boolean vectors
any.bit | Summaries of boolean vectors
any.bitwhich | Summaries of boolean vectors
any.booltype | Summaries of boolean vectors
any.ri | Summaries of boolean vectors
any.which | Summaries of boolean vectors
anyDuplicated.rlepack | Hybrid Index, rle-pack utilities
anyNA.bit | Summaries of boolean vectors
anyNA.bitwhich | Summaries of boolean vectors
anyNA.booltype | Summaries of boolean vectors
anyNA.ri | Summaries of boolean vectors
anyNA.which | Summaries of boolean vectors
as.bit | Coercing to bit
as.bit.bit | Coercing to bit
as.bit.bitwhich | Coercing to bit
as.bit.double | Coercing to bit
as.bit.integer | Coercing to bit
as.bit.logical | Coercing to bit
as.bit.NULL | Coercing to bit
as.bit.ri | Coercing to bit
as.bit.which | Coercing to bit
as.bitwhich | Coercing to bitwhich
as.bitwhich.bit | Coercing to bitwhich
as.bitwhich.bitwhich | Coercing to bitwhich
as.bitwhich.double | Coercing to bitwhich
as.bitwhich.integer | Coercing to bitwhich
as.bitwhich.logical | Coercing to bitwhich
as.bitwhich.NULL | Coercing to bitwhich
as.bitwhich.ri | Coercing to bitwhich
as.bitwhich.which | Coercing to bitwhich
as.booltype | Coerce to booltype (generic)
as.booltype.default | Coerce to booltype (generic)
as.character.bit | Coerce bit to character
as.character.bitwhich | Coerce bitwhich to character
as.double.bit | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.double.bitwhich | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.double.ri | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.integer.bit | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.integer.bitwhich | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.integer.ri | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.logical.bit | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.logical.bitwhich | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.logical.ri | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.logical.which | Coercion from bit, bitwhich, which and ri to logical, integer, double
as.ri | Coerce to ri
as.ri.default | Coerce to ri
as.ri.ri | Coerce to ri
as.which | Coercion to (positive) integer positions
as.which.bit | Coercion to (positive) integer positions
as.which.bitwhich | Coercion to (positive) integer positions
as.which.integer | Coercion to (positive) integer positions
as.which.logical | Coercion to (positive) integer positions
as.which.NULL | Coercion to (positive) integer positions
as.which.numeric | Coercion to (positive) integer positions
as.which.ri | Coercion to (positive) integer positions
as.which.which | Coercion to (positive) integer positions

## -- B --

bbatch | Balanced Batch sizes
bit | Create empty bit vector
bitsort | Low-level sorting: bit sort
bitwhich | Create bitwhich vector (skewed boolean)
bitwhich_representation | Diagnose representation of bitwhich
bit_anyDuplicated | bit unique and duplicated
bit_done | Initializing bit masks
bit_duplicated | bit unique and duplicated
bit_in | bit %in%
bit_init | Initializing bit masks
bit_intersect | bit set operations
bit_rangediff | bit range difference
bit_setdiff | bit set operations
bit_setequal | bit set operations
bit_setops | bit set operations
bit_sort | bit sort
bit_sort_unique | bit sort unique
bit_sumDuplicated | bit unique and duplicated
bit_symdiff | bit set operations
bit_unidup | bit unique and duplicated
bit_union | bit set operations
bit_unique | bit unique and duplicated
booltype | Diagnosing boolean types
booltypes | Boolean types

## -- C --

c.bit | Concatenating booltype vectors
c.bitwhich | Concatenating booltype vectors
c.booltype | Concatenating booltype vectors
chunk | Methods for chunked range index
chunk.default | Methods for chunked range index
chunks | Function for chunked range index
clone | Cloning ff and ram objects
clone.default | Cloning ff and ram objects
CoercionToStandard | Coercion from bit, bitwhich, which and ri to logical, integer, double
copy_vector | Copy atomic R vector
countsort | Low-level sorting: counting sort

## -- E --

Extract | Extract or replace part of an boolean vector

## -- F --

firstNA | Position of first NA

## -- G --

getsetattr | Attribute setting by reference
get_length | Get C length of a vector

## -- I --

in.bitwhich | Check existence of integers in table
intisasc | Hybrid Index, C-coded utilities
intisdesc | Hybrid Index, C-coded utilities
intrle | Hybrid Index, C-coded utilities
is.bit | Testing for boolean types
is.bitwhich | Testing for boolean types
is.booltype | Testing for boolean types
is.hi | Testing for boolean types
is.na.bit | Test for NA in bit and bitwhich
is.na.bitwhich | Test for NA in bit and bitwhich
is.ri | Testing for boolean types
is.sorted | Generics related to cache access
is.sorted<- | Generics related to cache access
is.which | Testing for boolean types

## -- K --

keyorder | Generics for in-RAM sorting and ordering
keysort | Generics for in-RAM sorting and ordering
keysortorder | Generics for in-RAM sorting and ordering

## -- L --

length.bit | Getting and setting length of bit, bitwhich and ri objects
length.bitwhich | Getting and setting length of bit, bitwhich and ri objects
length.ri | Getting and setting length of bit, bitwhich and ri objects
length<-.bit | Getting and setting length of bit, bitwhich and ri objects
length<-.bitwhich | Getting and setting length of bit, bitwhich and ri objects

## -- M --

max.bit | Summaries of boolean vectors
max.bitwhich | Summaries of boolean vectors
max.booltype | Summaries of boolean vectors
max.ri | Summaries of boolean vectors
max.which | Summaries of boolean vectors
maxindex | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
maxindex.bit | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
maxindex.bitwhich | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
maxindex.default | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
maxindex.logical | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
maxindex.ri | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
maxindex.which | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
mergeorder | Generics for in-RAM sorting and ordering
mergesort | Generics for in-RAM sorting and ordering
mergesortorder | Generics for in-RAM sorting and ordering
merge_anyDuplicated | Fast functions for sorted sets of integer
merge_duplicated | Fast functions for sorted sets of integer
merge_first | Fast functions for sorted sets of integer
merge_firstin | Fast functions for sorted sets of integer
merge_firstnotin | Fast functions for sorted sets of integer
merge_in | Fast functions for sorted sets of integer
merge_intersect | Fast functions for sorted sets of integer
merge_last | Fast functions for sorted sets of integer
merge_lastin | Fast functions for sorted sets of integer
merge_lastnotin | Fast functions for sorted sets of integer
merge_match | Fast functions for sorted sets of integer
merge_notin | Fast functions for sorted sets of integer
merge_rangediff | Fast functions for sorted sets of integer
merge_rangein | Fast functions for sorted sets of integer
merge_rangenotin | Fast functions for sorted sets of integer
merge_rangesect | Fast functions for sorted sets of integer
merge_rev | Fast functions for sorted sets of integer
merge_setdiff | Fast functions for sorted sets of integer
merge_setequal | Fast functions for sorted sets of integer
merge_sumDuplicated | Fast functions for sorted sets of integer
merge_symdiff | Fast functions for sorted sets of integer
merge_union | Fast functions for sorted sets of integer
merge_unique | Fast functions for sorted sets of integer
Metadata | Generics related to cache access
min.bit | Summaries of boolean vectors
min.bitwhich | Summaries of boolean vectors
min.booltype | Summaries of boolean vectors
min.ri | Summaries of boolean vectors
min.which | Summaries of boolean vectors

## -- N --

na.count | Generics related to cache access
na.count<- | Generics related to cache access
nties | Generics related to cache access
nties<- | Generics related to cache access
nunique | Generics related to cache access
nunique<- | Generics related to cache access
nvalid | Generics related to cache access

## -- P --

physical | Physical and virtual attributes
physical.default | Physical and virtual attributes
physical<- | Physical and virtual attributes
physical<-.default | Physical and virtual attributes
PhysVirt | Physical and virtual attributes
poslength | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
poslength.bit | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
poslength.bitwhich | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
poslength.default | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
poslength.logical | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
poslength.ri | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
poslength.which | Get maxindex (length of boolean vector) and poslength (number of 'selected' elements)
print.bit | Print method for bit
print.bitwhich | Print method for bitwhich
print.physical | Physical and virtual attributes
print.ri | Range index
print.virtual | Physical and virtual attributes

## -- Q --

quickorder | Generics for in-RAM sorting and ordering
quicksort | Generics for in-RAM sorting and ordering
quicksort2 | Low-level sorting: binary quicksort
quicksort3 | Low-level sorting: threeway quicksort
quicksortorder | Generics for in-RAM sorting and ordering

## -- R --

radixorder | Generics for in-RAM sorting and ordering
radixsort | Generics for in-RAM sorting and ordering
radixsortorder | Generics for in-RAM sorting and ordering
ramorder | Generics for in-RAM sorting and ordering
ramsort | Generics for in-RAM sorting and ordering
ramsortorder | Generics for in-RAM sorting and ordering
range.bit | Summaries of boolean vectors
range.bitwhich | Summaries of boolean vectors
range.booltype | Summaries of boolean vectors
range.ri | Summaries of boolean vectors
range.which | Summaries of boolean vectors
range_na | Get range and number of NAs
range_nanozero | Remove zeros and get range and number of NAs
range_sortna | Prepare for sorting and get range, number of NAs and unsortedness
rep.bit | Replicating bit and bitwhich vectors
rep.bitwhich | Replicating bit and bitwhich vectors
rep.booltype | Replicating bit and bitwhich vectors
repeat.time | Adaptive timer
repfromto | Virtual recycling
repfromto<- | Virtual recycling
rev.bit | Reversing bit and bitwhich vectors
rev.bitwhich | Reversing bit and bitwhich vectors
rev.booltype | Reversing bit and bitwhich vectors
rev.rlepack | Hybrid Index, rle-pack utilities
reverse_vector | Reverse atomic vector
ri | Range index
rlepack | Hybrid Index, rle-pack utilities
rlepack.integer | Hybrid Index, rle-pack utilities
rleunpack | Hybrid Index, rle-pack utilities
rleunpack.rlepack | Hybrid Index, rle-pack utilities

## -- S --

setattr | Attribute setting by reference
setattributes | Attribute setting by reference
shellorder | Generics for in-RAM sorting and ordering
shellsort | Generics for in-RAM sorting and ordering
shellsortorder | Generics for in-RAM sorting and ordering
Sorting | Generics for in-RAM sorting and ordering
still.identical | Test for C-level identity of two atomic vectors
str.bit | Str method for bit
str.bitwhich | Str method for bitwhich
sum.bit | Summaries of boolean vectors
sum.bitwhich | Summaries of boolean vectors
sum.booltype | Summaries of boolean vectors
sum.ri | Summaries of boolean vectors
sum.which | Summaries of boolean vectors
Summaries | Summaries of boolean vectors
summary.bit | Summaries of boolean vectors
summary.bitwhich | Summaries of boolean vectors
summary.booltype | Summaries of boolean vectors
summary.ri | Summaries of boolean vectors
summary.which | Summaries of boolean vectors
symdiff | Symmetric set complement

## -- U --

unattr | Attribute removal
unique.rlepack | Hybrid Index, rle-pack utilities

## -- V --

vecseq | Vectorized Sequences
virtual | Physical and virtual attributes
virtual.default | Physical and virtual attributes
virtual<- | Physical and virtual attributes
virtual<-.default | Physical and virtual attributes

## -- X --

xor | Boolean operators and functions
xor.bit | Boolean operators and functions
xor.bitwhich | Boolean operators and functions
xor.booltype | Boolean operators and functions
xor.default | Boolean operators and functions
xor.logical | Boolean operators and functions

## -- misc --

!.bit | Boolean operators and functions
!.bitwhich | Boolean operators and functions
!=.bit | Boolean operators and functions
!=.bitwhich | Boolean operators and functions
!=.booltype | Boolean operators and functions
&.bit | Boolean operators and functions
&.bitwhich | Boolean operators and functions
&.booltype | Boolean operators and functions
.BITS | Initializing bit masks
==.bit | Boolean operators and functions
==.bitwhich | Boolean operators and functions
==.booltype | Boolean operators and functions
[.bit | Extract or replace part of an boolean vector
[.bitwhich | Extract or replace part of an boolean vector
[<-.bit | Extract or replace part of an boolean vector
[<-.bitwhich | Extract or replace part of an boolean vector
[[.bit | Extract or replace part of an boolean vector
[[.bitwhich | Extract or replace part of an boolean vector
[[<-.bit | Extract or replace part of an boolean vector
[[<-.bitwhich | Extract or replace part of an boolean vector
|.bit | Boolean operators and functions
|.bitwhich | Boolean operators and functions
|.booltype | Boolean operators and functions