Bitset: A Bitset Class
In 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.
Public fields
.bitseta pointer to the underlying IterableBitset.
max_sizethe maximum size of the bitset.
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Method new()
create a bitset.
Usage
Bitset$new(size, from = NULL)
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
Bitset$insert(v)
Arguments
van integer vector of elements to insert.
Method remove()
remove from the bitset.
Usage
Bitset$remove(v)
Arguments
van integer vector of elements (not indices) to remove.
Method clear()
clear the bitset.
Usage
Bitset$clear()
Method size()
get the number of elements in the set.
Usage
Bitset$size()
Method or()
to "bitwise or" or union two bitsets.
Usage
Bitset$or(other)
Arguments
otherthe other bitset.
Method and()
to "bitwise and" or intersect two bitsets.
Usage
Bitset$and(other)
Arguments
otherthe other bitset.
Method not()
to "bitwise not" or complement a bitset.
Usage
Bitset$not(inplace)
Arguments
inplacewhether to overwrite the current bitset.
Method xor()
to "bitwise xor" or get the symmetric difference of two bitset
(keep elements in either bitset but not in their intersection).
Usage
Bitset$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
Bitset$set_difference(other)
Arguments
otherthe other bitset.
Method sample()
sample a bitset.
Usage
Bitset$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
Bitset$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 ≤ k ≤ N.
Method copy()
returns a copy the bitset.
Usage
Bitset$copy()
Method to_vector()
return an integer vector of the elements
stored in this bitset.
Usage
Bitset$to_vector()
Method clone()
The objects of this class are cloneable with this method.
Usage
Bitset$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
individual documentation built on July 15, 2022, 5:06 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.
Public fields
.bitseta pointer to the underlying IterableBitset.
max_sizethe maximum size of the bitset.
Methods
Public methods
Method new()
create a bitset.
Usage
Bitset$new(size, from = NULL)
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
Bitset$insert(v)
Arguments
van integer vector of elements to insert.
Method remove()
remove from the bitset.
Usage
Bitset$remove(v)
Arguments
van integer vector of elements (not indices) to remove.
Method clear()
clear the bitset.
Usage
Bitset$clear()
Method size()
get the number of elements in the set.
Usage
Bitset$size()
Method or()
to "bitwise or" or union two bitsets.
Usage
Bitset$or(other)
Arguments
otherthe other bitset.
Method and()
to "bitwise and" or intersect two bitsets.
Usage
Bitset$and(other)
Arguments
otherthe other bitset.
Method not()
to "bitwise not" or complement a bitset.
Usage
Bitset$not(inplace)
Arguments
inplacewhether to overwrite the current bitset.
Method xor()
to "bitwise xor" or get the symmetric difference of two bitset (keep elements in either bitset but not in their intersection).
Usage
Bitset$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
Bitset$set_difference(other)
Arguments
otherthe other bitset.
Method sample()
sample a bitset.
Usage
Bitset$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
Bitset$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 ≤ k ≤ N.
Method copy()
returns a copy the bitset.
Usage
Bitset$copy()
Method to_vector()
return an integer vector of the elements stored in this bitset.
Usage
Bitset$to_vector()
Method clone()
The objects of this class are cloneable with this method.
Usage
Bitset$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
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.