Bitset: A Bitset Class
In mrc-ide/individual: Framework for Specifying and Simulating Individual Based Models
Bitset R Documentation
A Bitset Class
Description
This is a data structure that compactly stores the presence of
integers in some finite set (max_size), and can
efficiently perform set operations (union, intersection, complement, symmetric
difference, set difference).
WARNING: All operations are in-place so please use $copy
if you would like to perform an operation without destroying your current bitset.
This class is defined as a named list for performance reasons, but for most
intents and purposes it behaves just like an R6 class.
Methods
Method new()
create a bitset.
Usage
Bitset$new(size, from)
Arguments
sizethe size of the bitset.
frompointer to an existing IterableBitset to use; if NULL
make empty bitset, otherwise copy existing bitset.
Method insert()
insert into the bitset.
Usage
b$insert(v)
Arguments
van integer vector of elements to insert.
Method remove()
remove from the bitset.
Usage
b$remove(v)
Arguments
van integer vector of elements (not indices) to remove.
Method clear()
clear the bitset.
Usage
b$clear()
Method size()
get the number of elements in the set.
Usage
b$size()
Method or()
to "bitwise or" or union two bitsets.
Usage
b$or(other)
Arguments
otherthe other bitset.
Method and()
to "bitwise and" or intersect two bitsets.
Usage
b$and(other)
Arguments
otherthe other bitset.
Method not()
to "bitwise not" or complement a bitset.
Usage
b$not(inplace)
Arguments
inplacewhether to overwrite the current bitset, default = TRUE
Method xor()
to "bitwise xor" get the symmetric difference of two bitset
(keep elements in either bitset but not in their intersection).
Usage
b$xor(other)
Arguments
otherthe other bitset.
Method set_difference()
Take the set difference of this bitset with another
(keep elements of this bitset which are not in other)
Usage
b$set_difference(other)
Arguments
otherthe other bitset.
Method sample()
sample a bitset.
Usage
b$sample(rate)
Arguments
ratethe success probability for keeping each element, can be
a single value for all elements or a vector of unique
probabilities for keeping each element.
Method choose()
choose k random items in the bitset.
Usage
b$choose(k)
Arguments
kthe number of items in the bitset to keep. The selection of
these k items from N total items in the bitset is random, and
k should be chosen such that 0 \le k \le N.
Method copy()
returns a copy of the bitset.
In cases where a destination bitset already exists, it may be more
performant to use the copy_from method instead.
Usage
b$copy()
Method copy_from()
overwrite the value of the bitset from another bitset.
This is similar to calling other$copy(), but can be more
efficient by reusing the resources of the existing bitset.
Usage
b$copy_from(other)
Arguments
otherthe other bitset.
Method to_vector()
return an integer vector of the elements stored in this bitset.
Usage
b$to_vector()
mrc-ide/individual documentation built on Aug. 17, 2024, 2:10 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Bitset | R Documentation |
A Bitset Class
Description
This is a data structure that compactly stores the presence of
integers in some finite set (max_size), and can
efficiently perform set operations (union, intersection, complement, symmetric
difference, set difference).
WARNING: All operations are in-place so please use $copy
if you would like to perform an operation without destroying your current bitset.
This class is defined as a named list for performance reasons, but for most intents and purposes it behaves just like an R6 class.
Methods
Method new()
create a bitset.
Usage
Bitset$new(size, from)
Arguments
sizethe size of the bitset.
frompointer to an existing IterableBitset to use; if
NULLmake empty bitset, otherwise copy existing bitset.
Method insert()
insert into the bitset.
Usage
b$insert(v)
Arguments
van integer vector of elements to insert.
Method remove()
remove from the bitset.
Usage
b$remove(v)
Arguments
van integer vector of elements (not indices) to remove.
Method clear()
clear the bitset.
Usage
b$clear()
Method size()
get the number of elements in the set.
Usage
b$size()
Method or()
to "bitwise or" or union two bitsets.
Usage
b$or(other)
Arguments
otherthe other bitset.
Method and()
to "bitwise and" or intersect two bitsets.
Usage
b$and(other)
Arguments
otherthe other bitset.
Method not()
to "bitwise not" or complement a bitset.
Usage
b$not(inplace)
Arguments
inplacewhether to overwrite the current bitset, default = TRUE
Method xor()
to "bitwise xor" get the symmetric difference of two bitset (keep elements in either bitset but not in their intersection).
Usage
b$xor(other)
Arguments
otherthe other bitset.
Method set_difference()
Take the set difference of this bitset with another
(keep elements of this bitset which are not in other)
Usage
b$set_difference(other)
Arguments
otherthe other bitset.
Method sample()
sample a bitset.
Usage
b$sample(rate)
Arguments
ratethe success probability for keeping each element, can be a single value for all elements or a vector of unique probabilities for keeping each element.
Method choose()
choose k random items in the bitset.
Usage
b$choose(k)
Arguments
kthe number of items in the bitset to keep. The selection of these k items from N total items in the bitset is random, and k should be chosen such that
0 \le k \le N.
Method copy()
returns a copy of the bitset.
In cases where a destination bitset already exists, it may be more
performant to use the copy_from method instead.
Usage
b$copy()
Method copy_from()
overwrite the value of the bitset from another bitset.
This is similar to calling other$copy(), but can be more
efficient by reusing the resources of the existing bitset.
Usage
b$copy_from(other)
Arguments
otherthe other bitset.
Method to_vector()
return an integer vector of the elements stored in this bitset.
Usage
b$to_vector()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.