A bitmap ref is a variable that may temporarily reference another bitmap. These are useful for manipulating specific bitmaps within bitmap arrays or bitmap hashes. All bitmap operations except for veil_init_bitmap(text, text) may take the name of a bitmap ref instead of a bitmap.
Bitmap refs may not be shared, and the reference is only accessible within the transaction that created it. These restrictions exist to eliminate the possibility of references to deleted objects or to objects from other sessions.
The following functions comprise the Veil bitmaps API:
veil_init_bitmap(text, text)
veil_clear_bitmap(text)
veil_bitmap_setbit(text, int4)
veil_bitmap_clearbit(text, int4)
veil_bitmap_testbit(text, int4)
veil_bitmap_union(text, int4)
veil_bitmap_intersect(text, int4)
veil_bitmap_bits(text)
veil_bitmap_range(text)
function veil_init_bitmap(text, text) returns bool
function veil_clear_bitmap(text) returns bool
function veil_bitmap_setbit(text, int4) returns bool
function veil_bitmap_clearbit(text, int4) returns bool
function veil_bitmap_testbit(text, int4) returns bool
function veil_bitmap_union(text, text) returns bool
function veil_bitmap_intersect(text, text) returns bool
function veil_bitmap_bits(text) returns setof int4
function veil_bitmap_range(text) returns veil_range_t
Next: Bitmap Arrays