Index Search Functions (aime)

13.4.4 Index Search Functions

All functions retrieving data link it if allowed, copy it otherwise.

i_first
i_high
i_last
i_low
is_first
is_greater
is_last
is_less
is_lower
is_upper
isd_greater
isd_less
isd_lower
isd_upper
isk_greater
isk_less
isk_lower
isk_upper

i_first

integer i_first(index i, integer &k);

is zero if the i index is empty, non zero otherwise. In the latter case k is set to the first position (first mapped key).

i_high

integer i_high(index i);

is the last position (last mapped key)

i_last

integer i_last(index i, integer &k);

is zero if the i index is empty, non zero otherwise. In the latter case k is set to the last position (last mapped key).

i_low

integer i_low(index i);

is the first position (first mapped key)

is_first

integer is_first(&, index i, integer &k);

is zero if the i index is empty, non zero otherwise. In the latter case k is set to the first position (first mapped key) and the first argument to its associated data.

is_greater

integer is_greater(&, index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) after a, non zero otherwise. In the latter case k is set to the first position after a and the first argument to its associated data.

is_last

integer is_last(&, index i, integer &k);

is zero if the i index is empty, non zero otherwise. In the latter case k is set to the last position (last mapped key) and the first argument to its associated data.

is_less

integer is_less(&, index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) before a, non zero otherwise. In the latter case k is set to the last position before a and the first argument to its associated data.

is_lower

integer is_lower(&, index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) less or equal to a, non zero otherwise. In the latter case k is set to the last not greater position and the first argument to its associated data.

is_upper

integer is_upper(&, index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) greater or equal to a, non zero otherwise. In the latter case k is set to the first not less position and the first argument to its associated data.

isd_greater

integer isd_greater(&, index i, integer a);

is zero if the i index defines no position (maps no key) after a, non zero otherwise. In the latter case the first argument is set to the data associated with the first after position.

isd_less

integer isd_less(&, index i, integer a);

is zero if the i index defines no position (maps no key) before a, non zero otherwise. In the latter case the first argument is set to the data associated with the last before position.

isd_lower

integer isd_lower(&, index i, integer a);

is zero if the i index defines no position (maps no key) less or equal to a, non zero otherwise. In the latter case the first argument is set to the data associated with the last not greater position.

isd_upper

integer isd_upper(&, index i, integer a);

is zero if the i index defines no position (maps no key) greater or equal to a, non zero otherwise. In the latter case the first argument is set to the data associated with the first not less position.

isk_greater

integer isk_greater(index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) after a, non zero otherwise. In the latter case k is set to the first position after a.

isk_less

integer isk_less(index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) before a, non zero otherwise. In the latter case k is set to the last position before a.

isk_lower

integer isk_lower(index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) matching or less than a, non zero otherwise. In the latter case k is set to the last position not after a.

isk_upper

integer isk_upper(index i, integer a, integer &k);

is zero if the i index defines no position (maps no key) matching or greater than a, non zero otherwise. In the latter case k is set to the first position not before a.