Next: , Previous: , Up: The Index Library   [Index]


13.4.3 Non Data Type Specific Index Functions

i_cast

index i_cast(index i, index j);

is i, empties the i index and links or copies the content of the j index in i (data references are made where the types allow, copies where not)

i_clear

index i_clear(index i);

is i, empties the i index

i_copy

index i_copy(index i, index j);

is i, empties the i index and copies the content of the j index in i

i_delete

index i_delete(index i, integer k);

is i, deletes the k indexed element of the i index

i_down

void i_down(index i, integer k);

decrements the k indexed element in the i index (the element type is intrinsic numerical)

i_erase

index i_erase(index i, integer p, integer q);

is i, deletes the p to q indexed elements of the i index. If q is less than p, the p to end and start to q ranges are deleted.

i_id

integer i_id(index i, integer k);

is the type ID of the k indexed element in the i index

i_key

integer i_key(index i, integer k);

is non zero if the i index defines a k position, 0 otherwise

i_move

void i_move(index i, integer k, integer l);

moves the k indexed element of the i index in the l position

i_new

void i_new(index &i);

sets the i index as a new index (same as ‘i_clear’ if i is not linked multiple times, otherwise creates a new index and sets i as a reference to the new index)

i_resign

index i_resign(index i, integer k);

is i, deletes the k indexed element of the i index if i maps k, does nothing otherwise

i_set

index i_set(index &i, index j);

is j, sets the i index as a reference of the j index

i_size

integer i_size(index i);

is the size (i.e. number of items) of the i index

i_spin

void i_spin(index i, integer k, integer l);

exchanges the k and l indexed elements in the i index

i_swap

index i_swap(index i, index j);

is i, exchanges the content of the i and j indexes.

The function visits every item in the two collections.

i_type

text i_type(index i, integer k);

is the type name of the k indexed element in the i index

i_up

void i_up(index i, integer k);

increments the k indexed element in the i index (the element type is intrinsic numerical)


Next: Index Search Functions, Previous: Index Search Interface, Up: The Index Library   [Index]