.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Math::Prime::Util::MemFree 3pm"
.TH Math::Prime::Util::MemFree 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Math::Prime::Util::MemFree \- An auto\-free object for Math::Prime::Util
.SH VERSION
.IX Header "VERSION"
Version 0.73
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Math::Prime::Util;
\&
\&  {
\&    my $mf = Math::Prime::Util::MemFree\->new;
\&    # ... do things with Math::Prime::Util ...
\&  }
\&  # When the last object leaves scope, prime_memfree is called.
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a more robust way of making sure any cached memory is freed, as it
will be handled by the last \f(CW\*(C`MemFree\*(C'\fR object leaving scope.  This means if
your routines were inside an eval that died, things will still get cleaned up.
If you call another function that uses a MemFree object, the cache will stay
in place because you still have an object.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.SS new
.IX Subsection "new"
Creates a new auto-free object.  This object has no methods and has no data.
When it leaves scope it will call \f(CW\*(C`prime_memfree\*(C'\fR, thereby releasing any
extra memory that the Math::Prime::Util module may have allocated.
.PP
Memory is not freed until the last object goes out of scope.  \f(CW\*(C`prime_memfree\*(C'\fR
may always be called manually.  All memory is freed at \f(CW\*(C`END\*(C'\fR time, so this is
mainly for long running programs that want extra control over memory use.
.SH AUTHORS
.IX Header "AUTHORS"
Dana Jacobsen <dana@acm.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2012 by Dana Jacobsen <dana@acm.org>
.PP
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.