128 lines
2.0 KiB
HTML
128 lines
2.0 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of Spacetime.Series</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>Spacetime.Series</H1>
|
|
Section: OCaml library (3o)<BR>Updated: 2020-01-30<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
Spacetime.Series - no description
|
|
<A NAME="lbAC"> </A>
|
|
<H2>Module</H2>
|
|
|
|
Module Spacetime.Series
|
|
<A NAME="lbAD"> </A>
|
|
<H2>Documentation</H2>
|
|
|
|
<P>
|
|
Module
|
|
<B>Series</B>
|
|
|
|
<BR> :
|
|
<B>sig end</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>type t </I>
|
|
|
|
<P>
|
|
<P>
|
|
Type representing a file that will hold a series of heap snapshots
|
|
together with additional information required to interpret those
|
|
snapshots.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val create </I>
|
|
|
|
:
|
|
<B>path:string -> t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>create ~path</B>
|
|
|
|
creates a series file at
|
|
<B>path</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val save_event </I>
|
|
|
|
:
|
|
<B>?time:float -> t -> event_name:string -> unit</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>save_event</B>
|
|
|
|
writes an event, which is an arbitrary string, into the
|
|
given series file. This may be used for identifying particular points
|
|
during program execution when analysing the profile.
|
|
The optional
|
|
<B>time</B>
|
|
|
|
parameter is as for
|
|
<B>Spacetime.Snapshot.take</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val save_and_close </I>
|
|
|
|
:
|
|
<B>?time:float -> t -> unit</B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>save_and_close series</B>
|
|
|
|
writes information into
|
|
<B>series</B>
|
|
|
|
required for
|
|
interpreting the snapshots that
|
|
<B>series</B>
|
|
|
|
contains and then closes the
|
|
<B>series</B>
|
|
|
|
file. This function must be called to produce a valid series
|
|
file.
|
|
The optional
|
|
<B>time</B>
|
|
|
|
parameter is as for
|
|
<B>Spacetime.Snapshot.take</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">Module</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">Documentation</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:57 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|