Quellcodebibliothek Statistik Leitseite products/Sources/formale Sprachen/GAP/pkg/simpcomp/doc/   (Algebra von RWTH Aachen Version 4.15.1©)  Datei vom 18.2.2022 mit Größe 15 kB image not shown  

Quelle  chap15.html   Sprache: HTML

 
 products/Sources/formale Sprachen/GAP/pkg/simpcomp/doc/chap15.html


<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>GAP (simpcomp) - Chapter 15: Miscellaneous functions</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="generator" content="GAPDoc2HTML" />
<link rel="stylesheet" type="text/css" href="manual.css" />
<script src="manual.js" type="text/javascript"></script>
<script type="text/javascript">overwriteStyle();</script>
</head>
<body class="chap15"  onload="jscontent()">


<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chap5.html">5</a>  <a href="chap6.html">6</a>  <a href="chap7.html">7</a>  <a href="chap8.html">8</a>  <a href="chap9.html">9</a>  <a href="chap10.html">10</a>  <a href="chap11.html">11</a>  <a href="chap12.html">12</a>  <a href="chap13.html">13</a>  <a href="chap14.html">14</a>  <a href="chap15.html">15</a>  <a href="chap16.html">16</a>  <a href="chap17.html">17</a>  <a href="chap18.html">18</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<div class="chlinkprevnexttop"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap14.html">[Previous Chapter]</a>    <a href="chap16.html">[Next Chapter]</a>   </div>

<p id="mathjaxlink" class="pcenter"><a href="chap15_mj.html">[MathJax on]</a></p>
<p><a id="X8308D685809A4E2F" name="X8308D685809A4E2F"></a></p>
<div class="ChapSects"><a href="chap15.html#X8308D685809A4E2F">15 <span class="Heading">Miscellaneous functions</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap15.html#X7C3D35DF7BD07C5A">15.1 <span class="Heading"><strong class="pkg">simpcomp</strong> logging</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X79815139873FF4CF">15.1-1 SCInfoLevel</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap15.html#X856126D583C70E76">15.2 <span class="Heading">Email notification system</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X85A5282378E8303E">15.2-1 SCMailClearPending</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X7D3826B887ACF1E5">15.2-2 SCMailIsEnabled</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X857AEAAB85BD7513">15.2-3 SCMailIsPending</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X7FEA17D37B36BBD4">15.2-4 SCMailSend</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X82DA7B2682F5F117">15.2-5 SCMailSendPending</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X8771F97F7E78B7AC">15.2-6 SCMailSetAddress</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X82AA843F7F37B21E">15.2-7 SCMailSetEnabled</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X87DA54EA7950D4BB">15.2-8 SCMailSetMinInterval</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap15.html#X7BA8676B7FF308FD">15.3 <span class="Heading">Testing the functionality of <strong class="pkg">simpcomp</strong></span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap15.html#X7A26BD457A6E7AC3">15.3-1 SCRunTest</a></span>
</div></div>
</div>

<h3>15 <span class="Heading">Miscellaneous functions</span></h3>

<p>The behaviour of <strong class="pkg">simpcomp</strong> can be changed by setting cetain global options. This can be achieved by the functions described in the following.</p>

<p><a id="X7C3D35DF7BD07C5A" name="X7C3D35DF7BD07C5A"></a></p>

<h4>15.1 <span class="Heading"><strong class="pkg">simpcomp</strong> logging</span></h4>

<p>The verbosity of the output of information to the screen during calls to functions of the package <strong class="pkg">simpcomp</strong> can be controlled by setting the info level parameter via the function <code class="func">SCInfoLevel</code> (<a href="chap15.html#X79815139873FF4CF"><span class="RefLink">15.1-1</span></a>).</p>

<p><a id="X79815139873FF4CF" name="X79815139873FF4CF"></a></p>

