net.sourceforge.czt.animation.eval

Class ZLiveResult

java.lang.Object

net.sourceforge.czt.animation.eval.ZLiveResult

public class ZLiveResult
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZLiveResult.MoveException An exception for the ZLiveResult move method.

Field Summary

Fields

Modifier and Type	Field and Description
protected FlatPredList	code_
protected ListIterator<net.sourceforge.czt.z.ast.Expr>	currIter_ An iterator through result_ (if it is an EvalSet)
protected net.sourceforge.czt.z.ast.Expr	currMember_ The current member of currSet that has been shown.
protected int	currPosition_ The position in currIter_ of currMember_ (0 ..
protected Envir	envir0_
protected Mode	mode_
protected net.sourceforge.czt.base.ast.Term	original_
protected net.sourceforge.czt.base.ast.Term	result_
protected net.sourceforge.czt.z.ast.ZName	resultName_
protected String	section_
protected net.sourceforge.czt.base.ast.Term	unfolded_

Constructor Summary

Constructors

Constructor and Description
ZLiveResult(String section, net.sourceforge.czt.base.ast.Term original) Record the result of an evaluation.
ZLiveResult(String section, net.sourceforge.czt.base.ast.Term original, Envir env0, net.sourceforge.czt.base.ast.Term unfolded, FlatPredList code, net.sourceforge.czt.z.ast.ZName resultName, Mode mode, net.sourceforge.czt.base.ast.Term result) Convenience constructor that records all information about the evaluated term.

Method Summary

Modifier and Type	Method and Description
net.sourceforge.czt.z.ast.Expr	currentMember()
int	currentPosition() The position of the currentMember() in the current set.
FlatPredList	getCode()
Envir	getEnvir0()
Mode	getMode() The mode that was used to evaluate the term.
net.sourceforge.czt.base.ast.Term	getOriginalTerm()
net.sourceforge.czt.base.ast.Term	getResult()
net.sourceforge.czt.z.ast.ZName	getResultName()
String	getSectionName()
net.sourceforge.czt.base.ast.Term	getUnfoldedTerm()
boolean	isExpr()
boolean	isPred()
boolean	isSet()
void	moveTo(int position) Tries to move to member number 'position' in currSet.
void	setCode(FlatPredList code, net.sourceforge.czt.z.ast.ZName resultName) Record the result of compiling the flattened term.
void	setEnvir0(Envir env0) Record the initial environment in which the term is evaluated.
void	setMode(Mode mode) Record the mode that was used to evaluate the term.
void	setResult(net.sourceforge.czt.base.ast.Term result) Set the result of evaluating the term.
void	setUnfoldedTerm(net.sourceforge.czt.base.ast.Term term) Record the result of flattening/simplifying the term.

Methods inherited from class java.lang.Object

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

Field Detail

section_

protected String section_

original_

protected net.sourceforge.czt.base.ast.Term original_

unfolded_

protected net.sourceforge.czt.base.ast.Term unfolded_

envir0_

protected Envir envir0_

code_

protected FlatPredList code_

resultName_

protected net.sourceforge.czt.z.ast.ZName resultName_

mode_

protected Mode mode_

result_

protected net.sourceforge.czt.base.ast.Term result_

currIter_

protected ListIterator<net.sourceforge.czt.z.ast.Expr> currIter_

An iterator through result_ (if it is an EvalSet)

currPosition_

protected int currPosition_

The position in currIter_ of currMember_ (0 .. n, for an n-element set) Invariant: currPosition_ is always the value of currIter_.nextIndex() and currMember_ (if non-null) is always the value of currIter_.previous(). So currPosition_==0 means we are *before* the first element, and currMember_==null. For a non-empty set of size n, the maximum value of currPosition_ is n, with currMember_ being the last element.

currMember_

protected net.sourceforge.czt.z.ast.Expr currMember_

The current member of currSet that has been shown.

Constructor Detail

ZLiveResult

public ZLiveResult(String section,
                   net.sourceforge.czt.base.ast.Term original,
                   Envir env0,
                   net.sourceforge.czt.base.ast.Term unfolded,
                   FlatPredList code,
                   net.sourceforge.czt.z.ast.ZName resultName,
                   Mode mode,
                   net.sourceforge.czt.base.ast.Term result)

Convenience constructor that records all information about the evaluated term. All of the arguments must be non-null.

Parameters:

original - The term that was evaluated

unfolded - The term after preprocessing

code - The internal FlatPred code used during evaluation

result - The result of evaluation

ZLiveResult

public ZLiveResult(String section,
                   net.sourceforge.czt.base.ast.Term original)

Record the result of an evaluation.

Parameters:

section - The section this term is relative to.

original - The term to be evaluated.

Method Detail

isExpr

public boolean isExpr()

isPred

public boolean isPred()

isSet

public boolean isSet()

getSectionName

public String getSectionName()

getOriginalTerm

public net.sourceforge.czt.base.ast.Term getOriginalTerm()

getUnfoldedTerm

public net.sourceforge.czt.base.ast.Term getUnfoldedTerm()

setUnfoldedTerm

public void setUnfoldedTerm(net.sourceforge.czt.base.ast.Term term)

Record the result of flattening/simplifying the term.

Parameters:

code - Must be non-null.

getEnvir0

public Envir getEnvir0()

setEnvir0

public void setEnvir0(Envir env0)

Record the initial environment in which the term is evaluated.

Parameters:

env0 - Must be non-null.

getCode

public FlatPredList getCode()

getResultName

public net.sourceforge.czt.z.ast.ZName getResultName()

setCode

public void setCode(FlatPredList code,
                    net.sourceforge.czt.z.ast.ZName resultName)

Record the result of compiling the flattened term.

Parameters:

code - Must be non-null.

resultName - Must be non-null for expressions, null for predicates.

getMode

public Mode getMode()

The mode that was used to evaluate the term.

setMode

public void setMode(Mode mode)

Record the mode that was used to evaluate the term.

Parameters:

mode - Must be non-null and use the same initial environment.

getResult

public net.sourceforge.czt.base.ast.Term getResult()

setResult

public void setResult(net.sourceforge.czt.base.ast.Term result)

Set the result of evaluating the term.

Parameters:

result - Must be non-null.

currentPosition

public int currentPosition()

The position of the currentMember() in the current set. You should call this method only when isSet() is true. If this returns 0, then currentMember() will return null.

Returns:

0 .. n, where n is the size of the current set.

currentMember

public net.sourceforge.czt.z.ast.Expr currentMember()

moveTo

public void moveTo(int position)

Tries to move to member number 'position' in currSet.

Throws:

RuntimeException - if the current result is not a set, if position is not positive, or if it is larger than the number of solutions in the current set. Note that this steps sequentially through the set, so large values of position may take huge amounts of time. However, once members of the set have been generated, they are cached, so traversing backwards and forwards is fine.