Macaulay2 » Documentation
Packages » Macaulay2Doc » The Macaulay2 language » operators » -> » options(Function)
next | previous | forward | backward | up | index | toc

options(Function) -- get the optional arguments and default values of a function or method

Description

The keys of the output are the names of the optional arguments accepted by the function f and the values are the corresponding default values; or true, if the function accepts arbitrary options and provides no default values.

i1 : options res

o1 = OptionTable{DegreeLimit => null           }
                 FastNonminimal => false
                 HardDegreeLimit => {}
                 LengthLimit => infinity
                 PairLimit => infinity
                 ParallelizeByDegree => false
                 SortStrategy => 0
                 StopBeforeComputation => false
                 Strategy => null
                 SyzygyLimit => infinity

o1 : OptionTable
i2 : options codim
i3 : options(codim, Ideal)

o3 = OptionTable{Generic => false}

o3 : OptionTable
i4 : methods codim

o4 = {0 => (codim, PolynomialRing)}
     {1 => (codim, MonomialIdeal) }
     {2 => (codim, CoherentSheaf) }
     {3 => (codim, Module)        }
     {4 => (codim, Variety)       }
     {5 => (codim, QuotientRing)  }
     {6 => (codim, Ideal)         }
     {7 => (codim, BettiTally)    }

o4 : NumberedVerticalList
i5 : options oo

o5 = {0 => (OptionTable{Generic => false})}
     {1 => (OptionTable{Generic => false})}
     {2 => (OptionTable{Generic => false})}
     {3 => (OptionTable{Generic => false})}
     {4 => (OptionTable{Generic => false})}
     {5 => (OptionTable{Generic => false})}
     {6 => (OptionTable{Generic => false})}
     {7 => (OptionTable{})                }

o5 : NumberedVerticalList
i6 : methods intersect

o6 = {0 => (intersect, List)                           }
     {1 => (intersect, Set, Set)                       }
     {2 => (intersect, RRi, RRi)                       }
     {3 => (intersect, Module)                         }
     {4 => (intersect, Module, Module)                 }
     {5 => (intersect, Polyhedron, Cone)               }
     {6 => (intersect, Cone, Polyhedron)               }
     {7 => (intersect, Ideal)                          }
     {8 => (intersect, Matrix, Matrix)                 }
     {9 => (intersect, Ideal, Ideal)                   }
     {10 => (intersect, RRi)                           }
     {11 => (intersect, Matrix, Matrix, Matrix, Matrix)}
     {12 => (intersect, Polyhedron, Polyhedron)        }
     {13 => (intersect, Cone, Cone)                    }
     {14 => (intersect, Matrix)                        }
     {15 => (intersect, Sequence)                      }

o6 : NumberedVerticalList
i7 : options 0

o7 = OptionTable{}

o7 : OptionTable

See also

Ways to use this method:

  • options(Command)
  • options(Function) -- get the optional arguments and default values of a function or method
  • options(List)
  • options(Sequence)
  • options(ZZ)

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