Macaulay2 » Documentation
Packages » Macaulay2Doc » reading the documentation » apropos
next | previous | forward | backward | up | index | toc

apropos -- symbols matching a pattern

Description

In the simplest case, the list of symbols containing the given string is returned.

i1 : apropos "atrix"

o1 = {blockMatrixForm, ChangeMatrix, compactMatrixForm, diagonalMatrix,
     ------------------------------------------------------------------------
     fillMatrix, genericMatrix, genericSkewMatrix, genericSymmetricMatrix,
     ------------------------------------------------------------------------
     getChangeMatrix, Matrix, matrix, MatrixExpression, MinimalMatrix,
     ------------------------------------------------------------------------
     MutableMatrix, mutableMatrix, randomMutableMatrix, submatrix,
     ------------------------------------------------------------------------
     submatrix', submatrixByDegrees, sylvesterMatrix, SyzygyMatrix,
     ------------------------------------------------------------------------
     vertexEdgeMatrix, vertexFacetMatrix}

o1 : List

Regular expressions allow for more complicated requests. For example, to find all functions that start with mat or Mat:

i2 : apropos "^[mM]at"

o2 = {match, mathML, Matrix, matrix, MatrixExpression}

o2 : List

It is also possible to view a table of headlines corresponding to the results.

i3 : headlines apropos "hilbert"

o3 = 0.  "Polyhedra :: hilbertBasis"           -- computes the Hilbert basis of a Cone
     1.  "Macaulay2Doc :: hilbertFunction"     -- the Hilbert function                
     2.  "Macaulay2Doc :: hilbertPolynomial"   -- compute the Hilbert polynomial      
     3.  "Macaulay2Doc :: hilbertSeries"       -- compute the Hilbert series

See also

Ways to use apropos:

  • apropos(String)

For the programmer

The object apropos is a method function.

The source of this document is in Macaulay2Doc/functions/help-doc.m2:349:0.