org.extex.interpreter.primitives.register.real
Class AbstractMath

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.primitives.register.real.AbstractMath

All Implemented Interfaces:

java.io.Serializable, CountConvertible, RealConvertible, Code, 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: 6447 $

Author:

Michael Niedermair

See Also:

Serialized Form

Field Summary

Fields inherited from class org.extex.interpreter.type.AbstractCode

serialVersionUID

Constructor Summary

AbstractMath(CodeToken token)
Creates a new object.

Method Summary

protected abstract Real	calculate(Context context, TokenSource source, Typesetter typesetter) Calculate
long	convertCount(Context context, TokenSource source, Typesetter typesetter) This method converts a register into a count.
Real	convertReal(Context context, TokenSource source, Typesetter typesetter) 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 org.extex.interpreter.type.AbstractCode

getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMath

public AbstractMath(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

execute

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

execute

Specified by:

execute in interface Code

Overrides:

execute in class AbstractCode

Parameters:

prefix - the prefix controlling the execution

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

Code.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws ConfigurationException,
                  CatcodeException,
                  HelpingException,
                  TypesetterException

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:

CatcodeException - in case of an error in token creation

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error

See Also:

Theable.the( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

convertReal

public Real convertReal(Context context,
                        TokenSource source,
                        Typesetter typesetter)
                 throws ConfigurationException,
                        HelpingException,
                        TypesetterException

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

typesetter - the typesetter

Returns:

the converted value

Throws:

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

RealConvertible.convertReal( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, Typesetter)

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws ConfigurationException,
                         HelpingException,
                         TypesetterException

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:

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

CountConvertible.convertCount( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

calculate

protected abstract Real calculate(Context context,
                                  TokenSource source,
                                  Typesetter typesetter)
                           throws ConfigurationException,
                                  HelpingException,
                                  TypesetterException

Calculate

Parameters:

context - the context

source - the token source

typesetter - the typesetter

Returns:

the real value

Throws:

HelpingException - in case of an error

ConfigurationException - in case of an configuration error

TypesetterException - in case of an error in the typesetter