Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@ferrall
ferrall committed Nov 9, 2021
1 parent 5130666 commit 612c71e
Show file tree
Hide file tree
Showing 15 changed files with 904 additions and 523 deletions.
8 changes: 4 additions & 4 deletions docs/DDP/GetStarted.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -405,11 +405,11 @@ <h4>4 functions of <code>z*</code></h4>
<img src="./ContinuousOffers.png"/>
<LI>Code and Output</LI>
<DT>Header File</DT>
<dd><pre>Source: <a href="javascript:popoxcode('../../examples/misc/WstarTest.h');">examples/misc/WstarTest.h</a>
<object width="100%" height="100" type="text/plain" data="../../examples/misc/WstarTest.h" border="1" ></object></pre></dd>
<dd><pre>Source: <a href="javascript:popoxcode('../../examples/misc/WStarA.h');">examples/misc/WStarA.h</a>
<object width="100%" height="100" type="text/plain" data="../../examples/misc/WStarA.h" border="1" ></object></pre></dd>
<DT>Ox File</DT>
<DD><pre>Source: <a href="javascript:popoxcode('../../examples/misc/WstarTest.ox');">examples/misc/WstarTest.ox</a>
<object width="100%" height="200" type="text/plain" data="../../examples/misc/WstarTest.ox" border="1" ></object></pre></dd>
<DD><pre>Source: <a href="javascript:popoxcode('../../examples/misc/WStarA.ox');">examples/misc/WStarA.ox</a>
<object width="100%" height="200" type="text/plain" data="../../examples/misc/WStarA.ox" border="1" ></object></pre></dd>
<DT>Output</DT>
<DD><pre>Source: <a href="javascript:popoxcode('../../examples/output/Finite_Horizon.txt');">examples/output/Finite_Horizon.txt</a>
<object width="100%" height="200" type="text/plain" data="../../examples/output/Finite_Horizon.txt" border="1" ></object></pre></dd>
Expand Down
70 changes: 57 additions & 13 deletions docs/DDP/Methods.ox.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,18 +190,18 @@ <h4>4 functions of <code>z*</code></h4>
<img src="./ContinuousOffers.png"/>
<LI>Code and Output</LI>
<DT>Header File</DT>
<dd><pre>Source: <a href="javascript:popoxcode('../../examples/misc/WstarTestb.h');">examples/misc/WstarTestb.h</a>
<object width="100%" height="100" type="text/plain" data="../../examples/misc/WstarTestb.h" border="1" ></object></pre></dd>
<dd><pre>Source: <a href="javascript:popoxcode('../../examples/misc/WStarA.h');">examples/misc/WStarA.h</a>
<object width="100%" height="100" type="text/plain" data="../../examples/misc/WStarA.h" border="1" ></object></pre></dd>
<DT>Ox File</DT>
<DD><pre>Source: <a href="javascript:popoxcode('../../examples/WstarTestb.ox');">examples/misc/WstarTestb.ox</a>
<DD><pre>Source: <a href="javascript:popoxcode('../../examples/WStarB.ox');">examples/misc/WStarA.ox</a>
<object width="100%" height="200" type="text/plain" data="../../examples/misc/WstarTestb.ox" border="1" ></object></pre></dd>
<DT>Output</DT>
<DD><pre>Source: <a href="javascript:popoxcode('../../examples/output/Reservation_Wage_Test.txt');">examples/output/Reservation_Wage_Test.txt</a>
<object width="100%" height="200" type="text/plain" data="../../examples/output/Reservation_Wage_Test.txt" border="1" ></object></pre></dd>
<P/>
<DT>Graph of Reservation values</DT>
<DD><pre>Source: <a href="../../examples/misc/WstarTestb.pdf">examples/misc/WstarTestb.pdf</a>
<object width="100%" height="200" type="application/pdf" data="../../examples/WstarTestb.pdf" border="1" >PDF</object></pre></dd>
<DD><pre>Source: <a href="../../examples/misc/WStarA.pdf">examples/misc/WStarA.pdf</a>
<object width="100%" height="200" type="application/pdf" data="../../examples/WstarA.pdf" border="1" >PDF</object></pre></dd>
</OL>
<P/>
</OL>
Expand Down Expand Up @@ -255,7 +255,7 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa

