<?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>simpleDocFrob(ZZ,Matrix) -- A sample documentation node</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div>next | <a href="_simple__Doc__Frob.html">previous</a> | forward | <a href="_simple__Doc__Frob.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>simpleDocFrob(ZZ,Matrix) -- A sample documentation node</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>x = simpleDocFrob(n,M)</tt></div>
</dd></dl>
</div>
</li>
<li><span>Function: <a href="_simple__Doc__Frob.html" title="an example of a function to document">simpleDocFrob</a></span></li>
<li><div class="single">Inputs:<ul><li><span><tt>n</tt>, <span>an <a href="../../Macaulay2Doc/html/___Z__Z.html">integer</a></span>, positive</span></li>
<li><span><tt>M</tt>, <span>a <a href="../../Macaulay2Doc/html/___Matrix.html">matrix</a></span>, which is square</span></li>
</ul>
</div>
</li>
<li><div class="single">Consequences:<ul><li><div>This section is used if the function causes side effects.</div>
</li>
</ul>
</div>
</li>
<li><div class="single">Outputs:<ul><li><span><tt>x</tt>, <span>a <a href="../../Macaulay2Doc/html/___Matrix.html">matrix</a></span>, A block diagonal matrix with <tt>n</tt> copies of <tt>M</tt> along the diagonal</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><div>Each paragraph of text begins with "Text". The following line starts a sequence of Macaulay2 example input lines. However, see <a href="../../Macaulay2Doc/html/_matrix_lp__List_rp.html" title="create a matrix from a doubly-nested list of ring elements or matrices">matrix(List)</a>.</div>
<table class="examples"><tr><td><pre>i1 : M = matrix"1,2;3,4";
2 2
o1 : Matrix ZZ <--- ZZ</pre>
</td></tr>
<tr><td><pre>i2 : simpleDocFrob(3,M)
o2 = | 1 2 0 0 0 0 |
| 3 4 0 0 0 0 |
| 0 0 1 2 0 0 |
| 0 0 3 4 0 0 |
| 0 0 0 0 1 2 |
| 0 0 0 0 3 4 |
6 6
o2 : Matrix ZZ <--- ZZ</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>Caveat</h2>
<div><div>This is not a particularly useful function</div>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="../../Macaulay2Doc/html/_matrix.html" title="make a matrix">matrix</a> -- make a matrix</span></li>
<li><span><a href="../../Macaulay2Doc/html/_direct__Sum.html" title="direct sum of modules or maps">directSum(List)</a> -- direct sum of modules or maps</span></li>
</ul>
</div>
</div>
</body>
</html>
