File: isGlobalSymbol-doc.m2

package info (click to toggle)
macaulay2 1.17.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 68,376 kB
  • sloc: cpp: 102,995; ansic: 10,040; javascript: 6,019; sh: 3,506; makefile: 3,426; lisp: 727; yacc: 590; perl: 369; xml: 177; python: 141; lex: 65; awk: 3
file content (17 lines) | stat: -rw-r--r-- 597 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => isGlobalSymbol,
     Headline => "whether a global symbol with a given name exists",
     Usage => "isGlobalSymbol s",
     Inputs => { "s" => String },
     Outputs => { Boolean => "whether a global symbol with the name contained in the string ", TT "s", " has been defined" },
     "The search for the symbol runs through the dictionaries in the list ", TO "dictionaryPath", ".",
     EXAMPLE lines ///
	  isGlobalSymbol "res"
	  isGlobalSymbol "resres"
     ///,
     SeeAlso => { "dictionaryPath", getGlobalSymbol }
     }