mirror of
https://github.com/Mercury-Language/mercury.git
synced 2026-04-15 01:13:30 +00:00
ac642e9ef7
LICENSE:
compiler/print_help.m:
doc/*.texi:
profiler/mercury_profile.m:
slice/mcov.m:
slice/mdice.m:
slice/mslice.m:
slice/mtc_diff.m:
slice/mtc_union.m:
trace/mercury_trace_Internal.c:
As above.
119 lines
4.4 KiB
Plaintext
119 lines
4.4 KiB
Plaintext
\input texinfo
|
|
@setfilename mercury_library_manual.info
|
|
@settitle The Mercury Library Reference Manual
|
|
@c vim: ts=4 sw=4 expandtab ft=texinfo
|
|
|
|
@dircategory The Mercury Programming Language
|
|
@direntry
|
|
* Mercury Library: (mercury_library_manual). The Mercury Library Reference Manual.
|
|
@end direntry
|
|
|
|
@c @smallbook
|
|
@c @cropmarks
|
|
@finalout
|
|
@setchapternewpage off
|
|
@ifnottex
|
|
This file documents the Mercury standard library, version <VERSION>.
|
|
|
|
Copyright @copyright{} 1995--1997,1999--2012 The University of Melbourne.@*
|
|
Copyright @copyright{} 2013--2026 The Mercury team.
|
|
|
|
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.
|
|
|
|
@ignore
|
|
Permission is granted to process this file through Tex and print the
|
|
results, provided the printed document carries copying permission
|
|
notice identical to this one except for the removal of this paragraph
|
|
(this paragraph not being relevant to the printed manual).
|
|
|
|
@end ignore
|
|
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.
|
|
@end ifnottex
|
|
|
|
@titlepage
|
|
@title The Mercury Library Reference Manual
|
|
@subtitle Version <VERSION>
|
|
@c @author Fergus Henderson
|
|
@c @author Thomas Conway
|
|
@c @author Zoltan Somogyi
|
|
@page
|
|
@vskip 0pt plus 1filll
|
|
Copyright @copyright{} 1995--1997,1999--2012 The University of Melbourne.@*
|
|
Copyright @copyright{} 2013--2026 The Mercury team.
|
|
|
|
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.
|
|
@end titlepage
|
|
@contents
|
|
@page
|
|
@c ---------------------------------------------------------------------------
|
|
|
|
@ifnottex
|
|
@node Top,,, (mercury)
|
|
@top Mercury Library Reference Manual, version <VERSION>
|
|
@end ifnottex
|
|
|
|
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.
|
|
|
|
This manual is simply
|
|
the interface sections of the modules in the Mercury standard library,
|
|
automatically extracted from the source code.
|
|
@c Some of the library modules are not very well documented,
|
|
@c for which we apologize.
|
|
|
|
@c For many of the modules in the standard library,
|
|
@c we have not yet had enough experience using them to be confident that the
|
|
@c current interface is satisfactory;
|
|
@c it is likely that the interfaces
|
|
@c to many of the modules in the standard library will change somewhat
|
|
@c in future releases of the Mercury system.
|
|
@c Some modules are rather experimental modules
|
|
@c that may even be removed in future releases.
|
|
@c Of course, we wouldn't make changes gratuitously,
|
|
@c but c preserving 100% backwards compatibility
|
|
@c 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''.
|
|
|
|
@menu
|
|
@include mercury_library_menu.texi_pp
|
|
@end menu
|
|
@include mercury_library_chapters.texi_pp
|
|
@bye
|