138 lines
5.8 KiB
HTML
138 lines
5.8 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<link rel="logo icon" href="static/logo.ico" type="image/x-icon">
|
|
|
|
<title>Welcome to the or-tools main documentation hub!</title>
|
|
|
|
<link rel="stylesheet" href="static/documentation_hub.css">
|
|
|
|
</head>
|
|
<body>
|
|
<div id="wrap">
|
|
<div class="rightmenu">
|
|
<div class="description">
|
|
Open source <strong>operations research tools</strong> developed at <em><a href="http://www.google.com">Google</a></em>.
|
|
</div>
|
|
<div class="toolbar">
|
|
<a href="http://code.google.com/p/or-tools/">Project</a>
|
|
|
|
|
<a href="https://plus.google.com/u/0/108010024297451468877/posts">Google+ Or-Tools</a>
|
|
|
|
|
<a href="http://groups.google.com/group/or-tools-discuss">Mailing list</a>
|
|
|
|
|
<a href="http://code.google.com/p/or-tools/downloads/list">Download</a>
|
|
|
|
|
<a href="#new">What's new?</a>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<a href="http://code.google.com/p/or-tools/"><img src="static/or2doodle.gif" width="25%" alt="or-tools doodle" /></a>
|
|
|
|
<hr>
|
|
|
|
<h1>Welcome to the <a href="https://code.google.com/p/or-tools/">or-tools library</a> main documentation hub</h1>
|
|
|
|
|
|
<div class="note">This is work in progress. Pages will be modified, moved or even removed.</div>
|
|
|
|
<div class="safe_trees">Please, think twice before printing. Be green, read on the screen! (Don't do like <a href="http://mail.google.com/mail/help/paper/more.html">those guys</a>!)<br />
|
|
</div>
|
|
|
|
<p>We are working hard to provide useful documentation. The documentation is distributed in several documents:
|
|
|
|
<ul>
|
|
<li>the <strong><a href="http://code.google.com/p/or-tools/wiki/AGettingStarted">Getting started</a></strong> page: explains how to download and install the library.</li>
|
|
<li>the <strong><a href="http://code.google.com/p/or-tools/wiki/Welcome?tm=6">wiki</a></strong>: contains nice examples. It will gradually be replaced by the user's manual.</li>
|
|
<li>the <strong><a href="#user_manual">user's manual</a></strong>: a user's guide that explains the <em>Constraint Programming</em> part of the library.</li>
|
|
<li>the <strong><a href="#tutorial_examples">tutorial examples</a></strong>: all the complete examples presented in the user's manual.</li>
|
|
<li>the <strong><a href="reference_manual/or-tools/index.html">reference manual</a></strong>: the documentation generated by <a href="http://www.doxygen.org/">doxygen</a>.</li>
|
|
<li>the <strong><a href="#presentation_slides">presentation slides</a></strong>: intended for teaching sessions.</li>
|
|
<li>the <strong><a href="#lab_sessions">lab sessions</a></strong>: 50 minutes modules.</li>
|
|
<li>the <strong><a href="faq/index.html">F.A.Q.</a></strong>: frequently asked questions.</li>
|
|
|
|
</ul>
|
|
</p>
|
|
<p>The or-tools documentation is covered by the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.</p>
|
|
<hr>
|
|
<h2>What's new?</h2>
|
|
<hr>
|
|
<p id="new">Here is a little summary:
|
|
<pre id="verbatim">v.0.1.0: (2012-03-21 14:04:14)
|
|
------------------------------
|
|
* Major enhancements to the manual:
|
|
- chapter 3.
|
|
* Minor enhancements to the manual:
|
|
- section SolutionCollectors and Assigments with subsections.
|
|
- index improved.
|
|
* Minor corrections:
|
|
- code in C++.
|
|
|
|
|
|
|
|
</pre></pre>
|
|
</p>
|
|
|
|
<p>This is the <a href="changes_list.txt">list of changes</a>.</p>
|
|
|
|
<hr>
|
|
<h2 id="user_manual">The User's Manual</h2>
|
|
<hr>
|
|
<p>Currently, only chapter 2 is written (without the first and the two last sections).</p>
|
|
<p>With the epub version, you should be able to convert the manual to the right format for your preferred handheld device.</p>
|
|
<h4>Useful links</h4>
|
|
<p><ul>
|
|
<li><a href="user_manual/index.html">Online version</a></li>
|
|
<li class="manual_download"><a href="http://or-tools.googlecode.com/files/user_manual_A4.v.0.1.0.pdf.zip">A4 pdf version</a></li>
|
|
<li class="manual_download"><a href="http://or-tools.googlecode.com/files/user_manual_USletter.v.0.1.0.pdf.zip">Letter pdf version</a></li>
|
|
<li class="manual_download"><a href="http://or-tools.googlecode.com/files/user_manual.v.0.1.0.epub.zip">epub version</a> (experimental)</li>
|
|
</ul></p>
|
|
<h4>Chapter by chapter</h4>
|
|
<p>Soon!</p>
|
|
|
|
<hr>
|
|
<h2 id="tutorial_examples">The tutorial examples</h2>
|
|
<hr>
|
|
<p>You can download all the code at once or pick a single file in the list below. All files are encoded in UTF-8 and we use LF (Unix) newlines.</p>
|
|
<h4>Languages:</h4>
|
|
<p><ul>
|
|
<li class="language" id="C++">C++</li>
|
|
|
|
<dl>
|
|
<dt>all:</dt><dd><a href="http://or-tools.googlecode.com/files/tutorials_C++_examples.zip">tutorial_C++_examples.zip</a></dd>
|
|
<dt>chap2:</dt><dd><a href="tutorials/C++/chap2/cp_is_fun1.cc">cp_is_fun1.cc</a> | <a href="tutorials/C++/chap2/cp_is_fun2.cc">cp_is_fun2.cc</a> |
|
|
<a href="tutorials/C++/chap2/cp_is_fun3.cc">cp_is_fun3.cc</a> | <a href="tutorials/C++/chap2/cp_is_fun4.cc">cp_is_fun4.cc</a> </dd>
|
|
<dt>chap3:</dt><dd></dd>
|
|
</dl>
|
|
|
|
<li class="language" id="Python">Python</li>
|
|
|
|
<dl>
|
|
<dt>all:</dt><dd><a href="http://or-tools.googlecode.com/files/tutorials_Python_examples.zip">tutorial_Python_examples.zip</a></dd>
|
|
<dt>chap2:</dt><dd><a href="tutorials/Python/chap2/cp_is_fun1.py">cp_is_fun1.py</a> | <a href="tutorials/Python/chap2/cp_is_fun2.py">cp_is_fun2.py</a> |
|
|
<a href="tutorials/Python/chap2/cp_is_fun3.py">cp_is_fun3.py</a> | <a href="tutorials/Python/chap2/cp_is_fun4.py">cp_is_fun4.py</a> </dd>
|
|
<dt>chap3:</dt><dd></dd>
|
|
</dl>
|
|
|
|
<li class="language">Java</li>
|
|
<li class="language">C#</li>
|
|
</ul></p>
|
|
|
|
<hr>
|
|
<h2 id="presentation_slides">The presentation slides</h2>
|
|
<hr>
|
|
<p>Soon!</p>
|
|
|
|
<hr>
|
|
<h2 id="lab_sessions">The lab sessions</h2>
|
|
<hr>
|
|
<p>Soon!</p>
|
|
|
|
|
|
<hr>
|
|
<div class="footer">© Copyright 2012, Google</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|