<dl class="inherited">
<dt>Inherited methods from <a href="Methods.ox.html#HotzMiller">HotzMiller</a>:</dt><dd><a href="Methods.ox.html#HotzMiller___AMiter">AMiter</a>, <a href="Methods.ox.html#HotzMiller___EmpiricalCCP">EmpiricalCCP</a>, <a href="Methods.ox.html#HotzMiller___HotzMiller">HotzMiller</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a>, <a href="Methods.ox.html#Method___Tune">Tune</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#FETask">FETask</a>:</dt><dd><a href="DP.ox.html#FETask___~FETask">~FETask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#GroupTask">GroupTask</a>:</dt><dd><a href="DP.ox.html#GroupTask___~GroupTask">~GroupTask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#Task">Task</a>:</dt><dd><a href="DP.ox.html#Task___list">list</a>, <a href="DP.ox.html#Task___SyncStates">SyncStates</a>, <a href="DP.ox.html#Task___~Task">~Task</a></dd>
Expand Down Expand Up @@ -582,7 +582,7 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
</table>

<dl class="inherited">
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a>, <a href="Methods.ox.html#Method___Tune">Tune</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#FETask">FETask</a>:</dt><dd><a href="DP.ox.html#FETask___~FETask">~FETask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#GroupTask">GroupTask</a>:</dt><dd><a href="DP.ox.html#GroupTask___~GroupTask">~GroupTask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#Task">Task</a>:</dt><dd><a href="DP.ox.html#Task___list">list</a>, <a href="DP.ox.html#Task___SyncStates">SyncStates</a>, <a href="DP.ox.html#Task___~Task">~Task</a></dd>
Expand Down Expand Up @@ -745,7 +745,7 @@ <h3>Details</h3>

<dl class="inherited">
<dt>Inherited methods from <a href="Methods.ox.html#ValueIteration">ValueIteration</a>:</dt><dd><a href="Methods.ox.html#ValueIteration___Solve">Solve</a>, <a href="Methods.ox.html#ValueIteration___ValueIteration">ValueIteration</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a>, <a href="Methods.ox.html#Method___Tune">Tune</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#FETask">FETask</a>:</dt><dd><a href="DP.ox.html#FETask___~FETask">~FETask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#GroupTask">GroupTask</a>:</dt><dd><a href="DP.ox.html#GroupTask___~GroupTask">~GroupTask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#Task">Task</a>:</dt><dd><a href="DP.ox.html#Task___list">list</a>, <a href="DP.ox.html#Task___SyncStates">SyncStates</a>, <a href="DP.ox.html#Task___~Task">~Task</a></dd>
Expand Down Expand Up @@ -837,7 +837,8 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
<tr><td colspan="3" class="header" valign="top">Public fields</td></tr><tr class="even">
<td class="declaration"><img class="icon" src="icons/field_s.png">&nbsp;<a href="Methods.ox.html#Method___DefTolerance">DefTolerance</a></td>
<td class="modifiers">static const</td>
<td class="description">Default convergence tolerance on Bellman Iteration.</td>
<td class="description">Default convergence tolerance on Bellman Iteration for stationary
environments = <a href="Shared.ox.html#DIFF_EPS">DIFF_EPS</a> = 10^{-8}.</td>
</tr>
<tr class="odd">
<td class="declaration"><img class="icon" src="icons/field_s.png">&nbsp;<a href="Methods.ox.html#Method___DoNotIterate">DoNotIterate</a></td>
Expand Down Expand Up @@ -881,6 +882,11 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
<td class="modifiers"></td>
<td class="description">Toggle whether to check for NaNs in value iteration.</td>
</tr>
<tr class="even">
<td class="declaration"><img class="icon" src="icons/method_s.png">&nbsp;<a href="Methods.ox.html#Method___Tune">Tune</a></td>
<td class="modifiers">virtual</td>
<td class="description">Set basic parameters of a solution method.</td>
</tr>
</table>

<dl class="inherited">
Expand Down Expand Up @@ -1113,7 +1119,7 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
</table>

<dl class="inherited">
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a>, <a href="Methods.ox.html#Method___Tune">Tune</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#FETask">FETask</a>:</dt><dd><a href="DP.ox.html#FETask___~FETask">~FETask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#GroupTask">GroupTask</a>:</dt><dd><a href="DP.ox.html#GroupTask___~GroupTask">~GroupTask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#Task">Task</a>:</dt><dd><a href="DP.ox.html#Task___list">list</a>, <a href="DP.ox.html#Task___SyncStates">SyncStates</a>, <a href="DP.ox.html#Task___~Task">~Task</a></dd>
Expand Down Expand Up @@ -1293,7 +1299,7 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
</table>

