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 would iterate on more bits than what was originally asked for. This is not the case anymore.
val empty : unit -> tEmpty bitvector
val create : size:int -> bool -> tCreate a bitvector of given size, with given default value
val cardinal : t -> intNumber of bits set to one, seen as a set of bits.
val length : t -> intSize of underlying bitvector. This is not related to the underlying implementation. Changed at 1.2
val capacity : t -> intThe 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 is_empty : t -> boolAre there any true bits?
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 clear : t -> unitSet every bit to 0
val iter : t -> (int -> bool -> unit) -> unitIterate on all bits
val iter_true : t -> (int -> unit) -> unitIterate on bits set to 1
val to_list : t -> int listList of indexes that are true
val to_sorted_list : t -> int listSame as to_list, but also guarantees the list is sorted in increasing order
val of_list : int list -> tFrom 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 optionFirst set bit, or return None. changed type at 1.2
val first_exn : t -> intFirst set bit, or
val filter : t -> (int -> bool) -> unitfilter bv p only keeps the true bits of bv whose index satisfies p index
val negate_self : t -> unitnegate_self t flips all of the bits in t.
union ~into bv sets into to the union of itself and bv.
Also updates the length of into to be at least length bv.
inter ~into bv sets into to the intersection of itself and bv
Also updates the length of into to be at most length bv.
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, but selected elements are paired with their index
val print : Format.formatter -> t -> unitPrint the bitvector as a string of bits