next | previous | forward | backward | up | top | index | toc | Macaulay2 web site
SimpleDoc :: simpleDocFrob(ZZ,Matrix)

simpleDocFrob(ZZ,Matrix) -- a sample documentation node

Synopsis

Description

Each paragraph of text begins with "Text". The following line starts a sequence of Macaulay2 example input lines. However, see matrix(List) (missing documentation).

The output in the following example was automatically generated at the time of package installation.

i1 : M = matrix"1,2;3,4";

              2        2
o1 : Matrix ZZ  <--- ZZ
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

The following example was generated by the documentation author.

i1 : 4+
     4

o1 = 8

i1000 = 2+2

o1000 = 4

See docExample for the code used to create this documentation.

Caveat

This is not a particularly useful function.

See also