Macaulay2Doc : Table of Contents
- Macaulay2Doc
- Copyright and license
- Acknowledgements
- The authors
- Other sources of information about Macaulay 2
- getting started
- rings
- ideals
- matrices
- substitution and maps between rings
- modules
- chain complexes
- varieties
- Groebner bases
- normal forms
- elimination of variables
- primaryDecomposition -- irredundant primary decomposition of an ideal
- combinatorial functions
- The Macaulay2 language
- variables
- numeric types
- strings and nets
- lists and sequences
- hash tables
- operators
- = -- assignment
- := -- assignment of method or new local variable
- <- -- assignment with left side evaluated
- == -- equality
- != -- inequality
- === -- strict equality
- =!= -- strict inequality
- < -- less than
- <= -- less than or equal
- > -- greater than
- >= -- greater than or equal
- ? -- comparison operator
- and -- conjunction
- or -- disjunction
- not -- negation
- SPACE -- blank operator; often used for function application, making polynomial rings
- -> -- make a function
- @@ -- a binary operator
- \\ -- a binary operator
- \ -- a binary operator
- _ -- a binary operator, used for subscripting and access to elements
- . -- access to elements whose key is a symbol
- .? -- check for presence of elements whose key is a symbol
- # -- length, or access to elements
- #? -- check for presence of elements
- ! -- factorial
- + -- a unary or binary operator, usually used for addition
- - -- a unary or binary operator, usually used for negation or subtraction
- * -- a binary operator, usually used for multiplication
- / -- a binary operator, usually used for division
- // -- a binary operator, usually used for quotient
- % -- a binary operator, usually used for remainder and reduction
- ^ -- a binary operator, usually used for powers
- & -- a binary operator
- ++ -- a binary operator, usually used for direct sum
- ** -- a binary operator, usually used for tensor product or Cartesian product
- ^** -- a binary operator, usually used for tensor or Cartesian power
- ~ -- a unary postfix operator
- (*) -- a unary postfix operator, used for indicating a graded object
- : -- a binary operator, uses include repetition; ideal quotients
- .. -- a binary operator, uses include ranges; sequence of consecutive items
- << -- a binary operator (file output, ...)
- >> -- a binary operator, uses include bit shifting, or attaching optional inputs to functions
- | -- a binary operator, often used for horizontal concatenation
- || -- a binary operator, often used for vertical concatenation
- @ -- a binary operator
- ^^ -- a binary operator
- |- -- a binary operator
- <==> -- a binary operator
- ===> -- a binary operator
- ==> -- a binary operator
- => -- produce an Option
- , -- the comma, used for separating entries in a list or sequence
- ; -- statement separator
- precedence of operators
- operatorAttributes
- conditional execution -- if-then-else statements
- while -- while loops
- for -- for loops
- mapping over lists -- apply a function to each element of a list
- mapping over hash tables -- apply a function to each element of a hash table
- error handling -- signalling and trapping errors
- error -- deliver error message
- try -- catch an error
- catch -- catch a thrown exception
- using functions
- using functions with optional inputs
- making functions
- local variables in a function
- making functions with a variable number of arguments
- making functions with multiple return values
- making new functions with optional arguments
- what a class is
- installing methods
- binary methods
- inheritance
- making new classes
- new -- new objects and new types
- newClass -- set the class and parent of an object
- printing and formatting for new classes
- making a new method function
- method -- make a new method function
- printing to the screen
- reading files
- getting input from the user
- creating and writing files
- saving polynomials and matrices in files
- two dimensional formatting
- file manipulation -- Unix file manipulation functions
- communicating with programs
- using sockets
- packages
- system facilities
- debugging
- packages provided with Macaulay 2
- handling hypertext
- mathematical examples
- basic commutative algebra
- replacements for commands and scripts from Macaulay
- how Macaulay 2 finds its files
- Type -- the class of all types
- Function -- the class of all functions
- # HashTable -- length
- # Set -- cardinality
- # String -- length
- - List -- negation of a vector
- -- -- comment
- > ZZ -- greater than
- >= ZZ -- greater than or equal
- ^* -- a unary postfix operator, used for indicating pullback maps
- _* -- a unary postfix operator, used for indicating pushforward maps
- abs -- absolute value function
- AbsoluteLinks -- name for an optional argument
- accumulate -- apply binary operator repeatedly
- accumulate(Function,Thing,VisibleList)
- accumulate(Function,VisibleList)
- accumulate(VisibleList,Function)
- accumulate(VisibleList,Thing,Function)
- acos -- arccosine
- acosh -- inverse hyperbolic cosine
- acot -- compute the inverse cotangent
- addHook -- add a hook function to an object for later processing
- addHook(HashTable,Thing,Function) -- add a hook function to an object for later processing
- addHook(Symbol,Function) -- add a hook function to an object for later processing
- Adjacent -- the class of all adjacent expression pairs
- adjoint(Matrix,Module,Module) -- an adjoint map
- adjoint1(Matrix,Module,Module) -- an adjoint map
- AffineVariety -- the class of all affine varieties
- AfterEval -- top level method applied after evaluation
- AfterNoPrint -- top level method applied after not printing
- AfterPrint -- top level method applied after printing
- agm -- arithmetic-geometric mean
- Algorithm -- name for an optional argument
- Alignment -- name for an optional argument
- all -- whether all elements satisfy a specified condition
- all(BasicList,BasicList,Function) -- whether all corresponding elements of a pair of lists satisfy a condition
- all(HashTable,Function) -- whether all key/value pairs in a hash table satisfy a specified condition
- ambient -- ambient free module of a subquotient, or ambient ring
- ambient(AffineVariety)
- ambient(CoherentSheaf)
- ambient(GaloisField) -- corresponding quotient ring
- ambient(GradedModule)
- ambient(Matrix)
- ambient(Module) -- ambient free module
- ambient(ProjectiveVariety)
- ambient(Ring) -- ambient polynomial ring
- ancestors -- the ancestors of something
- ANCHOR -- hypertext anchor
- annihilator -- the annihilator ideal
- annihilator of a module
- any -- whether any elements satisfy a specified condition
- any(BasicList,BasicList,Function) -- whether any corresponding elements of a pair of lists satisfy a condition
- any(HashTable,Function) -- whether all key/value pairs in a hash table satisfy a specified condition
- append(BasicList,Thing) -- append an element to a list
- applicationDirectory -- the path to the user's application directory
- applicationDirectorySuffix -- suffix that determines the user's application directory
- apply -- apply a function to each element
- apply(BasicList,BasicList,Function) -- apply a function to pairs of elements, one from each list
- apply(ZZ,Function) -- apply a function to {0,..., n-1}
- applyTable -- apply a function to elements of a table
- apropos(String) -- symbols matching a pattern
- argument -- specify the function in a scripted functor for an argument
- Ascending
- ascii -- ASCII character conversion
- ascii(List) -- ASCII character conversion
- ascii(String) -- ASCII character conversion
- asin -- arcsine
- asinh -- inverse hyperbolic sine
- assert -- assert something is true
- associatedPrimes -- find the associated primes of an ideal
- AssociativeExpression -- the class of associative expressions
- atan -- compute the arctangent
- atan(RR) -- compute the arctangent of a number
- atan2(RR,RR) -- compute an angle of a certain triangle
- atEndOfFile(File) -- test for end of file
- backtrace -- whether a backtrace is displayed following an error message
- backupFileRegexp -- a regular expression for recognizing names of backup files
- Bag -- the class of all bags
- Bareiss
- baseFilename -- the base part of a filename or path
- baseName -- the base name of a generator
- baseRings -- store the list of base rings of a ring
- BaseRow -- name for an optional argument
- BasisElementLimit -- stop when this number of basis elements is obtained
- Bayer -- a Strategy option value for saturate
- BeforePrint -- top level method applied before printing results
- benchmark -- accurate timing of execution
- BesselJ -- Bessel function of the first kind
- BesselY -- Bessel function of the second kind
- betti -- display degrees
- betti(..., Weights => ...)
- betti(BettiTally) -- view and set the weights of a betti display
- betti(ChainComplex) -- display of degrees in a chain complex
- betti(GroebnerBasis) -- diagram of the degrees of a groebner basis
- betti(Ideal) -- gives the degrees of generators.
- betti(Matrix) -- display of the degrees of a map
- betti(Module) -- show the degrees of the generators and relations of a module or a coherent sheaf
- BettiTally -- the class of all Betti tallies
- between(Thing,VisibleList) -- insert something between elements of a list
- BinaryOperation -- the class of all binary operation expressions
- Binomial -- name for an optional argument
- binomial -- binomial coefficient
- BLOCKQUOTE -- hypertext BLOCKQUOTE item
- BODY -- hypertext BODY item
- BOLD -- hypertext BOLD item
- Boolean -- the class of Boolean values
- borel(Matrix) -- make a Borel fixed submodule
- Boxes -- name for an optional argument
- BR -- line break
- break -- break from a loop
- cache -- a key under which to store cache tables
- CacheFunction -- the class of cache functions
- CacheTable -- hash tables for caching
- cacheValue -- cache values of functions in their arguments
- capture(String) -- evaluate Macaulay 2 code and capture the output (under development)
- CC -- the class of all complex numbers
- CDATA -- hypertext CDATA element
- ceiling -- ceiling function
- Center -- value for an optional argument
- centerString -- center a string or net
- ChainComplex -- the class of all chain complexes
- chainComplex -- make a chain complex
- ChainComplex ** ChainComplex -- tensor product
- ChainComplex ** ChainComplexMap -- tensor product
- ChainComplex ** GradedModule -- tensor product
- ChainComplex ++ ChainComplex -- direct sum
- ChainComplex ^ ZZ -- access member, cohomological degree
- ChainComplex _ ZZ -- component
- ChainComplex _ ZZ = Thing -- install component of chain complex
- ChainComplex Array -- degree shift
- chainComplex(GradedModule) -- make a chain complex from a graded module
- chainComplex(List) -- make a chain complex
- chainComplex(Matrix) -- make a small chain complex
- chainComplex(Ring) -- make an empty chain complex over a ring
- ChainComplexMap -- the class of all maps between chain complexes
- ChainComplexMap ** ChainComplex -- tensor product
- ChainComplexMap ** ChainComplexMap -- tensor product
- ChainComplexMap ^ ZZ -- iterated composition
- ChainComplexMap _ ZZ -- component map
- ChainComplexMap _ ZZ = Thing -- install component of chain complex map
- ChangeMatrix -- whether to produce the change of basis matrix
- char -- computes the characteristic of the ring or field
- characters -- get characters from a string
- CheckDocumentation -- name for an optional argument
- clean -- Set to zero elements which are approximately zero
- clearAll -- forget everything
- clearOutput -- forget output values
- close -- close a file
- closeIn -- close an input file
- closeOut -- close an output file
- ClosestFit -- name for an optional argument
- CODE -- hypertext CODE item
- code -- display source code
- codim -- compute the codimension
- codim(CoherentSheaf) -- codimension of the support of a coherent sheaf on a projective variety
- codim(Ideal) -- compute the codimension
- codim(Ideal, Generic => ...)
- codim(Module) -- codimension of the support of a module
- codim(MonomialIdeal) -- compute the codimension
- codim(ProjectiveVariety) -- codimension of the projective variety
- codim(QuotientRing) -- compute the codimension
- CodimensionLimit -- stop when this codimension is reached
- coefficient -- coefficient of a monomial
- CoefficientRing -- name for an optional argument
- coefficientRing -- get the coefficient ring
- coefficients -- monomials and their coefficients
- coefficients(..., Monomials => ...) -- specify monomials
- coefficients(..., Variables => ...) -- take coefficients using these variables
- Cofactor
- CoherentSheaf -- the class of all coherent sheaves
- CoherentSheaf (*) -- sum of twists
- CoherentSheaf ** CoherentSheaf -- tensor product of coherent sheaves
- CoherentSheaf ++ CoherentSheaf -- direct sum of coherent sheaves
- CoherentSheaf / CoherentSheaf -- quotient of coherent sheaves
- CoherentSheaf ^ ZZ -- direct sum
- CoherentSheaf ^** ZZ -- tensor power
- CoherentSheaf ZZ -- canonical twist of a coherent sheaf
- cohomology -- general cohomology functor
- cohomology(..., Degree => ...)
- coimage -- coimage of a map
- cokernel -- cokernel of a map of modules, graded modules, or chaincomplexes
- columnAdd -- add a multiple of one column to another
- columnate -- arrange strings in columns
- columnMult -- multiply a column by a ring element
- columnPermute -- permute some columns
- columnSwap -- interchange columns
- Command -- the class of all commands
- commandInterpreter -- the top level command interpreter
- COMMENT -- hypertext COMMENT element
- commonest -- the most common elements of a list or tally
- commonRing -- find smallest containing ring
- comodule -- submodule to quotient module
- compactMatrixForm -- global flag for compact printing
- comparison operators
- CompiledFunction -- the class of all compiled functions
- CompiledFunctionBody -- the class of all compiled function bodies
- CompiledFunctionClosure -- the class of all compiled function closures
- Complement
- complement(Matrix) -- find the minimal generators for cokernel of a matrix (low level form)
- complete
- complete(ChainComplex) -- complete the internal parts
- CompleteIntersection -- name for an optional argument
- ComplexField
- component example
- components -- list the components of a direct sum
- components(ChainComplex) -- list the components of a direct sum
- compositions -- compositions of an integer
- compress -- extract nonzero columns from a matrix
- computing resolutions
- computing syzygies
- cone -- mapping cone of a chain map
- cone(ChainComplexMap) -- mapping cone of a chain map
- conjugate -- complex conjugate
- conjugate(CC) -- complex conjugate
- conjugate(Partition) -- conjugate a partition
- connectionCount -- the number of connections
- Constant
- constructing maps between modules
- content(RingElement) -- the content of a polynomial
- continue -- continue with the next iteration of a loop
- contract -- contract one matrix by another
- contract'(Matrix,Matrix) -- contract a matrix by a matrix, the dual notion
- contract(Matrix,Matrix) -- contract a matrix by a matrix
- conventions for documentation
- copyDirectory(..., UpdateOnly => ...)
- COPYING -- the Macaulay 2 license agreement
- copyright -- a string containing the copyright notice for Macaulay 2
- Core -- the core part of Macaulay 2
- cos -- compute the cosine
- cosh -- compute the hyperbolic cosine
- cot -- cotangent
- cotangentSheaf -- cotangent sheaf of a projective variety
- cotangentSheaf(ProjectiveVariety) -- cotangent sheaf of a projective variety
- cotangentSheaf(ZZ,ProjectiveVariety) -- exterior powers of the cotangent sheaf of a projective variety
- coth -- hyperbolic cotangent
- cover -- get the covering free module
- cover(Matrix) -- get the covering free module
- cover(Module) -- get the covering free module
- coverMap(Module) -- the surjective map from a free module to a module corresponding to the generators
- cpuTime -- seconds of cpu time used since Macaulay2 began
- csc -- cosecant
- csch -- hyperbolic cosecant
- currentFileDirectory -- the directory containing the current input file
- currentFileName -- the current source file
- currentLineNumber -- current line number of the current input file
- currentPackage -- the current package
- currentTime -- get the current time
- Database -- the class of all database files
- Database # String -- get value from database
- Database #? String -- check for value in database
- DD -- hypertext DD element
- dd -- differential in a chain complex
- debug -- open private dictionary of a package
- debugError -- a function to debug
- DebuggingMode -- name for an optional argument
- debuggingMode -- whether to enter the debugger when an error occurs
- debugLevel -- current level debugging
- Decompose -- name for an optional argument
- deepSplice -- remove subsequences
- default -- default member of a family
- defaultPrecision -- default precision of numbers
- Degree
- degree
- degree(Ideal)
- degree(Matrix)
- degree(Module)
- degree(ProjectiveHilbertPolynomial)
- degree(ProjectiveVariety)
- degree(Ring)
- degree(RingElement)
- degree(RingElement,RingElement) -- degree with respect to a variable
- degreeLength -- the number of degrees
- DegreeLimit -- compute up to a certain degree
- DegreeMap
- DegreeOrder -- sort primarily by degree
- degrees -- degrees of generators
- degrees(Matrix) -- degrees of target and source
- degrees(Ring) -- degrees of generators
- degreesMonoid -- get the monoid of degrees
- degreesRing -- the ring of degrees
- degreesRing(Ring) -- the ring of degrees
- degreesRing(ZZ) -- the ring of degrees
- demark -- insert a string between elements of a list of strings
- denominator -- denominator of a fraction
- Dense -- name for an optional argument
- Density -- name for an optional argument
- depth -- depth of a net
- Descending -- specify descending order
- Descent
- describe -- real description
- Description -- name for an optional argument
- determinant -- determinant of a matrix
- determinant(..., Strategy => ...) -- choose between Bareiss and Cofactor algorithms
- Developer's Corner
- diagonalMatrix -- make a diagonal matrix
- diagonalMatrix(Matrix) -- make a diagonal matrix from entries of a matrix
- diagonalMatrix(Ring,ZZ,ZZ,List) -- make a diagonal matrix from a list
- Dictionary -- the class of all dictionaries
- dictionary -- determine the dictionary to which a symbol belongs
- dictionaryPath
- diff -- differentiate or take difference
- diff and contract
- diff'(Matrix,Matrix) -- differentiate a matrix by a matrix, the dual notion
- difference -- difference
- dim -- compute the Krull dimension
- dim(AffineVariety) -- dimension of the affine variety
- dim(Ideal) -- compute the Krull dimension
- dim(Module) -- compute the Krull dimension
- dim(ProjectiveHilbertPolynomial) -- the degree of the Hilbert polynomial
- dim(ProjectiveVariety) -- dimension of the projective variety
- dim(Ring) -- compute the Krull dimension
- directSum -- direct sum of modules or maps
- disassemble -- disassemble pseudocode or a function
- dismiss -- dismiss a package
- DIV -- a hypertext division
- DIV1 -- a single-spaced paragraph separator
- Divide -- the class of all divide expressions
- divideByVariable -- divide all columns by a (power of a) variable
- DivideConquer -- name for an optional argument
- DL -- hypertext DL element
- do -- loop control
- document(..., BaseFunction => ...) -- function for a documented feature
- document(..., Caveat => ...) -- warnings
- document(..., Consequences => ...) -- side-effects of a function
- document(..., Inputs => ...) -- inputs for a function
- document(..., Key => ...) -- key of a documentation node
- document(..., Outputs => ...) -- outputs for a function
- document(..., SeeAlso => ...) -- crossreferences in documentation
- document(..., Subnodes => ...) -- a menu of documentation nodes
- documentation keys
- DocumentTag -- the class of all document tags
- drop(BasicList,List)
- drop(BasicList,ZZ)
- DT -- hypertext DT element
- dual -- dual module or map
- dual(ChainComplex) -- dual
- dual(ChainComplexMap) -- dual of a chain complex
- dual(CoherentSheaf) -- dual coherent sheaf
- dual(Matrix) -- dual of a map
- dual(Module) -- dual module
- dual(MonomialIdeal) -- the Alexander dual of a monomial ideal
- dual(MonomialIdeal,List) -- the Alexander dual
- dual(MonomialIdeal,RingElement) -- the Alexander dual
- eagonNorthcott(Matrix) -- Eagon-Northcott complex of a matrix of linear forms
- echoOff -- turn off echoing
- echoOn -- turn on echoing
- edit -- edit source code
- eigenvalues -- find eigenvalues of a matrix
- eigenvalues(..., Hermitian => ...) -- Hermitian=>true means assume the matrix is symmetric or Hermitian
- eigenvectors -- find eigenvectors of a matrix over RR or CC
- eigenvectors(..., Hermitian => ...) -- Hermitian=>true means assume the matrix is symmetric or Hermitian
- eint -- exponential integral
- elements -- list of elements
- EliminationOrder -- use the natural elmination order in a pushForward1 computation
- else -- condition testing
- EM -- hypertext EM item
- encapDirectory -- encapsulated installation directory
- Encapsulate -- name for an optional argument
- EncapsulateDirectory -- name for an optional argument
- End -- module of endomorphisms
- end -- stop loading a file
- endl -- end an output line
- endPackage(String) -- end a new package
- Engine -- specify whether a ring is handled by the engine
- engineDebugLevel -- current engine debugging level
- EngineRing -- the class of rings handled by the engine
- entries -- lists the entries of a matrix
- entries(Vector) -- lists the entries of a vector
- epkg
- equality and containment of modules
- equality versus strict equality
- Equation -- the class of all equation expressions
- erase -- remove a global symbol
- erf -- error function
- erfc -- complementary error function
- errorCode -- the pseudocode that produced an error
- errorDepth -- set the error printing depth
- euler -- Euler characteristic
- euler(CoherentSheaf) -- Euler characteristic of coherent sheaf
- euler(Ideal) -- Euler characteristic
- euler(Module) -- Euler characteristic
- euler(ProjectiveHilbertPolynomial) -- constant term of the Hilbert polynomial
- euler(ProjectiveVariety) -- topological Euler characteristic of a (smooth) projective variety
- euler(Ring) -- Euler characteristic
- EulerConstant -- the Euler-Mascheroni constant
- eulers -- list the sectional Euler characteristics
- eulers(CoherentSheaf) -- list the sectional Euler characteristics
- eulers(Ideal) -- list the sectional Euler characteristics
- eulers(Ring) -- list the sectional Euler characteristics
- even -- tell whether an integer is even
- EXAMPLE -- hypertext EXAMPLE item
- ExampleItem -- a type of hypertext for holding example inputs awaiting outputs
- examples -- list the examples in documentation
- Exclude -- name for an optional argument
- exp -- exponential function
- expm1 -- exponential minus 1
- exponents -- list the exponents in a polynomial
- Expression -- the class of all expressions
- expression -- convert to an expression
- Ext -- compute an Ext module
- Ext(Module,Module) -- total Ext module
- Ext^ZZ(CoherentSheaf,CoherentSheaf) -- global Ext
- Ext^ZZ(CoherentSheaf,SumOfTwists) -- global Ext
- Ext^ZZ(Matrix,Module) -- map between Ext modules
- Ext^ZZ(Module,Matrix) -- map between Ext modules
- Ext^ZZ(Module,Module) -- Ext module