Skip to content

Commit

Permalink
doc clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
ferrall committed Mar 15, 2022
1 parent c182c34 commit 24ae491
Show file tree
Hide file tree
Showing 69 changed files with 2,634 additions and 599 deletions.
78 changes: 0 additions & 78 deletions docs/DDP/list.html

This file was deleted.

34 changes: 31 additions & 3 deletions docs/FiveO/Objective.ox.html
Original file line number Diff line number Diff line change
Expand Up @@ -657,12 +657,12 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
<tr><td colspan="3" class="header" valign="top">Public methods</td></tr><tr class="even">
<td class="declaration"><img class="icon" src="icons/method_s.png">&nbsp;<a href="Objective.ox.html#MLogit___MLogit">MLogit</a></td>
<td class="modifiers"></td>
<td class="description"></td>
<td class="description">Create a multinomial logit model.</td>
</tr>
<tr class="odd">
<td class="declaration"><img class="icon" src="icons/method_s.png">&nbsp;<a href="Objective.ox.html#MLogit___vfunc">vfunc</a></td>
<td class="modifiers"></td>
<td class="description"></td>
<td class="description">Return the log-likelihood vector.</td>
</tr>
</table>

Expand Down Expand Up @@ -773,7 +773,7 @@ <h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><spa
<tr class="even">
<td class="declaration"><img class="icon" src="icons/method_s.png">&nbsp;<a href="Objective.ox.html#MultiNomialChoice___SetD">SetD</a></td>
<td class="modifiers"></td>
<td class="description"></td>
<td class="description">Update <span class="expressions">\(XB\)</span> matrix of indices by observation and option.</td>
</tr>
</table>

Expand Down Expand Up @@ -2611,7 +2611,33 @@ <h3><span class="icon"><img class="icon" src="icons/method.png">&nbsp;</span><sp

<span class="declaration">MLogit :: MLogit ( L , fn , Yname , Xnames )</span>
<dl><dd>
Create a multinomial logit model.

<dl><dt class="parameters">Parameters:</dt><dd class="parameters"><!-- parameter table --!>
<table class="parameter_table">
<tr>
<td class="declaration" valign="baseline">L</td>
<td class="description" valign="baseline">label
</td>
</tr>
<tr>
<td class="declaration" valign="baseline">fn</td>
<td class="description" valign="baseline">string, a file to load the data from using Ox <code>Database.Load()</code>
</td>
</tr>
<tr>
<td class="declaration" valign="baseline">Yname</td>
<td class="description" valign="baseline">string, name or label of the column in the file that contains <var>Y</var><br>
Yname can contain any integers. MNP will translate the unique sorted values into 0...Jvals-1
</td>
</tr>
<tr>
<td class="declaration" valign="baseline">Xnames</td>
<td class="description" valign="baseline">a string of the form <q>var1 var2 ... varN</q></td>
</tr>
</table>
</dd>
</dl>
</dd></dl>

<hr>
Expand All @@ -2620,6 +2646,7 @@ <h3><span class="icon"><img class="icon" src="icons/method.png">&nbsp;</span><sp

<span class="declaration">MLogit :: vfunc ( )</span>
<dl><dd>
Return the log-likelihood vector.

</dd></dl>
<h2><span class="icon"><img class="icon" src="icons/class.png">&nbsp;</span><span class="text">MultiNomialChoice</span></h2>
Expand Down Expand Up @@ -2772,6 +2799,7 @@ <h3><span class="icon"><img class="icon" src="icons/method.png">&nbsp;</span><sp

<span class="declaration">MultiNomialChoice :: SetD ( )</span>
<dl><dd>
Update <span class="expressions">\(XB\)</span> matrix of indices by observation and option.

</dd></dl>

Expand Down
62 changes: 0 additions & 62 deletions docs/FiveO/list.html

This file was deleted.

Loading

0 comments on commit 24ae491

Please sign in to comment.