[jboss-svn-commits] JBL Code SVN: r30809 - in labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US: Chapter-Local_search and 4 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Wed Dec 23 15:00:51 EST 2009
Author: ge0ffrey
Date: 2009-12-23 15:00:51 -0500 (Wed, 23 Dec 2009)
New Revision: 30809
Modified:
labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Benchmarking_and_tweaking/Section-Benchmarking_and_tweaking.xml
labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Local_search/Section-Local_search.xml
labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_configuration/Section-Planner_configuration.xml
labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_introduction/Section-Planner_introduction.xml
labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Score_calculation/Section-Score_calculation.xml
labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Use_cases_and_examples/Section-Use_cases_and_examples.xml
Log:
reference manual: rename drools-solver to Drools Planner
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Benchmarking_and_tweaking/Section-Benchmarking_and_tweaking.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Benchmarking_and_tweaking/Section-Benchmarking_and_tweaking.xml 2009-12-23 18:42:14 UTC (rev 30808)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Benchmarking_and_tweaking/Section-Benchmarking_and_tweaking.xml 2009-12-23 20:00:51 UTC (rev 30809)
@@ -12,13 +12,13 @@
<section>
<title>Finding the best configuration</title>
- <para>Drools-solver supports several solver types, but you're probably wondering which is the best one? Although
+ <para>Drools Planner supports several solver types, but you're probably wondering which is the best one? Although
some solver types generally perform better then others, it really depends on your problem domain. Most solver types
also have settings which can be tweaked. Those settings can influence the results of a solver a lot, although most
settings perform pretty good out-of-the-box.
</para>
- <para>Luckily, drools-solver includes with a benchmarker, which allows you to play out different solver types and
+ <para>Luckily, Drools Planner includes a benchmarker, which allows you to play out different solver types and
different settings against each other, so you can pick the best configuration for your problem domain.
</para>
</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Local_search/Section-Local_search.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Local_search/Section-Local_search.xml 2009-12-23 18:42:14 UTC (rev 30808)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Local_search/Section-Local_search.xml 2009-12-23 20:00:51 UTC (rev 30809)
@@ -59,7 +59,7 @@
</listitem>
</itemizedlist>
- <para>Drools-solver's local search implementation combines both. On top of that, it also offers additional support
+ <para>Drools Planner's local search implementation combines both. On top of that, it also offers additional support
for benchmarking etc.</para>
</section>
@@ -142,7 +142,7 @@
<para>An instance of <literal>YChangeMove</literal> moves a queen from it's current y to a different y.</para>
- <para>Drool-solver calls the <literal>doMove(WorkingMemory)</literal> method to do a move. The
+ <para>Drools Planner calls the <literal>doMove(WorkingMemory)</literal> method to do a move. The
<literal>Move</literal> implementation must notify the working memory of any changes it does on the solution
facts:</para>
@@ -153,14 +153,14 @@
workingMemory.modifyInsert(queenHandle, queen); // after changes are made
}</programlisting>
- <para>Drools-solver disables shadow facts for increased performance, so you cannot use the
+ <para>Drools Planner disables shadow facts for increased performance, so you cannot use the
<literal>workingMemory.update(FactHandle, Object)</literal> method, instead you need to call the
<literal>workingMemory.modifyRetract(FactHandle)</literal> method before modifying the fact and the
<literal>workingMemory.modifyInsert(FactHandle, Object)</literal> method after modifying the fact. Note that you can
alter multiple facts in a single move and effectively create a big move (also known as a coarse-grained
move).</para>
- <para>Drools-solver automatically filters out <emphasis>non doable moves</emphasis> by calling the
+ <para>Drools Planner automatically filters out <emphasis>non doable moves</emphasis> by calling the
<literal>isDoable(WorkingMemory)</literal> method on a move. A <emphasis>non doable move</emphasis> is:</para>
<itemizedlist>
@@ -231,7 +231,7 @@
move type if you're using more then 1 move type.</para>
<para>It's also recommended to implement the <literal>toString()</literal> method as it allows you to read
- drools-solver's logging more easily:</para>
+ Drools Planner's logging more easily:</para>
<programlisting> public String toString() {
return queen + " => " + toY;
@@ -390,7 +390,7 @@
</listitem>
</itemizedlist>
- <para>Of course drools-solver implements better local searches, such <emphasis>tabu search</emphasis> and
+ <para>Of course Drools Planner implements better local searches, such as <emphasis>tabu search</emphasis> and
<emphasis>simulated annealing</emphasis> which can avoid these problems. It's recommended to never use a simple
local search, unless you're absolutely sure there are no local optima in your planning problem.</para>
</section>
@@ -480,7 +480,7 @@
<title>Tabu search accepter</title>
<para>When tabu search takes steps it creates tabu's. It does not accept a move as the next step if that move
- breaks tabu. Drools-solver implements several tabu types:</para>
+ breaks tabu. Drools Planner implements several tabu types:</para>
<itemizedlist>
<listitem>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_configuration/Section-Planner_configuration.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_configuration/Section-Planner_configuration.xml 2009-12-23 18:42:14 UTC (rev 30808)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_configuration/Section-Planner_configuration.xml 2009-12-23 20:00:51 UTC (rev 30809)
@@ -42,7 +42,7 @@
</listitem>
</itemizedlist>
- <para>Brute force is currently not implemented in drools-solver. But we have plans to implement it in the future,
+ <para>Brute force is currently not implemented in Drools Planner. But we have plans to implement it in the future,
as a reference for validating the output of the other solver types.</para>
</section>
@@ -73,7 +73,7 @@
</listitem>
</itemizedlist>
- <para>Branch and bound is currently not implemented in drools-solver. But we have plans to implement it in the
+ <para>Branch and bound is currently not implemented in Drools Planner. But we have plans to implement it in the
future, as a reference for validating the output of the other solver types.</para>
</section>
@@ -98,7 +98,7 @@
</listitem>
</itemizedlist>
- <para>Drools-solver does not implement simplex.</para>
+ <para>Drools Planner does not implement simplex.</para>
</section>
<section>
@@ -129,7 +129,7 @@
</listitem>
</itemizedlist>
- <para>The genetic algorithm is currently not implemented in drools-solver.</para>
+ <para>The genetic algorithm is currently not implemented in Drools Planner.</para>
</section>
<section>
@@ -150,12 +150,12 @@
<itemizedlist>
<listitem>
- <para>It's relatively simple and natural to implement constraints (at least in drools-solver's
+ <para>It's relatively simple and natural to implement constraints (at least in Drools Planner's
implementation).</para>
</listitem>
<listitem>
- <para>It's very scalable, even when adding extra constraints (at least in drools-solver's
+ <para>It's very scalable, even when adding extra constraints (at least in Drools Planner's
implementation).</para>
</listitem>
@@ -177,7 +177,7 @@
</listitem>
</itemizedlist>
- <para>Drools-solver implements local search, including tabu search and simulated annealing.</para>
+ <para>Drools Planner implements local search, including tabu search and simulated annealing.</para>
</section>
</section>
@@ -197,7 +197,7 @@
<section>
<title>The Solver interface</title>
- <para>Every build-in solver implemented in drools-solver implements the <literal>Solver</literal> interface:</para>
+ <para>Every build-in solver implemented in Drools Planner implements the <literal>Solver</literal> interface:</para>
<programlisting>public interface Solver {
@@ -211,7 +211,7 @@
}</programlisting>
- <para>Solving a planning problem with drools-solver consists out of 4 steps:</para>
+ <para>Solving a planning problem with Drools Planner consists out of 4 steps:</para>
<orderedlist>
<listitem>
@@ -270,7 +270,7 @@
<para>This is a tabu search configuration for n queens. We 'll explain the various parts of a configuration later in
this manual.</para>
- <para><emphasis role="bold">Drools-solver makes it relatively easy to switch a solver type just by changing the
+ <para><emphasis role="bold">Drools Planner makes it relatively easy to switch a solver type just by changing the
configuration.</emphasis> There's even a benchmark utility which allows you to play out different configurations
against each other and report the most appropriate configuration for your problem. You could for example play out
tabu search versus simulated annealing, on 4 queens and 64 queens.</para>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_introduction/Section-Planner_introduction.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_introduction/Section-Planner_introduction.xml 2009-12-23 18:42:14 UTC (rev 30808)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Planner_introduction/Section-Planner_introduction.xml 2009-12-23 20:00:51 UTC (rev 30809)
@@ -10,10 +10,10 @@
<title>Planner introduction</title>
<section>
- <title>What is drools-solver?</title>
+ <title>What is Drools Planner?</title>
- <para><emphasis role="bold">Drools-solver solves planning problems</emphasis> by combining a search algorithm with
- the power of the drools rule engine. Good examples of such planning problems include:</para>
+ <para><emphasis role="bold">Drools Planner does automated planning </emphasis>by combining a search algorithm with
+ the power of the Drools rule engine. Good examples of such planning problems include:</para>
<itemizedlist>
<listitem>
@@ -50,7 +50,7 @@
</listitem>
<listitem>
- <para>Miss manners too (although the drools-solver example solves this differently than the pure drools rule
+ <para>Miss manners too (although the Drools Planner example solves this differently than the pure Drools rule
engine example)</para>
</listitem>
</itemizedlist>
@@ -102,29 +102,29 @@
</listitem>
</itemizedlist>
- <para>Drools-solver supports several search algorithms to efficiently wade through the incredbly large number of
+ <para>Drools Planner supports several search algorithms to efficiently wade through the incredibly large number of
possible solutions. <emphasis role="bold">It makes it easy to switch the search algorithm</emphasis>, by simply
changing the solver configuration.</para>
</section>
<section>
- <title>Status of drools-solver</title>
+ <title>Status of Drools Planner</title>
- <para>Drools-solver is a beta module of Drools. The API is almost stable but backward incompatible changes can
+ <para>Drools Planner is a beta module of Drools. The API is almost stable but backward incompatible changes can
occur. With the recipe called <filename>UpgradeFromPreviousVersionRecipe.txt</filename> you can easily upgrade and
deal with any backwards incompatible changes between versions. You can find this recipe in subversion and in every
release.</para>
- <para>Drools-solver, like Drools, is open source software under the Apache Software License.</para>
+ <para>Drools Planner, like Drools, is open source software under the Apache Software License.</para>
</section>
<section>
- <title>Getting drools-solver and running the examples</title>
+ <title>Getting Drools Planner and running the examples</title>
<section>
<title>Getting the release package and running the examples</title>
- <para>You can download a release of drools-solver from <link
+ <para>You can download a release of Drools Planner from <link
xlink:href="http://www.jboss.org/drools/downloads.html">the drools download site</link>. To run an example, just
run the script (<filename>runExamples.sh</filename> on linux or <filename>runExamples.bat</filename> on windows)
and pick an example:</para>
@@ -135,7 +135,7 @@
<section>
<title>Get it with maven 2</title>
- <para>The drools-solver jars are available on <link xlink:href="http://repository.jboss.com/maven2/">the jboss
+ <para>The Drools Planner jars are available on <link xlink:href="http://repository.jboss.com/maven2/">the jboss
maven repository</link>. If you use maven 2, just add a dependency to <literal>drools-planner-core</literal> in
your project's <filename>pom.xml</filename>:</para>
@@ -191,7 +191,7 @@
list</link>. You can read/write to the mailing list without littering your mailbox through <link
xlink:href="nntp://news.gmane.org/gmane.comp.java.drools.user">this newsgroup</link>.</para>
- <para>Feel free to report an issue (such as a bug, improvement or a new feature request) for the drools-solver code
+ <para>Feel free to report an issue (such as a bug, improvement or a new feature request) for the Drools Planner code
or for this manual to <link xlink:href="https://jira.jboss.org/jira/browse/JBRULES">the drools JIRA</link>. Select
the component <literal>drools-planner</literal>.</para>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Score_calculation/Section-Score_calculation.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Score_calculation/Section-Score_calculation.xml 2009-12-23 18:42:14 UTC (rev 30808)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Score_calculation/Section-Score_calculation.xml 2009-12-23 20:00:51 UTC (rev 30809)
@@ -56,7 +56,7 @@
full score calculation on each solution evaluation. For example, if a single queen moves from y <literal>0</literal>
to <literal>3</literal>, it won't bother to recalculate the "multiple queens on the same horizontal line" constraint
for queens with y <literal>1</literal> or <literal>2</literal>. This is a huge performance gain. <emphasis
- role="bold">Drools-solver gives you this huge performance gain without forcing you to write a very complicated delta
+ role="bold">Drools Planner gives you this huge performance gain without forcing you to write a very complicated delta
based score calculation algorithm.</emphasis> Just let the drools rule engine do the hard work.</para>
<para><emphasis role="bold">Adding more constraints is <emphasis role="bold">easy and </emphasis>scalable</emphasis>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Use_cases_and_examples/Section-Use_cases_and_examples.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Use_cases_and_examples/Section-Use_cases_and_examples.xml 2009-12-23 18:42:14 UTC (rev 30808)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-planner/src/main/docbook/en-US/Chapter-Use_cases_and_examples/Section-Use_cases_and_examples.xml 2009-12-23 20:00:51 UTC (rev 30809)
@@ -12,7 +12,7 @@
<section>
<title>Introduction</title>
- <para>Drools-solver has several examples. In this manual we explain drools-solver mainly using the n queens example.
+ <para>Drools Planner has several examples. In this manual we explain Drools Planner mainly using the n queens example.
So it's advisable to read at least the section about that example. For advanced users, the Examination example is
recommended.</para>
@@ -60,7 +60,7 @@
</itemizedlist>
<para>The most common n queens puzzle is the 8 queens puzzle, with <emphasis>n = 8</emphasis>. We 'll explain
- drools-solver using the 4 queens puzzle as the primary example.</para>
+ Drools Planner using the 4 queens puzzle as the primary example.</para>
<para>A proposed solution could be:</para>
@@ -200,14 +200,14 @@
</tgroup>
</table>
- <para>The drools-solver implementation has not been optimized because it functions as a beginner example.
+ <para>The Drools Planner implementation has not been optimized because it functions as a beginner example.
Nevertheless, it can easily handle 64 queens.</para>
</section>
<section>
<title>Domain class diagram</title>
- <para>Use a good domain model and it will be easier to understand and solve your problem with drools-solver. We
+ <para>Use a good domain model and it will be easier to understand and solve your problem with Drools Planner. We
'll use this domain model for the n queens example:</para>
<figure>
@@ -306,7 +306,7 @@
</table>
<para>A single <literal>NQueens</literal> instance contains a list of all <literal>Queen</literal> instances. It
- is the <literal>Solution</literal> implementation which will be supplied to and retrieved from drools-solver.
+ is the <literal>Solution</literal> implementation which will be supplied to and retrieved from the Solver.
Notice that in the 4 queens example, NQueens's <literal>getN()</literal> method will always return 4.</para>
</section>
</section>
@@ -881,8 +881,8 @@
</tgroup>
</table>
- <para>Geoffrey De Smet (the drools-solver lead) finished 4th in the International Timetabling Competition 2007's
- examination track with a very early version of drools-solver. Many improvements have been made since then.</para>
+ <para>Geoffrey De Smet (the Drools Planner lead) finished 4th in the International Timetabling Competition 2007's
+ examination track with a very early version of Drools Planner. Many improvements have been made since then.</para>
</section>
<section>
More information about the jboss-svn-commits
mailing list