| Current Path : /usr/share/gap/doc/ref/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : //usr/share/gap/doc/ref/chap5_mj.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>
<script type="text/javascript"
src="mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
<title>GAP (ref) - Chapter 5: 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="chap5" onload="jscontent()">
<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a> <a href="chap1_mj.html">1</a> <a href="chap2_mj.html">2</a> <a href="chap3_mj.html">3</a> <a href="chap4_mj.html">4</a> <a href="chap5_mj.html">5</a> <a href="chap6_mj.html">6</a> <a href="chap7_mj.html">7</a> <a href="chap8_mj.html">8</a> <a href="chap9_mj.html">9</a> <a href="chap10_mj.html">10</a> <a href="chap11_mj.html">11</a> <a href="chap12_mj.html">12</a> <a href="chap13_mj.html">13</a> <a href="chap14_mj.html">14</a> <a href="chap15_mj.html">15</a> <a href="chap16_mj.html">16</a> <a href="chap17_mj.html">17</a> <a href="chap18_mj.html">18</a> <a href="chap19_mj.html">19</a> <a href="chap20_mj.html">20</a> <a href="chap21_mj.html">21</a> <a href="chap22_mj.html">22</a> <a href="chap23_mj.html">23</a> <a href="chap24_mj.html">24</a> <a href="chap25_mj.html">25</a> <a href="chap26_mj.html">26</a> <a href="chap27_mj.html">27</a> <a href="chap28_mj.html">28</a> <a href="chap29_mj.html">29</a> <a href="chap30_mj.html">30</a> <a href="chap31_mj.html">31</a> <a href="chap32_mj.html">32</a> <a href="chap33_mj.html">33</a> <a href="chap34_mj.html">34</a> <a href="chap35_mj.html">35</a> <a href="chap36_mj.html">36</a> <a href="chap37_mj.html">37</a> <a href="chap38_mj.html">38</a> <a href="chap39_mj.html">39</a> <a href="chap40_mj.html">40</a> <a href="chap41_mj.html">41</a> <a href="chap42_mj.html">42</a> <a href="chap43_mj.html">43</a> <a href="chap44_mj.html">44</a> <a href="chap45_mj.html">45</a> <a href="chap46_mj.html">46</a> <a href="chap47_mj.html">47</a> <a href="chap48_mj.html">48</a> <a href="chap49_mj.html">49</a> <a href="chap50_mj.html">50</a> <a href="chap51_mj.html">51</a> <a href="chap52_mj.html">52</a> <a href="chap53_mj.html">53</a> <a href="chap54_mj.html">54</a> <a href="chap55_mj.html">55</a> <a href="chap56_mj.html">56</a> <a href="chap57_mj.html">57</a> <a href="chap58_mj.html">58</a> <a href="chap59_mj.html">59</a> <a href="chap60_mj.html">60</a> <a href="chap61_mj.html">61</a> <a href="chap62_mj.html">62</a> <a href="chap63_mj.html">63</a> <a href="chap64_mj.html">64</a> <a href="chap65_mj.html">65</a> <a href="chap66_mj.html">66</a> <a href="chap67_mj.html">67</a> <a href="chap68_mj.html">68</a> <a href="chap69_mj.html">69</a> <a href="chap70_mj.html">70</a> <a href="chap71_mj.html">71</a> <a href="chap72_mj.html">72</a> <a href="chap73_mj.html">73</a> <a href="chap74_mj.html">74</a> <a href="chap75_mj.html">75</a> <a href="chap76_mj.html">76</a> <a href="chap77_mj.html">77</a> <a href="chap78_mj.html">78</a> <a href="chap79_mj.html">79</a> <a href="chap80_mj.html">80</a> <a href="chap81_mj.html">81</a> <a href="chap82_mj.html">82</a> <a href="chap83_mj.html">83</a> <a href="chap84_mj.html">84</a> <a href="chap85_mj.html">85</a> <a href="chap86_mj.html">86</a> <a href="chap87_mj.html">87</a> <a href="chapBib_mj.html">Bib</a> <a href="chapInd_mj.html">Ind</a> </div>
<div class="chlinkprevnexttop"> <a href="chap0_mj.html">[Top of Book]</a> <a href="chap0_mj.html#contents">[Contents]</a> <a href="chap4_mj.html">[Previous Chapter]</a> <a href="chap6_mj.html">[Next Chapter]</a> </div>
<p id="mathjaxlink" class="pcenter"><a href="chap5.html">[MathJax off]</a></p>
<p><a id="X86FA580F8055B274" name="X86FA580F8055B274"></a></p>
<div class="ChapSects"><a href="chap5_mj.html#X86FA580F8055B274">5 <span class="Heading">Functions</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X870553EF8605792F">5.1 <span class="Heading">Information about a function</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X79C3BDC4781FA0FD">5.1-1 NameFunction</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X877F03F77FD74C98">5.1-2 NumberArgumentsFunction</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X818BAB817A4FB346">5.1-3 NamesLocalVariablesFunction</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X80E108C57F90FAA3">5.1-4 FilenameFunc</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X7FF7643781D2C194">5.1-5 StartlineFunc</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X844F95767C74834F">5.1-6 LocationFunc</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X845A929B83D46E01">5.1-7 PageSource</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X851B58408520700D">5.2 <span class="Heading">Calling a function with a list argument that is interpreted as
several arguments</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X7CF4DDB97D65AE52">5.2-1 CallFuncList</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X83066E5A80B5FB71">5.3 <span class="Heading">Wrapping a function, so the values produced are cached</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X817ED3B280A64601">5.3-1 MemoizePosIntFunction</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X7EB0A85F7D128BE0">5.4 <span class="Heading">Functions that do nothing</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X7DB422A2876CCC4D">5.4-1 ReturnTrue</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X7C131FB17D7518FC">5.4-2 ReturnFalse</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X7A0994DE7C258E55">5.4-3 ReturnFail</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X818EA8C47B46A634">5.4-4 ReturnNothing</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X8788D7D780FCE169">5.4-5 ReturnFirst</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X810325697BDEF899">5.4-6 IdFunc</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X80FE39D27CE3DE1B">5.5 <span class="Heading">Function Types</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X85E40340806C2B8C">5.5-1 IsFunction</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X874C7C6D8650D648">5.5-2 IsOperation</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap5_mj.html#X87838FE885A9AAF9">5.5-3 FunctionsFamily</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X81F732457F7BC851">5.6 <span class="Heading">Naming Conventions</span></a>
</span>
</div>
</div>
<h3>5 <span class="Heading">Functions</span></h3>
<p>The section <a href="chap4_mj.html#X815F71EA7BC0EB6F"><span class="RefLink">4.23</span></a> describes how to define a function. In this chapter we describe functions that give information about functions, and various utility functions used either when defining functions or calling functions.</p>
<p><a id="X870553EF8605792F" name="X870553EF8605792F"></a></p>
<h4>5.1 <span class="Heading">Information about a function</span></h4>
<p><a id="X79C3BDC4781FA0FD" name="X79C3BDC4781FA0FD"></a></p>
<h5>5.1-1 NameFunction</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ NameFunction</code>( <var class="Arg">func</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>returns the name of a function. For operations, this is the name used in their declaration. For functions, this is the variable name they were first assigned to. (For some internal functions, this might be a name <em>different</em> from the name that is documented.) If no such name exists, the string <code class="code">"unknown"</code> is returned.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">NameFunction(SylowSubgroup);</span>
"SylowSubgroup"
<span class="GAPprompt">gap></span> <span class="GAPinput">Blubberflutsch:=x->x;;</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">NameFunction(Blubberflutsch);</span>
"Blubberflutsch"
<span class="GAPprompt">gap></span> <span class="GAPinput">a:=Blubberflutsch;;</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">NameFunction(a);</span>
"Blubberflutsch"
<span class="GAPprompt">gap></span> <span class="GAPinput">NameFunction(x->x);</span>
"unknown"
<span class="GAPprompt">gap></span> <span class="GAPinput">NameFunction(NameFunction);</span>
"NameFunction"
</pre></div>
<p><a id="X877F03F77FD74C98" name="X877F03F77FD74C98"></a></p>
<h5>5.1-2 NumberArgumentsFunction</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ NumberArgumentsFunction</code>( <var class="Arg">func</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>returns the number of arguments the function <var class="Arg">func</var> accepts. -1 is returned for all operations. For functions that use <code class="code">...</code> or <code class="code">arg</code> to take a variable number of arguments, the number returned is -1 times the total number of parameters. For attributes, 1 is returned.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">NumberArgumentsFunction(function(a,b,c,d,e,f,g,h,i,j,k)return 1;end);</span>
11
<span class="GAPprompt">gap></span> <span class="GAPinput">NumberArgumentsFunction(Size);</span>
1
<span class="GAPprompt">gap></span> <span class="GAPinput">NumberArgumentsFunction(IsCollsCollsElms);</span>
3
<span class="GAPprompt">gap></span> <span class="GAPinput">NumberArgumentsFunction(Sum);</span>
-1
<span class="GAPprompt">gap></span> <span class="GAPinput">NumberArgumentsFunction(function(a, x...) return 1; end);</span>
-2
</pre></div>
<p><a id="X818BAB817A4FB346" name="X818BAB817A4FB346"></a></p>
<h5>5.1-3 NamesLocalVariablesFunction</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ NamesLocalVariablesFunction</code>( <var class="Arg">func</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>returns a mutable list of strings; the first entries are the names of the arguments of the function <var class="Arg">func</var>, in the same order as they were entered in the definition of <var class="Arg">func</var>, and the remaining ones are the local variables as given in the <code class="keyw">local</code> statement in <var class="Arg">func</var>. (The number of arguments can be computed with <code class="func">NumberArgumentsFunction</code> (<a href="chap5_mj.html#X877F03F77FD74C98"><span class="RefLink">5.1-2</span></a>).)</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">NamesLocalVariablesFunction(function( a, b ) local c; return 1; end);</span>
[ "a", "b", "c" ]
<span class="GAPprompt">gap></span> <span class="GAPinput">NamesLocalVariablesFunction(function( arg ) local a; return 1; end);</span>
[ "arg", "a" ]
<span class="GAPprompt">gap></span> <span class="GAPinput">NamesLocalVariablesFunction( Size );</span>
fail
</pre></div>
<p><a id="X80E108C57F90FAA3" name="X80E108C57F90FAA3"></a></p>
<h5>5.1-4 FilenameFunc</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ FilenameFunc</code>( <var class="Arg">func</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>For a function <var class="Arg">func</var>, <code class="func">FilenameFunc</code> returns either <code class="keyw">fail</code> or the absolute path of the file from which <var class="Arg">func</var> has been read. The return value <code class="keyw">fail</code> occurs if <var class="Arg">func</var> is a compiled function or an operation. For functions that have been entered interactively, the string <code class="code">"*stdin*"</code> is returned, see Section <a href="chap9_mj.html#X85EC7D9087C481B0"><span class="RefLink">9.5</span></a>.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">FilenameFunc( LEN_LIST ); # a kernel function</span>
fail
<span class="GAPprompt">gap></span> <span class="GAPinput">FilenameFunc( Size ); # an operation</span>
fail
<span class="GAPprompt">gap></span> <span class="GAPinput">FilenameFunc( x -> x^2 ); # an interactively entered function</span>
"*stdin*"
<span class="GAPprompt">gap></span> <span class="GAPinput">meth:= ApplicableMethod( Size, [ Group( () ) ] );;</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">FilenameFunc( meth );</span>
"... some path .../grpperm.gi"
</pre></div>
<p><a id="X7FF7643781D2C194" name="X7FF7643781D2C194"></a></p>
<h5>5.1-5 StartlineFunc</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ StartlineFunc</code>( <var class="Arg">func</var> )</td><td class="tdright">( function )</td></tr></table></div>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ EndlineFunc</code>( <var class="Arg">func</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>Let <var class="Arg">func</var> be a function. If <code class="func">FilenameFunc</code> (<a href="chap5_mj.html#X80E108C57F90FAA3"><span class="RefLink">5.1-4</span></a>) returns <code class="keyw">fail</code> for <var class="Arg">func</var> then also <code class="func">StartlineFunc</code> returns <code class="keyw">fail</code>. If <code class="func">FilenameFunc</code> (<a href="chap5_mj.html#X80E108C57F90FAA3"><span class="RefLink">5.1-4</span></a>) returns a filename for <var class="Arg">func</var> then <code class="func">StartlineFunc</code> returns the line number in this file where the definition of <var class="Arg">func</var> starts.</p>
<p><code class="func">EndlineFunc</code> behaves similarly and returns the line number in this file where the definition of <var class="Arg">func</var> ends.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">meth:= ApplicableMethod( Size, [ Group( () ) ] );;</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">FilenameFunc( meth );</span>
"... some path ... gap4r5/lib/grpperm.gi"
<span class="GAPprompt">gap></span> <span class="GAPinput">StartlineFunc( meth );</span>
487
<span class="GAPprompt">gap></span> <span class="GAPinput">EndlineFunc( meth );</span>
487
</pre></div>
<p><a id="X844F95767C74834F" name="X844F95767C74834F"></a></p>
<h5>5.1-6 LocationFunc</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ LocationFunc</code>( <var class="Arg">func</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>Let <var class="Arg">func</var> be a function. Returns a string describing the location of <var class="Arg">func</var>, or an empty string if the information cannot be found. This uses the information provided by <code class="func">FilenameFunc</code> (<a href="chap5_mj.html#X80E108C57F90FAA3"><span class="RefLink">5.1-4</span></a>) and <code class="func">StartlineFunc</code> (<a href="chap5_mj.html#X7FF7643781D2C194"><span class="RefLink">5.1-5</span></a>)</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">LocationFunc( Intersection );</span>
"... some path ... gap/lib/coll.gi:2467"
# String is an attribute, so no information is stored
<span class="GAPprompt">gap></span> <span class="GAPinput">LocationFunc( String );</span>
""
</pre></div>
<p><a id="X845A929B83D46E01" name="X845A929B83D46E01"></a></p>
<h5>5.1-7 PageSource</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ PageSource</code>( <var class="Arg">func</var>[, <var class="Arg">nr</var>] )</td><td class="tdright">( function )</td></tr></table></div>
<p>This shows the file containing the source code of the function or method <var class="Arg">func</var> in a pager (see <code class="func">Pager</code> (<a href="chap2_mj.html#X7ED03E41792C3840"><span class="RefLink">2.4-1</span></a>)). The display starts at a line shortly before the code of <var class="Arg">func</var>.</p>
<p>For operations <var class="Arg">func</var> the function shows the source code of the declaration of <var class="Arg">func</var>. Operations can have several declarations, use the optional second argument to specify which one should be shown (in the order the declarations were read); the default is to show the first.</p>
<p>For kernel functions the function tries to show the C source code.</p>
<p>If GAP cannot find a file containing the source code this will be indicated.</p>
<p>Usage examples:<br /> <code class="code">met := ApplicableMethod(\^, [(1,2),2743527]); PageSource(met);</code><br /> <code class="code">PageSource(Combinations);</code><br /> <code class="code">PageSource(SORT_LIST); </code><br /> <code class="code">PageSource(Size, 2);</code><br /> <code class="code">ct := CharacterTable(Group((1,2,3))); </code><br /> <code class="code">met := ApplicableMethod(Size,[ct]); PageSource(met); </code></p>
<p><a id="X851B58408520700D" name="X851B58408520700D"></a></p>
<h4>5.2 <span class="Heading">Calling a function with a list argument that is interpreted as
several arguments</span></h4>
<p><a id="X7CF4DDB97D65AE52" name="X7CF4DDB97D65AE52"></a></p>
<h5>5.2-1 CallFuncList</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ CallFuncList</code>( <var class="Arg">func</var>, <var class="Arg">args</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ CallFuncListWrap</code>( <var class="Arg">func</var>, <var class="Arg">args</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>returns the result, when calling function <var class="Arg">func</var> with the arguments given in the list <var class="Arg">args</var>, i.e. <var class="Arg">args</var> is "unwrapped" so that <var class="Arg">args</var> appears as several arguments to <var class="Arg">func</var>.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">CallFuncList(\+, [6, 7]);</span>
13
<span class="GAPprompt">gap></span> <span class="GAPinput">#is equivalent to:</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">\+(6, 7);</span>
13
</pre></div>
<p>A more useful application of <code class="func">CallFuncList</code> is for a function <code class="code">g</code> that is called in the body of a function <code class="code">f</code> with (a sublist of) the arguments of <code class="code">f</code>, where <code class="code">f</code> has been defined with a single formal argument <code class="code">arg</code> (see <a href="chap4_mj.html#X815F71EA7BC0EB6F"><span class="RefLink">4.23</span></a>), as in the following code fragment.</p>
<div class="example"><pre>
f := function ( arg )
CallFuncList(g, arg);
...
end;
</pre></div>
<p>In the body of <code class="code">f</code> the several arguments passed to <code class="code">f</code> become a list <code class="code">arg</code>. If <code class="code">g</code> were called instead via <code class="code">g( arg )</code> then <code class="code">g</code> would see a single list argument, so that <code class="code">g</code> would, in general, have to "unwrap" the passed list. The following (not particularly useful) example demonstrates both described possibilities for the call to <code class="code">g</code>.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">PrintNumberFromDigits := function ( arg )</span>
<span class="GAPprompt">></span> <span class="GAPinput"> CallFuncList( Print, arg );</span>
<span class="GAPprompt">></span> <span class="GAPinput"> Print( "\n" );</span>
<span class="GAPprompt">></span> <span class="GAPinput"> end;</span>
function( arg... ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">PrintNumberFromDigits( 1, 9, 7, 3, 2 );</span>
19732
<span class="GAPprompt">gap></span> <span class="GAPinput">PrintDigits := function ( arg )</span>
<span class="GAPprompt">></span> <span class="GAPinput"> Print( arg );</span>
<span class="GAPprompt">></span> <span class="GAPinput"> Print( "\n" );</span>
<span class="GAPprompt">></span> <span class="GAPinput"> end;</span>
function( arg... ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">PrintDigits( 1, 9, 7, 3, 2 );</span>
[ 1, 9, 7, 3, 2 ]
</pre></div>
<p><code class="func">CallFuncListWrap</code> differs only in that the result is a list. This returned list is empty if the called function returned no value, else it contains the returned value as it's single member. This allows wrapping functions which may, or may not return a value.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">CallFuncListWrap( x -> x, [1] );</span>
[ 1 ]
<span class="GAPprompt">gap></span> <span class="GAPinput">CallFuncListWrap( function(x) end, [1] );</span>
[ ]
</pre></div>
<p><a id="X83066E5A80B5FB71" name="X83066E5A80B5FB71"></a></p>
<h4>5.3 <span class="Heading">Wrapping a function, so the values produced are cached</span></h4>
<p><a id="X817ED3B280A64601" name="X817ED3B280A64601"></a></p>
<h5>5.3-1 MemoizePosIntFunction</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ MemoizePosIntFunction</code>( <var class="Arg">function</var>[, <var class="Arg">options</var>] )</td><td class="tdright">( function )</td></tr></table></div>
<p><code class="func">MemoizePosIntFunction</code> returns a function which behaves the same as <var class="Arg">function</var>, except it caches the results; if the new function is called with the same input, then any call after the first will return the cached value, instead of recomputing it. The cache is flushed by calling <code class="func">FlushCaches</code> (<a href="chap79_mj.html#X87A4316C818B3DE3"><span class="RefLink">79.18-18</span></a>).</p>
<p>The returned function will only accept positive integers.</p>
<p>This function does not promise to never call <var class="Arg">function</var> more than once for any input -- values may be removed if the cache gets too large, or GAP chooses to flush all caches, or if multiple threads try to calculate the same value simultaneously.</p>
<p>The optional second argument is a record which provides a number of configuration options. The following options are supported.</p>
<dl>
<dt><strong class="Mark"><code class="code">defaults</code> (default an empty list)</strong></dt>
<dd><p>Used to initalise the cache, both initially and after each flush.</p>
</dd>
<dt><strong class="Mark"><code class="code">flush</code> (default <code class="keyw">true</code>)</strong></dt>
<dd><p>If this is <code class="keyw">true</code>, the cache is emptied whenever <code class="func">FlushCaches</code> (<a href="chap79_mj.html#X87A4316C818B3DE3"><span class="RefLink">79.18-18</span></a>) is called.</p>
</dd>
<dt><strong class="Mark"><code class="code">errorHandler</code> (defaults to <code class="func">Error</code> (<a href="chap6_mj.html#X7E7AD8D87EBA1A08"><span class="RefLink">6.6-1</span></a>))</strong></dt>
<dd><p>A function to be called when an input which is not a positive integer is passed to the cache. If this function returns a value, that value is returned by the cache.</p>
</dd>
</dl>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">f := MemoizePosIntFunction(</span>
<span class="GAPprompt">></span> <span class="GAPinput"> function(i) Print("Check: ",i,"\n"); return i*i; end,</span>
<span class="GAPprompt">></span> <span class="GAPinput"> rec(defaults := [,,50], errorHandler := x -> "Bad") );;</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">f(2);</span>
Check: 2
4
<span class="GAPprompt">gap></span> <span class="GAPinput">f(2);</span>
4
<span class="GAPprompt">gap></span> <span class="GAPinput">f(3);</span>
50
<span class="GAPprompt">gap></span> <span class="GAPinput">f(-3);</span>
"Bad"
<span class="GAPprompt">gap></span> <span class="GAPinput">FlushCaches();</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">f(2);</span>
Check: 2
4
<span class="GAPprompt">gap></span> <span class="GAPinput">f(3);</span>
50
</pre></div>
<p><a id="X7EB0A85F7D128BE0" name="X7EB0A85F7D128BE0"></a></p>
<h4>5.4 <span class="Heading">Functions that do nothing</span></h4>
<p>The following functions return fixed results (or just their own argument). They can be useful in places when the syntax requires a function, but actually no functionality is required. So <code class="func">ReturnTrue</code> (<a href="chap5_mj.html#X7DB422A2876CCC4D"><span class="RefLink">5.4-1</span></a>) is often used as family predicate in <code class="func">InstallMethod</code> (<a href="chap78_mj.html#X837EFDAB7BEF290B"><span class="RefLink">78.2-1</span></a>).</p>
<p><a id="X7DB422A2876CCC4D" name="X7DB422A2876CCC4D"></a></p>
<h5>5.4-1 ReturnTrue</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ ReturnTrue</code>( <var class="Arg">...</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>This function takes any number of arguments, and always returns <code class="keyw">true</code>.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">f:=ReturnTrue; </span>
function( arg... ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">f(); </span>
true
<span class="GAPprompt">gap></span> <span class="GAPinput">f(42);</span>
true
</pre></div>
<p><a id="X7C131FB17D7518FC" name="X7C131FB17D7518FC"></a></p>
<h5>5.4-2 ReturnFalse</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ ReturnFalse</code>( <var class="Arg">...</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>This function takes any number of arguments, and always returns <code class="keyw">false</code>.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">f:=ReturnFalse; </span>
function( arg... ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">f(); </span>
false
<span class="GAPprompt">gap></span> <span class="GAPinput">f("any_string");</span>
false
</pre></div>
<p><a id="X7A0994DE7C258E55" name="X7A0994DE7C258E55"></a></p>
<h5>5.4-3 ReturnFail</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ ReturnFail</code>( <var class="Arg">...</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>This function takes any number of arguments, and always returns <code class="keyw">fail</code>.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">oops:=ReturnFail; </span>
function( arg... ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">oops(); </span>
fail
<span class="GAPprompt">gap></span> <span class="GAPinput">oops(-42); </span>
fail
</pre></div>
<p><a id="X818EA8C47B46A634" name="X818EA8C47B46A634"></a></p>
<h5>5.4-4 ReturnNothing</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ ReturnNothing</code>( <var class="Arg">...</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>This function takes any number of arguments, and always returns nothing.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">n:=ReturnNothing;</span>
function( object... ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">n();</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">n(-42);</span>
</pre></div>
<p><a id="X8788D7D780FCE169" name="X8788D7D780FCE169"></a></p>
<h5>5.4-5 ReturnFirst</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ ReturnFirst</code>( <var class="Arg">...</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>This function takes one or more arguments, and always returns the first argument. <code class="func">IdFunc</code> (<a href="chap5_mj.html#X810325697BDEF899"><span class="RefLink">5.4-6</span></a>) behaves similarly, but only accepts a single argument.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">f:=ReturnFirst;</span>
function( object... ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">f(1);</span>
1
<span class="GAPprompt">gap></span> <span class="GAPinput">f(2,3,4);</span>
2
<span class="GAPprompt">gap></span> <span class="GAPinput">f();</span>
Error, RETURN_FIRST requires one or more arguments
</pre></div>
<p><a id="X810325697BDEF899" name="X810325697BDEF899"></a></p>
<h5>5.4-6 IdFunc</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ IdFunc</code>( <var class="Arg">obj</var> )</td><td class="tdright">( function )</td></tr></table></div>
<p>returns <var class="Arg">obj</var>. <code class="func">ReturnFirst</code> (<a href="chap5_mj.html#X8788D7D780FCE169"><span class="RefLink">5.4-5</span></a>) is similar, but accepts one or more arguments, returning only the first.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">id:=IdFunc; </span>
function( object ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">id(42); </span>
42
<span class="GAPprompt">gap></span> <span class="GAPinput">f:=id(SymmetricGroup(3)); </span>
Sym( [ 1 .. 3 ] )
<span class="GAPprompt">gap></span> <span class="GAPinput">s:=One(AutomorphismGroup(SymmetricGroup(3)));</span>
IdentityMapping( Sym( [ 1 .. 3 ] ) )
<span class="GAPprompt">gap></span> <span class="GAPinput">f=s;</span>
false
</pre></div>
<p><a id="X80FE39D27CE3DE1B" name="X80FE39D27CE3DE1B"></a></p>
<h4>5.5 <span class="Heading">Function Types</span></h4>
<p>Functions are <strong class="pkg">GAP</strong> objects and thus have categories and a family.</p>
<p><a id="X85E40340806C2B8C" name="X85E40340806C2B8C"></a></p>
<h5>5.5-1 IsFunction</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ IsFunction</code>( <var class="Arg">obj</var> )</td><td class="tdright">( category )</td></tr></table></div>
<p>is the category of functions.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">IsFunction(x->x^2);</span>
true
<span class="GAPprompt">gap></span> <span class="GAPinput">IsFunction(Factorial);</span>
true
<span class="GAPprompt">gap></span> <span class="GAPinput">f:=One(AutomorphismGroup(SymmetricGroup(3)));</span>
IdentityMapping( Sym( [ 1 .. 3 ] ) )
<span class="GAPprompt">gap></span> <span class="GAPinput">IsFunction(f); </span>
false
</pre></div>
<p><a id="X874C7C6D8650D648" name="X874C7C6D8650D648"></a></p>
<h5>5.5-2 IsOperation</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ IsOperation</code>( <var class="Arg">obj</var> )</td><td class="tdright">( category )</td></tr></table></div>
<p>is the category of operations. Every operation is a function, but not vice versa.</p>
<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">MinimalPolynomial; </span>
<Operation "MinimalPolynomial">
<span class="GAPprompt">gap></span> <span class="GAPinput">IsOperation(MinimalPolynomial);</span>
true
<span class="GAPprompt">gap></span> <span class="GAPinput">IsFunction(MinimalPolynomial); </span>
true
<span class="GAPprompt">gap></span> <span class="GAPinput">Factorial;</span>
function( n ) ... end
<span class="GAPprompt">gap></span> <span class="GAPinput">IsOperation(Factorial);</span>
false
</pre></div>
<p><a id="X87838FE885A9AAF9" name="X87838FE885A9AAF9"></a></p>
<h5>5.5-3 FunctionsFamily</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ FunctionsFamily</code></td><td class="tdright">( family )</td></tr></table></div>
<p>is the family of all functions.</p>
<p><a id="X81F732457F7BC851" name="X81F732457F7BC851"></a></p>
<h4>5.6 <span class="Heading">Naming Conventions</span></h4>
<p>The way functions are named in <strong class="pkg">GAP</strong> might help to memorize or even guess names of library functions.</p>
<p>If a variable name consists of several words then the first letter of each word is capitalized.</p>
<p>If the first part of the name of a function is a verb then the function may modify its argument(s) but does not return anything, for example <code class="func">Append</code> (<a href="chap21_mj.html#X79E31DB27C82D6E1"><span class="RefLink">21.4-5</span></a>) appends the list given as second argument to the list given as first argument. Otherwise the function returns an object without changing the arguments, for example <code class="func">Concatenation</code> (<a href="chap21_mj.html#X840C55A77D1BB2E1"><span class="RefLink">21.20-1</span></a>) returns the concatenation of the lists given as arguments.</p>
<p>If the name of a function contains the word "<code class="code">Of</code>" then the return value is thought of as information deduced from the arguments. Usually such functions are attributes (see <a href="chap13_mj.html#X7C701DBF7BAE649A"><span class="RefLink">13.5</span></a>). Examples are <code class="func">GeneratorsOfGroup</code> (<a href="chap39_mj.html#X79C44528864044C5"><span class="RefLink">39.2-4</span></a>), which returns a list of generators for the group entered as argument, or <code class="func">DiagonalOfMat</code> (<a href="chap24_mj.html#X82B6B0298179D895"><span class="RefLink">24.12-1</span></a>).</p>
<p>For the setter and tester functions of an attribute <code class="code">Attr</code> the names <code class="code">SetAttr</code> resp. <code class="code">HasAttr</code> are available (see <a href="chap13_mj.html#X7C701DBF7BAE649A"><span class="RefLink">13.5</span></a>).</p>
<p>If the name of a function contains the word "<code class="code">By</code>" then the return value is thought of as built in a certain way from the parts given as arguments. For example, creating a group as a factor group of a given group by a normal subgroup can be done by taking the image of <code class="func">NaturalHomomorphismByNormalSubgroup</code> (<a href="chap39_mj.html#X80FC390C7F38A13F"><span class="RefLink">39.18-1</span></a>). Other examples of "<code class="code">By</code>" functions are <code class="func">GroupHomomorphismByImages</code> (<a href="chap40_mj.html#X7F348F497C813BE0"><span class="RefLink">40.1-1</span></a>) and <code class="func">LaurentPolynomialByCoefficients</code> (<a href="chap66_mj.html#X8467263B7EFA013E"><span class="RefLink">66.13-1</span></a>).</p>
<p>Often such functions construct an algebraic structure given by its generators (for example, <code class="func">RingByGenerators</code> (<a href="chap56_mj.html#X7D736E027DFD8961"><span class="RefLink">56.1-4</span></a>)). In some cases, "<code class="code">By</code>" may be replaced by "<code class="code">With</code>" (like e.g. <code class="func">GroupWithGenerators</code> (<a href="chap39_mj.html#X8589EF9C7B658B94"><span class="RefLink">39.2-3</span></a>)) or even both versions of the name may be used. The difference between <code class="code">StructByGenerators</code> and <code class="code">StructWithGenerators</code> is that the latter guarantees that the <code class="code">GeneratorsOfStruct</code> value of the result is equal to the given set of generators (see <a href="chap31_mj.html#X82039A218274826F"><span class="RefLink">31.3</span></a>).</p>
<p>If the name of a function has the form "<code class="code">AsSomething</code>" then the return value is an object (usually a collection which has the same family of elements), which may, for example:</p>
<ul>
<li><p>know more about its own structure (and so support more operations) than its input (e.g. if the elements of the collection form a group, then this group can be constructed using <code class="func">AsGroup</code> (<a href="chap39_mj.html#X7A0747F17B50D967"><span class="RefLink">39.2-5</span></a>));</p>
</li>
<li><p>discard its additional structure (e.g. <code class="func">AsList</code> (<a href="chap30_mj.html#X8289FCCC8274C89D"><span class="RefLink">30.3-8</span></a>) applied to a group will return a list of its elements);</p>
</li>
<li><p>contain all elements of the original object without duplicates (like e.g. <code class="func">AsSet</code> (<a href="chap30_mj.html#X856D927378C33548"><span class="RefLink">30.3-10</span></a>) does if its argument is a list of elements from the same family);</p>
</li>
<li><p>remain unchanged (like e.g. <code class="func">AsSemigroup</code> (<a href="chap51_mj.html#X80ED104F85AE5134"><span class="RefLink">51.1-6</span></a>) does if its argument is a group).</p>
</li>
</ul>
<p>If <code class="code">Something</code> and the argument of <code class="code">AsSomething</code> are domains, some further rules apply as explained in <a href="../../doc/tut/chap7_mj.html#X7EA77DE17DD8A231"><span class="RefLink">Tutorial: Changing the Structure</span></a>.</p>
<p>If the name of a function <code class="code">fun1</code> ends with "<code class="code">NC</code>" then there is another function <code class="code">fun2</code> with the same name except that the <code class="code">NC</code> is missing. <code class="code">NC</code> stands for "no check". When <code class="code">fun2</code> is called then it checks whether its arguments are valid, and if so then it calls <code class="code">fun1</code>. The functions <code class="func">SubgroupNC</code> (<a href="chap39_mj.html#X7C82AA387A42DCA0"><span class="RefLink">39.3-1</span></a>) and <code class="func">Subgroup</code> (<a href="chap39_mj.html#X7C82AA387A42DCA0"><span class="RefLink">39.3-1</span></a>) are a typical example.</p>
<p>The idea is that the possibly time consuming check of the arguments can be omitted if one is sure that they are unnecessary. For example, if an algorithm produces generators of the derived subgroup of a group then it is guaranteed that they lie in the original group; <code class="func">Subgroup</code> (<a href="chap39_mj.html#X7C82AA387A42DCA0"><span class="RefLink">39.3-1</span></a>) would check this, and <code class="func">SubgroupNC</code> (<a href="chap39_mj.html#X7C82AA387A42DCA0"><span class="RefLink">39.3-1</span></a>) omits the check.</p>
<p>Needless to say, all these rules are not followed slavishly, for example there is one operation <code class="func">Zero</code> (<a href="chap31_mj.html#X8040AC7A79FFC442"><span class="RefLink">31.10-3</span></a>) instead of two operations <code class="code">ZeroOfElement</code> and <code class="code">ZeroOfAdditiveGroup</code>.</p>
<div class="chlinkprevnextbot"> <a href="chap0_mj.html">[Top of Book]</a> <a href="chap0_mj.html#contents">[Contents]</a> <a href="chap4_mj.html">[Previous Chapter]</a> <a href="chap6_mj.html">[Next Chapter]</a> </div>
<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a> <a href="chap1_mj.html">1</a> <a href="chap2_mj.html">2</a> <a href="chap3_mj.html">3</a> <a href="chap4_mj.html">4</a> <a href="chap5_mj.html">5</a> <a href="chap6_mj.html">6</a> <a href="chap7_mj.html">7</a> <a href="chap8_mj.html">8</a> <a href="chap9_mj.html">9</a> <a href="chap10_mj.html">10</a> <a href="chap11_mj.html">11</a> <a href="chap12_mj.html">12</a> <a href="chap13_mj.html">13</a> <a href="chap14_mj.html">14</a> <a href="chap15_mj.html">15</a> <a href="chap16_mj.html">16</a> <a href="chap17_mj.html">17</a> <a href="chap18_mj.html">18</a> <a href="chap19_mj.html">19</a> <a href="chap20_mj.html">20</a> <a href="chap21_mj.html">21</a> <a href="chap22_mj.html">22</a> <a href="chap23_mj.html">23</a> <a href="chap24_mj.html">24</a> <a href="chap25_mj.html">25</a> <a href="chap26_mj.html">26</a> <a href="chap27_mj.html">27</a> <a href="chap28_mj.html">28</a> <a href="chap29_mj.html">29</a> <a href="chap30_mj.html">30</a> <a href="chap31_mj.html">31</a> <a href="chap32_mj.html">32</a> <a href="chap33_mj.html">33</a> <a href="chap34_mj.html">34</a> <a href="chap35_mj.html">35</a> <a href="chap36_mj.html">36</a> <a href="chap37_mj.html">37</a> <a href="chap38_mj.html">38</a> <a href="chap39_mj.html">39</a> <a href="chap40_mj.html">40</a> <a href="chap41_mj.html">41</a> <a href="chap42_mj.html">42</a> <a href="chap43_mj.html">43</a> <a href="chap44_mj.html">44</a> <a href="chap45_mj.html">45</a> <a href="chap46_mj.html">46</a> <a href="chap47_mj.html">47</a> <a href="chap48_mj.html">48</a> <a href="chap49_mj.html">49</a> <a href="chap50_mj.html">50</a> <a href="chap51_mj.html">51</a> <a href="chap52_mj.html">52</a> <a href="chap53_mj.html">53</a> <a href="chap54_mj.html">54</a> <a href="chap55_mj.html">55</a> <a href="chap56_mj.html">56</a> <a href="chap57_mj.html">57</a> <a href="chap58_mj.html">58</a> <a href="chap59_mj.html">59</a> <a href="chap60_mj.html">60</a> <a href="chap61_mj.html">61</a> <a href="chap62_mj.html">62</a> <a href="chap63_mj.html">63</a> <a href="chap64_mj.html">64</a> <a href="chap65_mj.html">65</a> <a href="chap66_mj.html">66</a> <a href="chap67_mj.html">67</a> <a href="chap68_mj.html">68</a> <a href="chap69_mj.html">69</a> <a href="chap70_mj.html">70</a> <a href="chap71_mj.html">71</a> <a href="chap72_mj.html">72</a> <a href="chap73_mj.html">73</a> <a href="chap74_mj.html">74</a> <a href="chap75_mj.html">75</a> <a href="chap76_mj.html">76</a> <a href="chap77_mj.html">77</a> <a href="chap78_mj.html">78</a> <a href="chap79_mj.html">79</a> <a href="chap80_mj.html">80</a> <a href="chap81_mj.html">81</a> <a href="chap82_mj.html">82</a> <a href="chap83_mj.html">83</a> <a href="chap84_mj.html">84</a> <a href="chap85_mj.html">85</a> <a href="chap86_mj.html">86</a> <a href="chap87_mj.html">87</a> <a href="chapBib_mj.html">Bib</a> <a href="chapInd_mj.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>