de.dante.extex.interpreter.primitives.register.real
Class AbstractMath

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.register.real.AbstractMath
All Implemented Interfaces:
Code, CountConvertible, Localizable, RealConvertible, java.io.Serializable, Theable
Direct Known Subclasses:
MathAbs, MathACos, MathAdd, MathASin, MathATan, MathATanTwo, MathCeil, MathCos, MathDiv, MathE, MathExp, MathExpression, MathFloor, MathLog, MathMax, MathMin, MathMul, MathPi, MathPow, MathRandom, MathRint, MathRound, MathSin, MathSqrt, MathSub, MathTan, MathToDegrees, MathToRadians

public abstract class AbstractMath
extends AbstractCode
implements Theable, RealConvertible, CountConvertible

Abstract class for math primitives. e.g. sin, cos, ...

Version:
$Revision: 1.10 $
Author:
Michael Niedermair
See Also:
Serialized Form

Field Summary
 
Fields inherited from class de.dante.extex.interpreter.type.AbstractCode
serialVersionUID
 
Constructor Summary
AbstractMath(java.lang.String name)
          Creates a new object.
 
Method Summary
protected abstract  Real calculate(Context context, TokenSource source)
          Calculate
 long convertCount(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a count.
 Real convertReal(Context context, TokenSource source)
          Convert to a real.
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          execute
 Tokens the(Context context, TokenSource source, Typesetter typesetter)
          This method is the getter for the description of the primitive.
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractMath

public AbstractMath(java.lang.String name)
             throws GeneralException
Creates a new object.

Parameters:
name - the name for debugging
Throws:
GeneralException - ...
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
execute

Specified by:
execute in interface Code
Overrides:
execute in class AbstractCode
Throws:
InterpreterException
See Also:
Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws InterpreterException
Description copied from interface: Theable
This method is the getter for the description of the primitive.

Specified by:
the in interface Theable
Parameters:
context - the interpreter context
source - the source for further tokens to qualify the request
typesetter - the typesetter to use
Returns:
the description of the primitive as list of Tokens
Throws:
InterpreterException - in case of an error
See Also:
Theable.the( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, Typesetter)

convertReal

public Real convertReal(Context context,
                        TokenSource source)
                 throws InterpreterException
Description copied from interface: RealConvertible
Convert to a real.

Specified by:
convertReal in interface RealConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
Returns:
the converted value
Throws:
InterpreterException - in case of an error
See Also:
RealConvertible.convertReal( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource)

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException
Description copied from interface: CountConvertible
This method converts a register into a count. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used.

Specified by:
convertCount in interface CountConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use for conversion
Returns:
the converted value
Throws:
InterpreterException - in case of an error
See Also:
CountConvertible.convertCount( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

calculate

protected abstract Real calculate(Context context,
                                  TokenSource source)
                           throws InterpreterException
Calculate

Parameters:
context - the context
source - the tokensource
Returns:
the real-value
Throws:
GeneralException - if a error occoured
InterpreterException