<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>registerFinalizer -- register a string that will be displayed when an object is garbage collected</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_regularity.html">next</a> | <a href="_reduce__Hilbert.html">previous</a> | <a href="_regularity.html">forward</a> | <a href="_reduce__Hilbert.html">backward</a> | up | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<hr/>
<div><h1>registerFinalizer -- register a string that will be displayed when an object is garbage collected</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>registerFinalizer(x,str)</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>x</tt>, <span>a <a href="___Thing.html">thing</a></span></span></li>
<li><span><tt>str</tt>, <span>a <a href="___String.html">string</a></span></span></li>
</ul>
</div>
</li>
<li><div class="single">Consequences:<ul><li>A finalizer is registered with the garbage collector to print a string when that object is collected as garbage</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><table class="examples"><tr><td><pre>i1 : R = QQ[a..d];</pre>
</td></tr>
<tr><td><pre>i2 : makeGB = (n) -> (g := gb((ideal vars R)^4); registerFinalizer(g, "gb("|n|")"););</pre>
</td></tr>
<tr><td><pre>i3 : for i from 1 to 10 do (makeGB i);</pre>
</td></tr>
<tr><td><pre>i4 : collectGarbage()
--finalization: [1]: gb(2)
--finalization: [3]: gb(4)
--finalization: [2]: gb(3)
--finalization: [6]: gb(7)
--finalization: [9]: gb(10)
--finalization: [7]: gb(8)
--finalization: [4]: gb(5)
--finalization: [5]: gb(6)
--finalization: [8]: gb(9)
--finalization: [0]: gb(1)</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>Caveat</h2>
<div>This function should mainly be used for debugging. Having a large number of finalizers might degrade the performance of the program.</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_collect__Garbage.html" title="collect the garbage in memory">collectGarbage</a> -- collect the garbage in memory</span></li>
</ul>
</div>
</div>
</body>
</html>
