org.matheclipse.core.eval.util

Class Options

java.lang.Object

org.matheclipse.core.eval.util.Options

public class Options
extends java.lang.Object

Managing Options used in evaluation of function symbols (i.e. Modulus->n is an option which could be used for an integer n in a function like Factor(polynomial, Modulus->2).

Constructor Summary

Constructors

Constructor and Description
Options(ISymbol symbol, IAST currentOptionsList, int startIndex, EvalEngine engine) Construct special Options used in evaluation of function symbols (i.e.
Options(ISymbol symbol, IExpr optionExpr, EvalEngine engine) Construct Options used in evaluation of function symbols (i.e.

Method Summary

Modifier and Type	Method and Description
edu.jas.poly.TermOrder	getMonomialOrder(IAST ast, edu.jas.poly.TermOrder defaultTermOrder)
static edu.jas.poly.TermOrder	getMonomialOrder(java.lang.String orderStr, edu.jas.poly.TermOrder defaultTermOrder)
IExpr	getOption(ISymbol option)
IExpr	getOption(java.lang.String optionString) Get the option from the internal options list.
boolean	isOption(java.lang.String optionString) Get the option from the internal options list and check if it's true or false.
IAST	replaceAll(IAST options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Options

public Options(ISymbol symbol,
               IAST currentOptionsList,
               int startIndex,
               EvalEngine engine)

Construct special Options used in evaluation of function symbols (i.e. Modulus->n is an option which could be used for an integer n in a function like Factor(polynomial, Modulus->2).

Parameters:

symbol - the options symbol for determining "default option values"

currentOptionsList - the AST where the option could be defined starting at position startIndex

startIndex - the index from which tolook for options defined in currentOptionsList

Options

public Options(ISymbol symbol,
               IExpr optionExpr,
               EvalEngine engine)

Construct Options used in evaluation of function symbols (i.e. Modulus->n is an option which could be used for an integer n in a function like Factor(polynomial, Modulus->2).

Parameters:

symbol - the options symbol for determining "default option values"

optionExpr - the value which should be defined for the option

Method Detail

isOption

public boolean isOption(java.lang.String optionString)

Get the option from the internal options list and check if it's true or false.

Parameters:

optionString - the option string

Returns:

true if the option is set to True or false otherwise.

getOption

public IExpr getOption(java.lang.String optionString)

Get the option from the internal options list.

Parameters:

optionString - the option string

Returns:

the found option value or F.NIL if the option is not available

getOption

public IExpr getOption(ISymbol option)

replaceAll

public IAST replaceAll(IAST options)

getMonomialOrder

public edu.jas.poly.TermOrder getMonomialOrder(IAST ast,
                                               edu.jas.poly.TermOrder defaultTermOrder)

getMonomialOrder

public static edu.jas.poly.TermOrder getMonomialOrder(java.lang.String orderStr,
                                                      edu.jas.poly.TermOrder defaultTermOrder)