Documentation
containers.data lib
CCBV
Module
BREAKING CHANGES since 1.2: size is now stored along with the bitvector. Some functions have a new signature.
The size of the bitvector used to be rounded up to the multiple of 30 or 62. In other words some functions such as iter
val create : size :int -> bool -> t Create a bitvector of given size, with given default value.
Number of bits set to one, seen as a set of bits.
Size of underlying bitvector. This is not related to the underlying implementation. Changed at 1.2
The number of bits this bitvector can store without resizing.
val resize : t -> int -> unitResize the BV so that it has the specified length. This can grow or shrink the underlying bitvector.
val set : t -> int -> unitSet i-th bit, extending the bitvector if needed.
val get : t -> int -> boolIs the i-th bit true? Returns false if the index is too high.
val reset : t -> int -> unitSet i-th bit to 0, extending the bitvector if needed.
val flip : t -> int -> unitFlip i-th bit, extending the bitvector if needed.
val iter : t -> (int -> bool -> unit) -> val iter_true : t -> (int -> unit) -> Iterate on bits set to 1.
val to_list : t -> int list List of indexes that are true.
val to_sorted_list : t -> int list Same as to_list
val of_list : int list -> t From a list of true bits.
The bits are interpreted as indices into the returned bitvector, so the final bitvector will have length t equal to 1 more than max of list indices.
val first : t -> int option First set bit, or return None. changed type at 1.2
val filter : t -> (int -> bool) -> filter bv p only keeps the true bits of bv whose index satisfies p index.
val negate_self : t -> negate_self t flips all of the bits in t.
negate t returns a copy of t with all of the bits flipped.
val union_into : into :t -> t -> union_into ~into bv sets into to the union of itself and bv. Also updates the length of into to be at least length bv.
val inter_into : into :t -> t -> inter_into ~into bv sets into to the intersection of itself and bv. Also updates the length of into to be at most length bv.
union bv1 bv2 returns the union of the two sets.
inter bv1 bv2 returns the intersection of the two sets.
val diff_into : into :t -> t -> diff_into ~into t modifies into with only the bits set but not in t.
diff t1 t2 returns those bits found in t1 but not in t2.
val select : t -> 'a array-> 'a listselect arr bv selects the elements of arr whose index corresponds to a true bit in bv. If bv is too short, elements of arr with too high an index cannot be selected and are therefore not selected.
val selecti : t -> 'a array-> ('a * int) listSame as select
type 'a sequence = ('a -> -> Print the bitvector as a string of bits.