[jboss-svn-commits] JBL Code SVN: r28182 - labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Sat Jul 18 09:14:51 EDT 2009
Author: ge0ffrey
Date: 2009-07-18 09:14:51 -0400 (Sat, 18 Jul 2009)
New Revision: 28182
Modified:
labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Benchmarking_and_tweaking.xml
labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Local_Search_Solver.xml
labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Solver_configuration.xml
Log:
JBRULES-2212 Finish renamed to Termination
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Benchmarking_and_tweaking.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Benchmarking_and_tweaking.xml 2009-07-18 13:09:10 UTC (rev 28181)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Benchmarking_and_tweaking.xml 2009-07-18 13:14:51 UTC (rev 28182)
@@ -41,9 +41,9 @@
<scoreDefinition>
<scoreDefinitionType>SIMPLE</scoreDefinitionType>
</scoreDefinition>
- <finish>
+ <termination>
<maximumSecondsSpend>20</maximumSecondsSpend>
- </finish>
+ </termination>
<selector>
<moveFactoryClass>org.drools.solver.examples.nqueens.solver.move.factory.NQueensMoveFactory</moveFactoryClass>
</selector>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Local_Search_Solver.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Local_Search_Solver.xml 2009-07-18 13:09:10 UTC (rev 28181)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Local_Search_Solver.xml 2009-07-18 13:14:51 UTC (rev 28182)
@@ -629,76 +629,76 @@
</section>
<section>
- <title>Finish</title>
+ <title>Termination</title>
<para>Sooner or later the local search solver will have to stop solving. This can be because of a number of reasons:
the time is up, the perfect score has been reached, ... The only thing you can't depend on is on finding the optimal
solution (unless you know the optimal score), because a local search solver doesn't know that when it finds the
optimal solution. For real-life problems this doesn't turn out to be much of a problem, because finding the optimal
- solution would take years, so you 'll want to finish early anyway.</para>
+ solution would take years, so you 'll want to terminate early anyway.</para>
- <para>You can configure when a local search solver needs to stop by configuring a Finish. You can implement your own
- <literal>Finish</literal>, although the build-in finishes should suffice for most needs.</para>
+ <para>You can configure when a local search solver needs to stop by configuring a Termination. You can implement your own
+ <literal>Termination</literal>, although the build-in Terminations should suffice for most needs.</para>
<section>
- <title>TimeMillisSpendFinish</title>
+ <title>TimeMillisSpendTermination</title>
- <para>Finishes when an amount of time has been reached:</para>
+ <para>Terminates when an amount of time has been reached:</para>
- <programlisting> <finish>
+ <programlisting> <termination>
<maximumMinutesSpend>2</maximumMinutesSpend>
- </finish></programlisting>
+ </termination></programlisting>
<para>or</para>
- <programlisting> <finish>
+ <programlisting> <termination>
<maximumHouresSpend>1</maximumHouresSpend>
- </finish></programlisting>
+ </termination></programlisting>
<para>Note that the time taken by a <literal>StartingSolutionInitializer</literal> also is taken into account by
- this finish. So if you give the solver 2 minutes to solve something, but the initializer takes 1 minute, the local
+ this Termination. So if you give the solver 2 minutes to solve something, but the initializer takes 1 minute, the local
search solver will only have a minute left.</para>
- <para>Note that if you use this finish, you will most likely sacrifice reproducability. The best solution will
+ <para>Note that if you use this Termination, you will most likely sacrifice reproducability. The best solution will
depend on available CPU time, not only because it influences the amount of steps taken, but also because time
gradient based algorithms (such as simulated annealing) will probably act differently on each run.</para>
</section>
<section>
- <title>StepCountFinish</title>
+ <title>StepCountTermination</title>
- <para>Finishes when an amount of steps has been reached:</para>
+ <para>Terminates when an amount of steps has been reached:</para>
- <programlisting> <finish>
+ <programlisting> <termination>
<maximumStepCount>100</maximumStepCount>
- </finish></programlisting>
+ </termination></programlisting>
</section>
<section>
- <title>FeasableScoreFinish</title>
+ <title>FeasableScoreTermination</title>
- <para>Finishes when a feasible score has been reached. You can also use this finish if you know the perfect score,
+ <para>Terminates when a feasible score has been reached. You can also use this Termination if you know the perfect score,
for example for 4 queens:</para>
- <programlisting> <finish>
+ <programlisting> <termination>
<feasableScore>0</feasableScore>
- </finish></programlisting>
+ </termination></programlisting>
<para>For a solver problem with hard and soft contraints, you can define it like this:</para>
- <programlisting> <finish>
+ <programlisting> <termination>
<feasableScore>0hard/-5000soft</feasableScore>
- </finish></programlisting>
+ </termination></programlisting>
</section>
<section>
- <title>UnimprovedStepCountFinish</title>
+ <title>UnimprovedStepCountTermination</title>
- <para>Finishes when the best score hasn't improved in a number of steps:</para>
+ <para>Terminates when the best score hasn't improved in a number of steps:</para>
- <programlisting> <finish>
+ <programlisting> <termination>
<maximumUnimprovedStepCount>100</maximumUnimprovedStepCount>
- </finish></programlisting>
+ </termination></programlisting>
<para>If it hasn't improved recently, it's probably not going to improve soon anyway and it's not worth the effort
to continue. We have observed that once a new best solution is found (even after a long time of no improvement on
@@ -706,27 +706,27 @@
</section>
<section>
- <title>Combining finishes</title>
+ <title>Combining Terminations</title>
- <para>Finishes can be combined, for example: finish after 100 steps or if a score of 0 has been reached:</para>
+ <para>Terminations can be combined, for example: terminate after 100 steps or if a score of 0 has been reached:</para>
- <programlisting> <finish>
- <finishCompositionStyle>OR</finishCompositionStyle>
+ <programlisting> <termination>
+ <terminationCompositionStyle>OR</terminationCompositionStyle>
<maximumStepCount>100</maximumStepCount>
<feasableScore>0</feasableScore>
- </finish></programlisting>
+ </termination></programlisting>
- <para>Alternatively you can use AND, for example: finish after reaching a feasible score of at least -100 and no
+ <para>Alternatively you can use AND, for example: terminate after reaching a feasible score of at least -100 and no
improvements in 5 steps:</para>
- <programlisting> <finish>
- <finishCompositionStyle>AND</finishCompositionStyle>
+ <programlisting> <termination>
+ <terminationCompositionStyle>AND</terminationCompositionStyle>
<maximumUnimprovedStepCount>5</maximumUnimprovedStepCount>
<feasableScore>-100</feasableScore>
- </finish></programlisting>
+ </termination></programlisting>
- <para>This ensures it doesn't just finish after finding a feasible solution, but also makes any obvious
- improvements on that solution before finishing.</para>
+ <para>This ensures it doesn't just terminate after finding a feasible solution, but also makes any obvious
+ improvements on that solution before terminating.</para>
</section>
</section>
</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Solver_configuration.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Solver_configuration.xml 2009-07-18 13:09:10 UTC (rev 28181)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-solver/src/main/docbook/en-US/Chapter-Solver/Section-Solver_configuration.xml 2009-07-18 13:14:51 UTC (rev 28182)
@@ -229,7 +229,7 @@
</orderedlist>
<para>A <literal>Solver</literal> should currently directly be accessed from a single thread. Support from accessing
- it from a different thread, for example to finish solving early or to change the problem facts in real-time, will be
+ it from a different thread, for example to terminate solving early or to change the problem facts in real-time, will be
added in future releases.</para>
</section>
@@ -251,9 +251,9 @@
<scoreDefinition>
<scoreDefinitionType>SIMPLE</scoreDefinitionType>
</scoreDefinition>
- <finish>
+ <termination>
<feasableScore>0</feasableScore>
- </finish>
+ </termination>
<selector>
<moveFactoryClass>org.drools.solver.examples.nqueens.solver.NQueensMoveFactory</moveFactoryClass>
</selector>
More information about the jboss-svn-commits
mailing list