<dl class="inherited">
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a>, <a href="Methods.ox.html#Method___Tune">Tune</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#FETask">FETask</a>:</dt><dd><a href="DP.ox.html#FETask___~FETask">~FETask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#GroupTask">GroupTask</a>:</dt><dd><a href="DP.ox.html#GroupTask___~GroupTask">~GroupTask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#Task">Task</a>:</dt><dd><a href="DP.ox.html#Task___list">list</a>, <a href="DP.ox.html#Task___SyncStates">SyncStates</a>, <a href="DP.ox.html#Task___~Task">~Task</a></dd>
Expand Down Expand Up @@ -1333,7 +1339,7 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
</table>

<dl class="inherited">
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a></dd>
<dt>Inherited methods from <a href="Methods.ox.html#Method">Method</a>:</dt><dd><a href="Methods.ox.html#Method___Method">Method</a>, <a href="Methods.ox.html#Method___ToggleIterate">ToggleIterate</a>, <a href="Methods.ox.html#Method___ToggleRunSafe">ToggleRunSafe</a>, <a href="Methods.ox.html#Method___Tune">Tune</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#FETask">FETask</a>:</dt><dd><a href="DP.ox.html#FETask___~FETask">~FETask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#GroupTask">GroupTask</a>:</dt><dd><a href="DP.ox.html#GroupTask___~GroupTask">~GroupTask</a></dd>
<dt>Inherited methods from <a href="DP.ox.html#Task">Task</a>:</dt><dd><a href="DP.ox.html#Task___list">list</a>, <a href="DP.ox.html#Task___SyncStates">SyncStates</a>, <a href="DP.ox.html#Task___~Task">~Task</a></dd>
Expand Down Expand Up @@ -2077,8 +2083,11 @@ <h3><span class="icon"><img class="icon" src="icons/field.png">&nbsp;</span><spa

<span class="declaration">static const decl DefTolerance [public]</span>
<dl><dd>
Default convergence tolerance on Bellman Iteration.
Default convergence tolerance on Bellman Iteration for stationary
environments = <a href="Shared.ox.html#DIFF_EPS">DIFF_EPS</a> = 10^{-8}.

<dl><dt class="seealso">See also:</dt><dd class="seealso"><a href="Methods.ox.html#Method___Tune">Tune</a>, <a href="Variables.ox.html#Clock___normparam">normparam</a></dd>
</dl>
</dd></dl>

<hr>
Expand Down Expand Up @@ -2186,6 +2195,41 @@ <h3><span class="icon"><img class="icon" src="icons/method.png">&nbsp;</span><sp
</dl>
</dd></dl>

<hr>
<a name="Method___Tune"></a>
<h3><span class="icon"><img class="icon" src="icons/method.png">&nbsp;</span><span class="text">Tune</span></h3>

<span class="declaration">virtual Method :: Tune ( Volume , vtoler , MaxTrips , NormType )</span>
<dl><dd>
Set basic parameters of a solution method.

<dl><dt class="parameters">Parameters:</dt><dd class="parameters"><!-- parameter table --!>
<table class="parameter_table">
<tr>
<td class="declaration" valign="baseline">Volume</td>
<td class="description" valign="baseline"> UseCurrent (-2) do not change<br/>
Volume level for output, <br/>
vtoler UseCurrent (-2) do not change<br/>
convergence criteria for stationary problems (fixed points)<br/>
MaxTrips UseCurrent (-2) do not change<br/>
integer: set the total number of iterations to perform (stationary problems)<br/>
0 : unlimited trips (stopping determined by tolerance and convergence)<br/>
NormType set the norm() itype argument for Ox's norm(v,itype) function<br/>
only applies to stationary phases of clocks.<br/>
UseCurrent(-2) do not change (default=2,Euclidean)<br/>
0: infinity norm, maximum absolute value,<br/>
1: sum of absolute values,<br/>
2: square root of sum of squares,<br/>
p: p-th root of sum of absolute elements raised to the power p.<br/>
-1: minimum absolute value,<br/>
</td>
</tr>
</table>
</dd>
<dt class="seealso">See also:</dt><dd class="seealso"><a href="Shared.ox.html#NoiseLevels">NoiseLevels</a></dd>
</dl>
</dd></dl>

<hr>
<a name="Method___Volume"></a>
<h3><span class="icon"><img class="icon" src="icons/field.png">&nbsp;</span><span class="text">Volume</span></h3>
Expand Down
Loading

0 comments on commit 612c71e

Please sign in to comment.