de.uka.ilkd.key.prover.impl

Class AppliedRuleStopCondition

java.lang.Object

de.uka.ilkd.key.prover.impl.AppliedRuleStopCondition

All Implemented Interfaces:

StopCondition

public final class AppliedRuleStopCondition
extends java.lang.Object
implements StopCondition

Implementation of StopCondition which stops the strategy after a reached limit of rules or after a timeout in ms.

This is the default StopCondition used during verification.

Author:

Martin Hentschel

Constructor Summary

Constructors

Constructor and Description
AppliedRuleStopCondition()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGoalNotAllowedMessage(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, Goal goal) Returns the reason why the previous check via #isGoalAllowed(ApplyStrategy, int, long, Proof, GoalChooser, long, int, Goal) has stopped the apply strategy.
int	getMaximalWork(int maxApplications, long timeout, Proof proof) Returns the maximal amount of work needed to complete the task, used to display a progress bar.
java.lang.String	getStopMessage(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, SingleRuleApplicationInfo singleRuleApplicationInfo) Returns a human readable message which explains why the previous #shouldStop(ApplyStrategy, Proof, GoalChooser, long, int, SingleRuleApplicationInfo) has stopped the strategy.
boolean	isGoalAllowed(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, Goal goal) Checks if it is allowed to apply the next rule on the selected Goal chosen by the GoalChooser before it is applied.
boolean	shouldStop(int maxApplications, long timeout, Proof proof, long startTime, int countApplied, SingleRuleApplicationInfo singleRuleApplicationInfo) Checks after each applied rule if more rules should be applied or if the strategy should stop.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppliedRuleStopCondition

public AppliedRuleStopCondition()

Method Detail

getMaximalWork

public int getMaximalWork(int maxApplications,
                          long timeout,
                          Proof proof)

Returns the maximal amount of work needed to complete the task, used to display a progress bar. Pass 0 to indicate unknown size.

Specified by:

getMaximalWork in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

Returns:

The maximal amount of work or 0 if it is unknown.

isGoalAllowed

public boolean isGoalAllowed(int maxApplications,
                             long timeout,
                             Proof proof,
                             long startTime,
                             int countApplied,
                             Goal goal)

Checks if it is allowed to apply the next rule on the selected Goal chosen by the GoalChooser before it is applied. If it is not allowed the apply strategy will stop.

Specified by:

isGoalAllowed in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

goal - The current Goal on which the next rule will be applied.

Returns:

true rule application is allowed, false rule application is not allowed so stop apply strategy

getGoalNotAllowedMessage

public java.lang.String getGoalNotAllowedMessage(int maxApplications,
                                                 long timeout,
                                                 Proof proof,
                                                 long startTime,
                                                 int countApplied,
                                                 Goal goal)

Returns the reason why the previous check via #isGoalAllowed(ApplyStrategy, int, long, Proof, GoalChooser, long, int, Goal) has stopped the apply strategy.

Specified by:

getGoalNotAllowedMessage in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

goal - The current Goal on which the next rule will be applied.

Returns:

shouldStop

public boolean shouldStop(int maxApplications,
                          long timeout,
                          Proof proof,
                          long startTime,
                          int countApplied,
                          SingleRuleApplicationInfo singleRuleApplicationInfo)

Checks after each applied rule if more rules should be applied or if the strategy should stop.

Specified by:

shouldStop in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

singleRuleApplicationInfo - An optional SingleRuleApplicationInfo.

Returns:

true stop strategy, false continue strategy and apply next rule.

getStopMessage

public java.lang.String getStopMessage(int maxApplications,
                                       long timeout,
                                       Proof proof,
                                       long startTime,
                                       int countApplied,
                                       SingleRuleApplicationInfo singleRuleApplicationInfo)

Returns a human readable message which explains why the previous #shouldStop(ApplyStrategy, Proof, GoalChooser, long, int, SingleRuleApplicationInfo) has stopped the strategy.

Specified by:

getStopMessage in interface StopCondition

Parameters:

maxApplications - The defined maximal number of rules to apply. Can be different to StrategySettings.getMaxSteps() in side proofs.

timeout - The defined timeout in ms or -1 if disabled. Can be different to StrategySettings.getTimeout() in side proofs.

proof - The current Proof.

startTime - The timestamp when the apply strategy has started, computed via System.currentTimeMillis()

countApplied - The number of already applied rules.

singleRuleApplicationInfo - An optional SingleRuleApplicationInfo.

Returns:

The human readable message which explains the stop reason.