<?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>ofClass -- English phrases for types</title> <link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/> </head> <body> <table class="buttons"> <tr> <td><div><a href="_on.html">next</a> | <a href="_of.html">previous</a> | <a href="_on.html">forward</a> | <a href="_of.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>ofClass -- English phrases for types</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>ofClass T</tt></div> </dd></dl> </div> </li> <li><div class="single">Inputs:<ul><li><span><tt>T</tt>, <span>a <a href="___Type.html">type</a></span>, <span>an <a href="___Immutable__Type.html">immutable type</a></span>, or <span>a <a href="___List.html">list</a></span> of types</span></li> </ul> </div> </li> <li><div class="single">Outputs:<ul><li><span><span>a <a href="___Sequence.html">sequence</a></span>, an English phrase in hypertext, using a synonym for each type, together with appropriate indefinite articles, and, if a list is presented, the word <em>or</em> as a conjunction at the end</span></li> </ul> </div> </li> </ul> </div> <div class="single"><h2>Description</h2> <div><p>When viewed in html, words in the phrase hot link(s) to the documentation node(s) for the class(es).</p> <table class="examples"><tr><td><pre>i1 : ofClass class 3 o1 = an integer o1 : SPAN</pre> </td></tr> <tr><td><pre>i2 : peek oo o2 = SPAN{"an ", TO2{Macaulay2Doc :: ZZ, "integer"}}</pre> </td></tr> <tr><td><pre>i3 : ofClass Ring o3 = a ring o3 : SPAN</pre> </td></tr> <tr><td><pre>i4 : needsPackage "Text" o4 = Text o4 : Package</pre> </td></tr> <tr><td><pre>i5 : SPAN ofClass {HashTable, ProjectiveVariety} o5 = a hash table or a projective variety o5 : SPAN</pre> </td></tr> <tr><td><pre>i6 : document { Key => foo, "We may need ", ofClass ZZ, " and ", ofClass HashTable, "." }</pre> </td></tr> <tr><td><pre>i7 : help foo --loading the Macaulay2 documentation from /builddir/build/BUILD/Macaulay2-1.3.1-r10737/Macaulay2/packages/Macaulay2Doc/ o7 = foo *** Description =========== We may need an integer and a hash table. For the programmer ================== The object "foo" is a symbol. o7 : DIV</pre> </td></tr> </table> </div> </div> <div class="waystouse"><h2>Ways to use <tt>ofClass</tt> :</h2> <ul><li>ofClass(ImmutableType)</li> <li>ofClass(List)</li> <li>ofClass(Type)</li> </ul> </div> </div> </body> </html>