Bitmap Hashes

A bitmap hashes is a hash table of identically-ranged bitmaps, indexed by a text key.

Typically bitmap hashes are used for sparse collections of privileges.

Note that bitmap hashes may not be stored in shared variables as hashes in shared memory are insufficiently dynamic.

The following functions comprise the Veil bitmap hashes API:

veil_init_bitmap_hash(text, text)

function veil_init_bitmap_hash(text, text) returns bool
Creates, or resets the ranges of, a bitmap hash.

veil_clear_bitmap_hash(text)

function veil_clear_bitmap_hash(text) returns bool
Clear all bits in a bitmap hash.

veil_bitmap_from_hash(text, text, text)

function veil_bitmap_from_hash(text, text, text) returns text
Generate a reference to a specific bitmap in a bitmap hash.

veil_bitmap_hash_testbit(text, text, int4)

function veil_bitmap_hash_testbit(text, text, int4) returns bool
Test a specific bit in a bitmap hash.

veil_bitmap_hash_setbit(text, text, int4)

function veil_bitmap_hash_setbit(text, text, int4) returns bool
Set a specific bit in a bitmap hash.

veil_bitmap_hash_clearbit(text, text, int4)

function veil_bitmap_hash_clearbit(text, text, int4) returns bool
Clear a specific bit in a bitmap hash.

veil_union_into_bitmap_hash(text, text, text)

function veil_union_into_bitmap_hash(text, text, text) returns bool
Union a specified bitmap from a hash with a bitmap, with the result in the bitmap hash. This is a faster shortcut for:

veil_bitmap_union(veil_bitmap_from_hash(<bitmap_hash>, <key>), <bitmap>) .

veil_union_from_bitmap_hash(text, text, text)

function veil_union_from_bitmap_hash(text, text, text) returns bool
Union a bitmap with a specified bitmap from a hash, with the result in the bitmap. This is a faster shortcut for:

veil_bitmap_union(<bitmap>, veil_bitmap_from_hash(<bitmap_array>, <key>)) .

veil_intersect_from_bitmap_hash(text, text, text)

function veil_intersect_from_bitmap_hash(text, text, text) returns bool
Intersect a bitmap with a specified bitmap from a hash, with the result in the bitmap. This is a faster shortcut for:

veil_bitmap_intersect(<bitmap>, veil_bitmap_from_hash(<bitmap_array>, <key>)) .

veil_bitmap_hash_bits(text, text)

function veil_bitmap_hash_bits(text, text) returns setof int4
Show all bits in the specific bitmap within a hash. This is primarily intended for interactive use when developing and debugging Veil-based systems.

veil_bitmap_hash_range(text)

function veil_bitmap_hash_range(text) returns veil_range_t
Show the range of all bitmaps in the hash. Primarily intended for interactive use.

veil_bitmap_hash_entries(text)

function veil_bitmap_hash_entries(text) returns setof text
Show every key in the hash. Primarily intended for interactive use.

Next: Integer Arrays


Generated on Tue Mar 11 10:08:38 2008 for Veil by  doxygen 1.5.4