<?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>String -- the class of all strings</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="___Net.html">next</a> | <a href="_unstack.html">previous</a> | <a href="___Net.html">forward</a> | <a href="_unstack.html">backward</a> | <a href="_strings_spand_spnets.html">up</a> | <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>
<div><a href="index.html" title="">Macaulay2Doc</a> > <a href="___The_sp__Macaulay2_splanguage.html" title="">The Macaulay2 language</a> > <a href="_strings_spand_spnets.html" title="">strings and nets</a> > <a href="___String.html" title="the class of all strings">String</a></div>
<hr/>
<div><h1>String -- the class of all strings</h1>
<div class="single"><h2>Description</h2>
<div><p>A string is thing that contains a sequence of characters (bytes). A string is normally entered as a sequence of characters surrounded by quotation marks.</p>
<table class="examples"><tr><td><pre>i1 : "abcd"
o1 = abcd</pre>
</td></tr>
</table>
<p>Strings involving special characters can be entered by using the backslash as an escape character, see <a href="__dq.html" title="delineate a string with quotation marks">"</a>. For an alternate method of entering strings with fewer escape sequences, see <a href="__sl_sl_sl.html" title="delineate a string with slashes">///</a>.</p>
<p>A net is a two-dimensional array of characters, and strings are regarded as a type of <a href="___Net.html">net</a>.</p>
</div>
</div>
<div class="waystouse"><h2>Functions and methods returning a string :</h2>
<ul><li><span><a href="_ascii_lp__List_rp.html" title="ASCII character conversion">ascii(List)</a> -- ASCII character conversion</span></li>
<li><span>concatenate(BasicList), see <span><a href="_concatenate.html" title="join strings">concatenate</a> -- join strings</span></span></li>
<li><span>concatenate(Nothing), see <span><a href="_concatenate.html" title="join strings">concatenate</a> -- join strings</span></span></li>
<li><span>concatenate(String), see <span><a href="_concatenate.html" title="join strings">concatenate</a> -- join strings</span></span></li>
<li><span>concatenate(Symbol), see <span><a href="_concatenate.html" title="join strings">concatenate</a> -- join strings</span></span></li>
<li><span>concatenate(ZZ), see <span><a href="_concatenate.html" title="join strings">concatenate</a> -- join strings</span></span></li>
<li><span><a href="___Database_sp_sh_sp__String.html" title="get value from database">Database # String</a> -- get value from database</span></li>
<li><span>get(File), see <span><a href="_get.html" title="get the contents of a file">get</a> -- get the contents of a file</span></span></li>
<li><span>get(String), see <span><a href="_get.html" title="get the contents of a file">get</a> -- get the contents of a file</span></span></li>
<li><span>getc(File), see <span><a href="_getc.html" title="get a byte">getc</a> -- get a byte</span></span></li>
<li><span>getenv(String), see <span><a href="_getenv.html" title="get value of environment variable">getenv</a> -- get value of environment variable</span></span></li>
<li><span><a href="_html.html" title="convert hypertext to html format">html</a> -- convert hypertext to html format</span></li>
<li><span><a href="_info.html" title="convert hypertext to info format">info</a> -- convert hypertext to info format</span></li>
<li><span><a href="_math__M__L.html" title="convert to MathML format">mathML</a> -- convert to MathML format</span></li>
<li><span>String | String, see <span><a href="___Net_sp_vb_sp__Net.html" title="join strings or nets">Net | Net</a> -- join strings or nets</span></span></li>
<li><span>String | ZZ, see <span><a href="___Net_sp_vb_sp__Net.html" title="join strings or nets">Net | Net</a> -- join strings or nets</span></span></li>
<li><span>ZZ | String, see <span><a href="___Net_sp_vb_sp__Net.html" title="join strings or nets">Net | Net</a> -- join strings or nets</span></span></li>
<li><span>pad(String,ZZ), see <span><a href="_pad.html" title="pad a string with spaces">pad</a> -- pad a string with spaces</span></span></li>
<li><span>pad(ZZ,String), see <span><a href="_pad.html" title="pad a string with spaces">pad</a> -- pad a string with spaces</span></span></li>
<li><span><a href="_read_lp__File_rp.html" title="read from a file">read(File)</a> -- read from a file</span></li>
<li><span><a href="_read_lp__File_cm__Z__Z_rp.html" title="read from a file">read(File,ZZ)</a> -- read from a file</span></li>
<li><span><a href="_read_lp__Sequence_rp.html" title="read from a file">read(Sequence)</a> -- read from a file</span></li>
<li><span><a href="_read_lp__String_rp.html" title="read from a file">read(String)</a> -- read from a file</span></li>
<li><span><a href="_replace_lp__String_cm__String_cm__String_rp.html" title="regular expression replacement of substrings">replace(String,String,String)</a> -- regular expression replacement of substrings</span></li>
<li><span><a href="___String_sp_us_sp__Sequence.html" title="substring">String _ Sequence</a> -- substring</span></li>
<li><span><a href="___String_sp_us_sp__Z__Z.html" title="get element from string">String _ ZZ</a> -- get element from string</span></li>
<li><span>substring(Sequence,String), see <span><a href="_substring.html" title="extract part of a string">substring</a> -- extract part of a string</span></span></li>
<li><span>substring(String,ZZ), see <span><a href="_substring.html" title="extract part of a string">substring</a> -- extract part of a string</span></span></li>
<li><span>substring(String,ZZ,ZZ), see <span><a href="_substring.html" title="extract part of a string">substring</a> -- extract part of a string</span></span></li>
<li><span>substring(ZZ,String), see <span><a href="_substring.html" title="extract part of a string">substring</a> -- extract part of a string</span></span></li>
<li><span>substring(ZZ,ZZ,String), see <span><a href="_substring.html" title="extract part of a string">substring</a> -- extract part of a string</span></span></li>
<li><span><a href="_tex.html" title="convert to TeX format">tex</a> -- convert to TeX format</span></li>
<li><span><a href="_tex__Math.html" title="convert to TeX math format">texMath</a> -- convert to TeX math format</span></li>
<li><span><a href="_to__External__String.html" title="convert to a readable string">toExternalString</a> -- convert to a readable string</span></li>
<li><span><a href="_to__String.html" title="convert to a string">toString</a> -- convert to a string</span></li>
</ul>
<h2>Methods that use a string :</h2>
<ul><li><span><a href="__sh_sp__String.html" title="length"># String</a> -- length</span></li>
<li><span>Net == String, see <span><a href="__eq_eq.html" title="equality">==</a> -- equality</span></span></li>
<li><span>String == Net, see <span><a href="__eq_eq.html" title="equality">==</a> -- equality</span></span></li>
<li><span>String == String, see <span><a href="__eq_eq.html" title="equality">==</a> -- equality</span></span></li>
<li><span><a href="_apropos_lp__String_rp.html" title="symbols matching a pattern">apropos(String)</a> -- symbols matching a pattern</span></li>
<li><span><a href="_ascii_lp__String_rp.html" title="ASCII character conversion">ascii(String)</a> -- ASCII character conversion</span></li>
<li><span><a href="_autoload_lp__Symbol_cm__String_rp.html" title="arrange for a function to be loaded automatically">autoload(Symbol,String)</a> -- arrange for a function to be loaded automatically</span></li>
<li><span><a href="_capture_lp__String_rp.html" title="evaluate Macaulay2 code and capture the output (under development)">capture(String)</a> -- evaluate Macaulay2 code and capture the output (under development)</span></li>
<li><span>characters(String), see <span><a href="_characters.html" title="get characters from a string">characters</a> -- get characters from a string</span></span></li>
<li><span>check(String), see <span><a href="_check.html" title="perform tests of a package">check</a> -- perform tests of a package</span></span></li>
<li><span>check(ZZ,String), see <span><a href="_check.html" title="perform tests of a package">check</a> -- perform tests of a package</span></span></li>
<li><span><a href="_copy__Directory_lp__String_cm__String_rp.html" title="">copyDirectory(String,String)</a></span></li>
<li><span><a href="_copy__File_lp__String_cm__String_rp.html" title="">copyFile(String,String)</a></span></li>
<li><span><a href="___Database_sp_sh_qu_sp__String.html" title="check for value in database">Database #? String</a> -- check for value in database</span></li>
<li><span>depth(String), see <span><a href="_depth.html" title="depth of a net">depth</a> -- depth of a net</span></span></li>
<li><span>dismiss(String), see <span><a href="_dismiss.html" title="dismiss a package">dismiss</a> -- dismiss a package</span></span></li>
<li><span><a href="../../SimpleDoc/html/_doc_lp__String_rp.html" title="a simple documentation function">doc(String)</a> -- a simple documentation function</span></li>
<li><span><a href="_end__Package_lp__String_rp.html" title="end a new package">endPackage(String)</a> -- end a new package</span></li>
<li><span>EXAMPLE(String), see <span><a href="___E__X__A__M__P__L__E.html" title="hypertext EXAMPLE item">EXAMPLE</a> -- hypertext EXAMPLE item</span></span></li>
<li><span>export(String), see <span><a href="_export.html" title="package item: export functions">export</a> -- package item: export functions</span></span></li>
<li><span>File << String, see <span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></span></li>
<li><span>String << Thing, see <span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></span></li>
<li><span><a href="_file__Mode_lp__String_rp.html" title="get file mode">fileMode(String)</a> -- get file mode</span></li>
<li><span><a href="_file__Mode_lp__Z__Z_cm__String_rp.html" title="set file mode">fileMode(ZZ,String)</a> -- set file mode</span></li>
<li><span>findFiles(String), see <span><a href="_find__Files.html" title="find files recursively">findFiles</a> -- find files recursively</span></span></li>
<li><span>generateAssertions(String), see <span><a href="_generate__Assertions.html" title="generate assert statements from experimental input">generateAssertions</a> -- generate assert statements from experimental input</span></span></li>
<li><span><a href="_get__Package_lp__String_rp.html" title="download a package from the repository">getPackage(String)</a> -- download a package from the repository</span></li>
<li><span>getWWW(String), see <span><a href="_get__W__W__W.html" title="get a web page">getWWW</a> -- get a web page</span></span></li>
<li><span>getWWW(String,Nothing), see <span><a href="_get__W__W__W.html" title="get a web page">getWWW</a> -- get a web page</span></span></li>
<li><span>getWWW(String,String), see <span><a href="_get__W__W__W.html" title="get a web page">getWWW</a> -- get a web page</span></span></li>
<li><span>height(String), see <span><a href="_height.html" title="height of a net">height</a> -- height of a net</span></span></li>
<li><span>help(String), see <span><a href="_help.html" title="help command">help</a> -- help command</span></span></li>
<li><span><a href="_http__Headers_lp__String_rp.html" title="prepend http headers to a string">httpHeaders(String)</a> -- prepend http headers to a string</span></li>
<li><span><a href="../../Classic/html/_ideal_lp__String_rp.html" title="make an ideal using classic Macaulay syntax">ideal(String)</a> -- make an ideal using classic Macaulay syntax</span></li>
<li><span>installPackage(String), see <span><a href="_install__Package.html" title="load and install a package and its documentation ">installPackage</a> -- load and install a package and its documentation </span></span></li>
<li><span><a href="_length_lp__String_rp.html" title="length of a string">length(String)</a> -- length of a string</span></li>
<li><span>lines(String), see <span><a href="_lines.html" title="split a string into lines">lines</a> -- split a string into lines</span></span></li>
<li><span>lines(String,String), see <span><a href="_lines.html" title="split a string into lines">lines</a> -- split a string into lines</span></span></li>
<li><span><a href="_link__File_lp__String_cm__String_rp.html" title="make a new link to a file">linkFile(String,String)</a> -- make a new link to a file</span></li>
<li><span>loadPackage(String), see <span><a href="_load__Package.html" title="load a package">loadPackage</a> -- load a package</span></span></li>
<li><span><a href="_make__Directory_lp__String_rp.html" title="make a directory">makeDirectory(String)</a> -- make a directory</span></li>
<li><span>makeDocumentTag(String), see <span><a href="_make__Document__Tag.html" title="convert a documentation key to a documentation tag">makeDocumentTag</a> -- convert a documentation key to a documentation tag</span></span></li>
<li><span><a href="_match_lp__String_cm__String_rp.html" title="regular expression matching">match(String,String)</a> -- regular expression matching</span></li>
<li><span><a href="../../Classic/html/_matrix_lp__String_rp.html" title="make a matrix using classic Macaulay syntax">matrix(String)</a> -- make a matrix using classic Macaulay syntax</span></li>
<li><span><a href="../../Classic/html/_monomial__Ideal_lp__String_rp.html" title="make a monomial ideal using classic Macaulay syntax">monomialIdeal(String)</a> -- make a monomial ideal using classic Macaulay syntax</span></li>
<li><span>moveFile(String), see <span><a href="_move__File_lp__String_cm__String_rp.html" title="">moveFile(String,String)</a></span></span></li>
<li><span><a href="_move__File_lp__String_cm__String_rp.html" title="">moveFile(String,String)</a></span></li>
<li><span>needsPackage(String), see <span><a href="_needs__Package.html" title="load a package if not already loaded">needsPackage</a> -- load a package if not already loaded</span></span></li>
<li><span>String ^ ZZ, see <span><a href="___Net_sp^_sp__Z__Z.html" title="raise a net or string">Net ^ ZZ</a> -- raise a net or string</span></span></li>
<li><span><a href="_net_lp__String_rp.html" title="convert a string to a net">net(String)</a> -- convert a string to a net</span></li>
<li><span>NetFile << String, see <span><a href="___Net__File.html" title="the class of all net files">NetFile</a> -- the class of all net files</span></span></li>
<li><span><a href="_new__Package_lp__String_rp.html" title="package item: start a new package">newPackage(String)</a> -- package item: start a new package</span></li>
<li><span>openDatabase(String), see <span><a href="_open__Database.html" title="open a database file">openDatabase</a> -- open a database file</span></span></li>
<li><span>openDatabaseOut(String), see <span><a href="_open__Database__Out.html" title="open a database file for writing">openDatabaseOut</a> -- open a database file for writing</span></span></li>
<li><span><a href="_open__In_lp__String_rp.html" title="open an output file">openIn(String)</a> -- open an output file</span></li>
<li><span>openInOut(String), see <span><a href="_open__In__Out.html" title="open an input output file">openInOut</a> -- open an input output file</span></span></li>
<li><span><a href="_open__Listener_lp__String_rp.html" title="open a port for listening">openListener(String)</a> -- open a port for listening</span></li>
<li><span><a href="_open__Out_lp__String_rp.html" title="open an output file">openOut(String)</a> -- open an output file</span></li>
<li><span><a href="_open__Out__Append_lp__String_rp.html" title="open an output file for appending">openOutAppend(String)</a> -- open an output file for appending</span></li>
<li><span>packageTemplate(String), see <span><a href="../../SimpleDoc/html/_package__Template.html" title="a template for a package">packageTemplate</a> -- a template for a package</span></span></li>
<li><span><a href="../../Classic/html/_poly_lp__String_rp.html" title="make a polynomial using classic Macaulay syntax">poly(String)</a> -- make a polynomial using classic Macaulay syntax</span></li>
<li><span>profile(String,Function), see <span><a href="_profile.html" title="profile a function">profile</a> -- profile a function</span></span></li>
<li><span>regex(String,String), see <span><a href="_regex.html" title="">regex</a></span></span></li>
<li><span>regex(String,ZZ,String), see <span><a href="_regex.html" title="">regex</a></span></span></li>
<li><span>regex(String,ZZ,ZZ,String), see <span><a href="_regex.html" title="">regex</a></span></span></li>
<li><span><a href="___Ring_sp_us_sp__String.html" title="get a ring variable by name">Ring _ String</a> -- get a ring variable by name</span></li>
<li><span>scanLines(Function,String), see <span><a href="_scan__Lines.html" title="apply a function to each line of a file">scanLines</a> -- apply a function to each line of a file</span></span></li>
<li><span><a href="_search__Path_lp__List_cm__String_rp.html" title="search a path for a file">searchPath(List,String)</a> -- search a path for a file</span></li>
<li><span>searchPath(String), see <span><a href="_search__Path_lp__List_cm__String_rp.html" title="search a path for a file">searchPath(List,String)</a> -- search a path for a file</span></span></li>
<li><span><a href="_select_lp__String_cm__String_rp.html" title="select substrings matching a regular expression from a string">select(String,String)</a> -- select substrings matching a regular expression from a string</span></li>
<li><span><a href="_select_lp__String_cm__String_cm__String_rp.html" title="select substrings matching a regular expression from a string">select(String,String,String)</a> -- select substrings matching a regular expression from a string</span></li>
<li><span>separate(String), see <span><a href="_separate.html" title="split a string into pieces">separate</a> -- split a string into pieces</span></span></li>
<li><span>separate(String,String), see <span><a href="_separate.html" title="split a string into pieces">separate</a> -- split a string into pieces</span></span></li>
<li><span><a href="_separate__Regexp_lp__String_cm__String_rp.html" title="separate a string into pieces, with separators determined by a regular expression">separateRegexp(String,String)</a> -- separate a string into pieces, with separators determined by a regular expression</span></li>
<li><span><a href="_separate__Regexp_lp__String_cm__Z__Z_cm__String_rp.html" title="separate a string into pieces, with separators determined by a regular expression">separateRegexp(String,ZZ,String)</a> -- separate a string into pieces, with separators determined by a regular expression</span></li>
<li><span><a href="_set__Random__Seed_lp__String_rp.html" title="set starting point for random number generator">setRandomSeed(String)</a> -- set starting point for random number generator</span></li>
<li><span><a href="___String_sp_sh_sp__Z__Z.html" title="get character from string">String # ZZ</a> -- get character from string</span></li>
<li><span><a href="___String_sp_sh_qu_sp__Z__Z.html" title="check for character in string">String #? ZZ</a> -- check for character in string</span></li>
<li><span><a href="___String_sp.._sp__String.html" title="a sequence of consecutive strings">String .. String</a> -- a sequence of consecutive strings</span></li>
<li><span><a href="___String_sp.._lt_sp__String.html" title="a sequence of consecutive strings, not including the endpoint">String ..< String</a> -- a sequence of consecutive strings, not including the endpoint</span></li>
<li><span><a href="___String_sp^_sp__Sequence.html" title="vertically stacked copies of a string">String ^ Sequence</a> -- vertically stacked copies of a string</span></li>
<li><span><a href="_symlink__Directory_lp__String_cm__String_rp.html" title="make symbolic links for all files in a directory tree">symlinkDirectory(String,String)</a> -- make symbolic links for all files in a directory tree</span></li>
<li><span>TEST(String), see <span><a href="___T__E__S__T.html" title="package item: register a test of the package">TEST</a> -- package item: register a test of the package</span></span></li>
<li><span><a href="_uninstall__Package_lp__String_rp.html" title="uninstall a package">uninstallPackage(String)</a> -- uninstall a package</span></li>
<li><span>new URL from String, see <span><a href="___U__R__L.html" title="a type representing a URL">URL</a> -- a type representing a URL</span></span></li>
<li><span><a href="_value_lp__String_rp.html" title="evaluate a string">value(String)</a> -- evaluate a string</span></li>
<li><span>width(String), see <span><a href="_width_lp__Net_rp.html" title="width of a net">width(Net)</a> -- width of a net</span></span></li>
<li><span><a href="___Wikipedia_lp__String_rp.html" title="link to a Wikipedia entry">Wikipedia(String)</a> -- link to a Wikipedia entry</span></li>
</ul>
<h2>Fixed objects of class String :</h2>
<ul><li><span><a href="_copyright.html" title="a string containing the copyright notice for Macaulay2">copyright</a> -- a string containing the copyright notice for Macaulay2</span></li>
<li><span><a href="_current__File__Directory.html" title="the directory containing the current input file">currentFileDirectory</a> -- the directory containing the current input file</span></li>
<li><span><a href="_current__File__Name.html" title="the current source file">currentFileName</a> -- the current source file</span></li>
<li><span><a href="../../SimpleDoc/html/_doc__Example.html" title="an example documentation node">docExample</a> -- an example documentation node</span></li>
<li><span><a href="../../SimpleDoc/html/_doc__Template.html" title="a template for a documentation node">docTemplate</a> -- a template for a documentation node</span></li>
<li><span><a href="_newline.html" title="the new line character sequence">newline</a> -- the new line character sequence</span></li>
<li><span><a href="_root__Path.html" title="">rootPath</a></span></li>
<li><span><a href="_root__U__R__I.html" title="">rootURI</a></span></li>
<li><span>currentString, see <span><a href="_value_lp__String_rp.html" title="evaluate a string">value(String)</a> -- evaluate a string</span></span></li>
</ul>
</div>
<div class="waystouse"><h2>For the programmer</h2>
<p>The object <a href="___String.html" title="the class of all strings">String</a> is <span>a <a href="___Type.html">type</a></span>, with ancestor classes <a href="___Net.html" title="the class of all nets and strings">Net</a> < <a href="___Thing.html" title="the class of all things">Thing</a>.</p>
</div>
</div>
</body>
</html>