<h5>15.1-1 SCInfoLevel</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCInfoLevel</code>( <var class="Arg">level</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code></p>

<p>Sets the logging verbosity of <strong class="pkg">simpcomp</strong>. A level of <span class="SimpleMath">0</span> suppresses all output, a level of <span class="SimpleMath">1</span> lets <strong class="pkg">simpcomp</strongoutput normal running information, whereas levels of <span class="SimpleMath">2</span> and higher display verbose running information. Examples of functions using more verbose logging are bistellar flip-related functions.</p>


<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">SCInfoLevel(3);</span>
true
<span class="GAPprompt">gap></span> <span class="GAPinput">c:=SCBdCrossPolytope(3);;</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">SCReduceComplex(c); </span>
#I  round 0, move: [ [ 4, 5 ], [ 1, 2 ] ]
F: [ 6, 12, 8 ]
#I  round 1, move: [ [ 5 ], [ 1, 2, 3 ] ]
F: [ 5, 9, 6 ]
#I  round 1
Reduced complex, F: [ 5, 9, 6 ]
#I  round 2, move: [ [ 3 ], [ 1, 2, 6 ] ]
F: [ 4, 6, 4 ]
#I  round 2
Reduced complex, F: [ 4, 6, 4 ]
#I  SCReduceComplexEx: computed locally minimal complex after 3 rounds.
[ true, <SimplicialComplex: unnamed complex 3 | dim = 2 | n = 4>, 3 ]
</pre></div>

<p><a id="X856126D583C70E76" name="X856126D583C70E76"></a></p>

<h4>15.2 <span class="Heading">Email notification system</span></h4>

<p><strong class="pkg">simpcomp</strong> comes with an email notification system that can be used for being notified of the progress of lengthy computations (such as reducing a complex via bistellar flips). See below for a description of the mail notification related functions. Note that this might not work on non-Unix systems.</p>

<p>See <code class="func">SCReduceComplexEx</code> (<a href="chap9.html#X814D9AE287F64F74"><span class="RefLink">9.2-14</span></a>) for an example computation using the email notification system.</p>

<p><a id="X85A5282378E8303E" name="X85A5282378E8303E"></a></p>

<h5>15.2-1 SCMailClearPending</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailClearPending</code>(  )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: nothing.</p>

<p>Clears a pending mail message.</p>


<div class="example"><pre>
 gap> SCMailClearPending();
 
 </pre></div>

<p><a id="X7D3826B887ACF1E5" name="X7D3826B887ACF1E5"></a></p>

<h5>15.2-2 SCMailIsEnabled</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailIsEnabled</code>(  )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code> upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Returns <code class="keyw">true</code> when the mail notification system of <strong class="pkg">simpcomp</strong> is enabled, <code class="keyw">false</code> otherwise. Default setting is <code class="keyw">false</code>.</p>


<div class="example"><pre>
 gap> SCMailSetAddress("johndoe@somehost"); #enables mail notification
 true
 gap> SCMailIsEnabled();
 true
 </pre></div>

<p><a id="X857AEAAB85BD7513" name="X857AEAAB85BD7513"></a></p>

<h5>15.2-3 SCMailIsPending</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailIsPending</code>(  )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code> upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Returns <code class="keyw">true</code> when an email of the <strong class="pkg">simpcomp</strong> email notification system is pending, <code class="keyw">false</code> otherwise.</p>


<div class="example"><pre>
 gap> SCMailIsPending();
 false
 </pre></div>

<p><a id="X7FEA17D37B36BBD4" name="X7FEA17D37B36BBD4"></a></p>

<h5>15.2-4 SCMailSend</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailSend</code>( <var class="Arg">message</var>[, <var class="Arg">starttime</var>][, <var class="Arg">forcesend</var>] )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> when the message was sent, <code class="keyw">false</code> if it was not send, <code class="keyw">fail</code> upon an error.</p>

<p>Tries to send an email to the address specified by <code class="func">SCMailSetAddress</code> (<a href="chap15.html#X8771F97F7E78B7AC"><span class="RefLink">15.2-6</span></a>) using the Unix program <code class="code">mail</code>. The optional parameter <var class="Arg">starttime</varspecifies the starting time (as the integer Unix timestamp) a calculation was started (then the duration of the calculation is included in the email), the optional boolean parameter <var class="Arg">forcesend</var> can be used to force the sending of an email, even if this violates the minimal email sending interval, see <code class="func">SCMailSetMinInterval</code> (<a href="chap15.html#X87DA54EA7950D4BB"><span class="RefLink">15.2-8</span></a>).</p>


<div class="example"><pre>
 gap> SCMailSetAddress("johndoe@somehost"); #enables mail notification
 true
 gap> SCMailIsEnabled();
 true
 gap> SCMailSend("Hello, this is simpcomp.");
 true
 </pre></div>

<p><a id="X82DA7B2682F5F117" name="X82DA7B2682F5F117"></a></p>

<h5>15.2-5 SCMailSendPending</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailSendPending</code>(  )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Tries to send a pending email of the <strong class="pkg">simpcomp</strong> email notification system. Returns <code class="keyw">true</code> on success or if there was no mail pending.</p>


<div class="example"><pre>
 gap> SCMailSendPending();
 true
 </pre></div>

<p><a id="X8771F97F7E78B7AC" name="X8771F97F7E78B7AC"></a></p>

<h5>15.2-6 SCMailSetAddress</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailSetAddress</code>( <var class="Arg">address</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Sets the email address that should be used to send notification messages and enables the mail notification system by calling <code class="func">SCMailSetEnabled</code> (<a href="chap15.html#X82AA843F7F37B21E"><span class="RefLink">15.2-7</span></a>)(<code class="keyw">true</code>).</p>


<div class="example"><pre>
 gap> SCMailSetAddress("johndoe@somehost");
 true
 </pre></div>

<p><a id="X82AA843F7F37B21E" name="X82AA843F7F37B21E"></a></p>

<h5>15.2-7 SCMailSetEnabled</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailSetEnabled</code>( <var class="Arg">flag</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Enables or disables the mail notification system of <strong class="pkg">simpcomp</strong>. By default it is disabled. Returns <code class="keyw">fail</code> if no email message was previously set with <code class="func">SCMailSetAddress</code> (<a href="chap15.html#X8771F97F7E78B7AC"><span class="RefLink">15.2-6</span></a>).</p>


<div class="example"><pre>
 gap> SCMailSetAddress("johndoe@somehost"); #enables mail notification
 true
 gap> SCMailSetEnabled(false);
 true
 </pre></div>

<p><a id="X87DA54EA7950D4BB" name="X87DA54EA7950D4BB"></a></p>

<h5>15.2-8 SCMailSetMinInterval</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCMailSetMinInterval</code>( <var class="Arg">interval</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Sets the minimal time interval in seconds that mail messages can be sent by <strong class="pkg">simpcomp</strong>. This prevents a flooding of the specified email address with messages sent by <strong class="pkg">simpcomp</strong>. Default is 3600, i.e. one hour.</p>


<div class="example"><pre>
 gap> SCMailSetMinInterval(7200);
 true
 </pre></div>

<p><a id="X7BA8676B7FF308FD" name="X7BA8676B7FF308FD"></a></p>

<h4>15.3 <span class="Heading">Testing the functionality of <strong class="pkg">simpcomp</strong></span></h4>

<p><strong class="pkg">simpcomp</strong> makes use of the <strong class="pkg">GAP</strong> internal testing mechanisms and provides the user with a function to test the functionality of the package.</p>

<p><a id="X7A26BD457A6E7AC3" name="X7A26BD457A6E7AC3"></a></p>

<h5>15.3-1 SCRunTest</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ SCRunTest</code>(  )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> upon success, <code class="keyw">fail</code> otherwise.</p>

<p>Test whether the package <strong class="pkg">simpcomp</strong> is functional by calling <code class="code">Test("GAPROOT/pkg/simpcomp/tst/simpcomp.tst",rec(compareFunction := "uptowhitespace"));</code>. The returned value of GAP4stones is a measure of your system performance and differs from system to system.</p>


<div class="example"><pre>
 gap> SCRunTest();
 simpcomp package test
 msecs: 8850
 true
 </pre></div>

<p>On a modern computer, the function <code class="code">SCRunTest</code> should take about a minute to complete when the packages <strong class="pkg">GRAPE</strong> <a href="chapBib.html#biBSoicher06GRAPE">[Soi12]</a> and <strong class="pkg">homology</strong> <a href="chapBib.html#biBDumas04Homology">[DHSW11]</a> are available. If these packages are missing, the testing will take slightly longer.</p>


<div class="chlinkprevnextbot"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap14.html">[Previous Chapter]</a>    <a href="chap16.html">[Next Chapter]</a>   </div>


<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chap5.html">5</a>  <a href="chap6.html">6</a>  <a href="chap7.html">7</a>  <a href="chap8.html">8</a>  <a href="chap9.html">9</a>  <a href="chap10.html">10</a>  <a href="chap11.html">11</a>  <a href="chap12.html">12</a>  <a href="chap13.html">13</a>  <a href="chap14.html">14</a>  <a href="chap15.html">15</a>  <a href="chap16.html">16</a>  <a href="chap17.html">17</a>  <a href="chap18.html">18</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<hr />
<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>

100%


¤ Dauer der Verarbeitung: 0.17 Sekunden  (vorverarbeitet)  ¤

*© Formatika GbR, Deutschland






Wurzel

Suchen

Beweissystem der NASA

Beweissystem Isabelle

NIST Cobol Testsuite

Cephes Mathematical Library

Wiener Entwicklungsmethode

Haftungshinweis

Die Informationen auf dieser Webseite wurden nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit, noch Qualität der bereit gestellten Informationen zugesichert.

Bemerkung:

Die farbliche Syntaxdarstellung ist noch experimentell.