String -- the class of all strings

Description

A string is thing which contains a sequence of characters (bytes). A string is normally entered as a sequence of characters surrounded by quotation marks.

i1 : "abcd"

o1 = abcd

For an alternate method of entering strings which does not involve any escape sequences, see ///.

A net is a two-dimensional array of characters, and strings are regarded as a type of net. See Net.

Functions and methods returning a string :

ascii(List) -- ASCII character conversion
concatenate(BasicList), see concatenate -- join strings
concatenate(Nothing), see concatenate -- join strings
concatenate(String), see concatenate -- join strings
concatenate(Symbol), see concatenate -- join strings
concatenate(ZZ), see concatenate -- join strings
Database # String -- get value from database
get(File), see get -- get the contents of a file
get(String), see get -- get the contents of a file
getc(File), see getc -- get a byte
getenv(String), see getenv -- get value of environment variable
html -- convert hypertext to html format
info -- convert hypertext to info format
mathML -- convert to MathML format
String | String, see Net | Net -- join strings or nets
String | ZZ, see Net | Net -- join strings or nets
ZZ | String, see Net | Net -- join strings or nets
pad(String,ZZ), see pad -- pad a string with spaces
pad(ZZ,String), see pad -- pad a string with spaces
read(File) -- read from a file
read(File,ZZ) -- read from a file
read(Sequence) -- read from a file
read(String) -- read from a file
replace(String,String,String) -- regular expression replacement
String _ Sequence -- substring
String _ ZZ -- get element from string
substring(String,ZZ), see substring -- extract part of a string
substring(String,ZZ,ZZ), see substring -- extract part of a string
substring(ZZ,String), see substring -- extract part of a string
substring(ZZ,ZZ,String), see substring -- extract part of a string
tex -- convert to TeX format
texMath -- convert to TeX math format
toExternalString -- convert to a readable string
toString -- convert to a string

Methods that use a string :

# String -- length
Parser @ String, see andP -- parser conjunction
String @ Parser, see andP -- parser conjunction
apropos(String) -- symbols matching a pattern
ascii(String) -- ASCII character conversion
autoload(Symbol,String) -- arrange for a function to be loaded automatically
capture(String) -- evaluate Macaulay 2 code and capture the output (under development)
characters(String), see characters -- get characters from a string
copyDirectory(String,String)
copyFile(String,String)
Database #? String -- check for value in database
depth(String), see depth -- depth of a net
dismiss(String), see dismiss -- dismiss a package
endPackage(String) -- end a new package
EXAMPLE(String), see EXAMPLE -- hypertext EXAMPLE item
String << Thing, see File << Thing -- print to a file
fileMode(String) -- get file mode
fileMode(ZZ,String) -- set file mode
findFiles(String) -- find files recursively
generateAssertions(String), see generateAssertions -- generate assert statements from experimental input
getWWW(String), see getWWW -- get a web page
getWWW(String,Nothing), see getWWW -- get a web page
getWWW(String,String), see getWWW -- get a web page
height(String), see height -- height of a net
ideal(String) -- make an ideal using classic Macaulay syntax
installPackage(String), see installPackage -- load and install a package and its documentation
length(String) -- length of a string
lines(String), see lines -- split a string into lines
lines(String,String), see lines -- split a string into lines
linkFile(String,String) -- make a new link to a file
loadPackage(String), see loadPackage -- load a package
makeDirectory(String) -- make a directory
makeDocumentTag(String), see makeDocumentTag -- convert a documentation key to a documentation tag
MarkUpType String -- missing documentation
match(String,String) -- regular expression matching
matrix(String) -- make a matrix using classic Macaulay syntax
monomialIdeal(String) -- make a monomial ideal using classic Macaulay syntax
moveFile(String,String)
needsPackage(String), see needsPackage -- load a package if not already loaded
String ^ ZZ, see Net ^ ZZ -- raise a net or string
net(String) -- convert a string to a net
NetFile << String, see NetFile -- the class of all net files
new Command from String -- missing documentation
newPackage(String) -- package item: start a new package
openDatabase(String), see openDatabase -- open a database file
openDatabaseOut(String), see openDatabaseOut -- open a database file for writing
openIn(String), see openIn -- open an input file
openInOut(String), see openInOut -- open an input output file
openListener(String), see openListener -- open a port for listening
openOut(String), see openOut -- open an output file
Parser | String, see orP -- parsing alternatives
String | Parser, see orP -- parsing alternatives
poly(String) -- make a polynomial using classic Macaulay syntax
profile(String,Function), see profile -- profile a function
regex(String,String) -- regular expression matching
regex(String,ZZ,String) -- regular expression matching
Ring _ String -- get a ring variable by name
searchPath(List,String) -- search a path for a file
searchPath(String) -- missing documentation
select(String,String) -- select substrings matching a regular expression from a string
select(String,String,String) -- select substrings matching a regular expression from a string
separate(String), see separate -- split a string into pieces
separate(String,String), see separate -- split a string into pieces
separateRegexp(String,String) -- separate a string into pieces, with separators determined by a regular expression
separateRegexp(String,ZZ,String) -- separate a string into pieces, with separators determined by a regular expression
setRandomSeed(String) -- set starting point for random number generator
String # ZZ -- get character from string
String #? ZZ -- check for character in string
String ^ Sequence -- vertically stacked copies of a string
symlinkDirectory(String,String) -- make symbolic links for all files in a directory tree
TEST(String), see TEST -- package item: register a test of the package
uninstallPackage(String), see uninstallPackage -- uninstall a package
new URL from String, see URL -- a type representing a URL
value(String) -- evaluate a string
width(String), see width(Net) -- width of a net

Fixed objects of class String :

copyright -- a string containing the copyright notice for Macaulay 2
currentDirectory -- current working directory
currentFileDirectory -- the directory containing the current input file
currentFileName -- the current source file
newline -- the new line character sequence
currentString, see value(String) -- evaluate a string

For the programmer

The object String is a type, with ancestor classes Net < Thing.