---

13.4.1 Index Insert Interface

The index library objects make available many insert functions. Some of the insert functions make copies of the inserted data, some insert references (for those data types allowing multiple references).

See Referable Objects.

The insertion logic is one of assertive insert (insert if does not exist, fail otherwise), assertive replace (replace if does exist, fail otherwise), replace if exists and insert otherwise, and tentative insert (insert if does not exist, do nothing otherwise). Function failures terminate program execution.

The functions may be data type specific, or generic.

• assertive insert functions
  • - copy functions

    ‘i_put’, ‘i_p_<type-name>’

  • - link functions

    ‘i_link’, ‘i_l_<type-name>’

• assertive replace functions
  • - copy functions

    ‘i_replace’, ‘i_r_<type-name>’

  • - link functions

    ‘i_bind’, ‘i_b_<type-name>’

• replace if exists and insert otherwise functions
  • - copy functions

    ‘i_fix’, ‘i_f_<type-name>’

  • - link functions

    ‘i_case’, ‘i_c_<type-name>’

• tentative insert functions
  • - copy functions

    ‘i_add’, ‘i_a_<type-name>’

  • - link functions

    ‘i_dock’, ‘i_d_<type-name>’

The functions are described in the following sections.