The Mercury Library Reference Manual: Top

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.

Mercury Library Reference Manual, version rotd-2024-12-21

The Mercury standard library contains a variety of modules which we hope may be of general usefulness. If you write a module that would be useful to others, and you would like us to include it as part of the Mercury standard library, please let us know.

The following documentation is simply the interface parts to those modules, automatically extracted from the source code. Some of the library modules are not very well documented; we apologize.

For many of the modules in the standard library, we have not yet had enough experience using them to be confident that the current interface is satisfactory; it is likely that the interfaces to many of the modules in the standard library will change somewhat in future releases of the Mercury system. Some modules are rather experimental modules that may even be removed in future releases. Of course, we wouldn’t make changes gratuitously, but at the current time, preserving 100% backwards compatibility would be disadvantageous in the long run.

To help you protect yourself from depending on modules that are likely to change, each module has a comment “stability: low/medium/high” at the top which gives an indication of the likely stability of the interface to that module. For modules whose stability is “high”, new functionality may be added to the interface, but we envisage very few if any changes to the interface of the sort that might break existing code. For modules whose stability is “medium”, we expect that changes are more likely. For modules whose stability is “low”, such changes are highly likely. If you want to minimize the possibility of your programs requiring modification to work with new releases of the Mercury system, we recommend that if possible you use only those modules whose stability is described as either “medium to high” or “high”.


• array:
• array2d:
• assoc_list:
• bag:
• benchmarking:
• bimap:
• bit_buffer:
• bit_buffer.read:
• bit_buffer.write:
• bitmap:
• bool:
• bt_array:
• builtin:
• calendar:
• char:
• construct:
• cord:
• counter:
• deconstruct:
• diet:
• digraph:
• dir:
• edit_distance:
• edit_seq:
• enum:
• eqvclass:
• exception:
• fat_sparse_bitset:
• fatter_sparse_bitset:
• float:
• gc:
• getopt:
• getopt_io:
• hash_table:
• injection:
• int:
• int8:
• int16:
• int32:
• int64:
• integer:
• io:
• io.call_system:
• io.environment:
• io.file:
• kv_list:
• lazy:
• library:
• list:
• map:
• math:
• maybe:
• mercury_term_lexer:
• mercury_term_parser:
• multi_map:
• one_or_more:
• one_or_more_map:
• ops:
• pair:
• parsing_utils:
• pprint:
• pqueue:
• pretty_printer:
• prolog:
• psqueue:
• queue:
• ra_list:
• random:
• random.sfc16:
• random.sfc32:
• random.sfc64:
• random.system_rng:
• ranges:
• rational:
• rbtree:
• require:
• rtree:
• set:
• set_bbbtree:
• set_ctree234:
• set_ordlist:
• set_tree234:
• set_unordlist:
• solutions:
• sparse_bitset:
• stack:
• std_util:
• store:
• stream:
• stream.string_writer:
• string.builder:
• string:
• table_statistics:
• term:
• term_context:
• term_conversion:
• term_int:
• term_subst:
• term_unify:
• term_vars:
• term_io:
• term_to_xml:
• thread.barrier:
• thread.channel:
• thread.closeable_channel:
• thread.future:
• thread:
• thread.mvar:
• thread.semaphore:
• time:
• tree234:
• tree_bitset:
• type_desc:
• uint:
• uint8:
• uint16:
• uint32:
• uint64:
• unit:
• univ:
• varset:
• version_array:
• version_array2d:
• version_bitmap:
• version_hash_table:
• version_store:

The Mercury Library Reference Manual

Table of Contents

Mercury Library Reference Manual, version rotd-2024-12-21