Add operators, functions, and a few annotations

modelica · Dec 3, 2020 · 6c4054d · 6c4054d
1 parent c61b1d6
commit 6c4054d
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 76 deletions.
diff --git a/chapters/arrays.tex b/chapters/arrays.tex
@@ -198,7 +198,7 @@ \section{Built-in Array Functions}\label{built-in-array-functions}
 \end{tabular}
 \end{center}
 
-\begin{operatordefinition*}[promote]\label{not-modelica-promote}
+\begin{operatordefinition*}[promote]\label{not-modelica-promote}\index{promote@\indexinline{promote}}
 \begin{synopsis}\begin{lstlisting}
 promote($A$, $n$) /* Not available in Modelica. */
 \end{lstlisting}\end{synopsis}
@@ -245,7 +245,7 @@ \subsection{Array Dimension and Size Functions}\label{array-dimension-and-size-f
 \end{tabular}
 \end{center}
 
-\begin{operatordefinition}[ndims]\index{ndims@\indexinline{ndims}}
+\begin{operatordefinition}[ndims]
 \begin{synopsis}\begin{lstlisting}
 ndims($A$)
 \end{lstlisting}\end{synopsis}
@@ -438,7 +438,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{tabular}
 \end{center}
 
-\begin{operatordefinition*}[min]\label{modelica:min-of-array}
+\begin{operatordefinition*}[min]\label{modelica:min-of-array}\index{min@\indexinline{min}!of array}
 \begin{synopsis}\begin{lstlisting}
 min($A$)
 \end{lstlisting}\end{synopsis}
@@ -447,7 +447,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[min]\label{modelica:min-binary}
+\begin{operatordefinition*}[min]\label{modelica:min-binary}\index{min@\indexinline{min}!binary function}
 \begin{synopsis}\begin{lstlisting}
 min($x$, $y$)
 \end{lstlisting}\end{synopsis}
@@ -456,7 +456,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[min]\label{modelica:min-reduction}
+\begin{operatordefinition*}[min]\label{modelica:min-reduction}\index{min@\indexinline{min}!reduction expression}
 \begin{synopsis}\begin{lstlisting}
 min($e$($i$, $\ldots$, $j$) for $i$ in $u$, $\ldots$, $j$ in $v$)
 \end{lstlisting}\end{synopsis}
@@ -465,7 +465,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[max]\label{modelica:max-of-array}
+\begin{operatordefinition*}[max]\label{modelica:max-of-array}\index{max@\indexinline{max}!of array}
 \begin{synopsis}\begin{lstlisting}
 max($A$)
 \end{lstlisting}\end{synopsis}
@@ -474,7 +474,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[max]\label{modelica:max-binary}
+\begin{operatordefinition*}[max]\label{modelica:max-binary}\index{max@\indexinline{max}!binary function}
 \begin{synopsis}\begin{lstlisting}
 max($x$, $y$)
 \end{lstlisting}\end{synopsis}
@@ -483,7 +483,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[max]\label{modelica:max-reduction}
+\begin{operatordefinition*}[max]\label{modelica:max-reduction}\index{max@\indexinline{max}!reduction expression}
 \begin{synopsis}\begin{lstlisting}
 max($e$($i$, $\ldots$, $j$) for $i$ in $u$, $\ldots$, $j$ in $v$)
 \end{lstlisting}\end{synopsis}
@@ -492,7 +492,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[sum]\label{modelica:sum-of-array}
+\begin{operatordefinition*}[sum]\label{modelica:sum-of-array}\index{sum@\indexinline{sum}!of array}
 \begin{synopsis}\begin{lstlisting}
 sum($A$)
 \end{lstlisting}\end{synopsis}
@@ -501,7 +501,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[sum]\label{modelica:sum-reduction}
+\begin{operatordefinition*}[sum]\label{modelica:sum-reduction}\index{sum@\indexinline{sum}!reduction expression}
 \begin{synopsis}\begin{lstlisting}
 sum($e$($i$, $\ldots$, $j$) for $i$ in $u$, $\ldots$, $j$ in $v$)
 \end{lstlisting}\end{synopsis}
@@ -523,7 +523,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[product]\label{modelica:product-of-array}
+\begin{operatordefinition*}[product]\label{modelica:product-of-array}\index{product@\indexinline{product}!of array}
 \begin{synopsis}\begin{lstlisting}
 product($A$)
 \end{lstlisting}\end{synopsis}
@@ -533,7 +533,7 @@ \subsection{Reduction Functions and Operators}\label{reduction-functions-and-ope
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition*}[product]\label{modelica:product-reduction}
+\begin{operatordefinition*}[product]\label{modelica:product-reduction}\index{product@\indexinline{product}!reduction expression}
 \begin{synopsis}\begin{lstlisting}
 product($e$($i$, $\ldots$, $j$) for $i$ in $u$, $\ldots$, $j$ in $v$)
 \end{lstlisting}\end{synopsis}

diff --git a/chapters/connectors.tex b/chapters/connectors.tex
@@ -856,7 +856,7 @@ \subsection{Overconstrained Equation Operators for Connection Graphs}\label{over
 \end{tabular}
 \end{center}
 
-\begin{operatordefinition*}[connect]\label{modelica:optional-spanning-tree-edge}
+\begin{operatordefinition*}[connect]\label{modelica:optional-spanning-tree-edge}\index{connect@\indexinline{connect}!overconstrained equation operator}
 \begin{synopsis}\begin{lstlisting}
 connect(A, B)
 \end{lstlisting}\end{synopsis}
@@ -866,7 +866,7 @@ \subsection{Overconstrained Equation Operators for Connection Graphs}\label{over
 \end{semantics}
 \end{operatordefinition*}
 
-\begin{operatordefinition}[Connections.branch]\index{Connections.branch@\indexinline{Connections.branch}}
+\begin{operatordefinition}[Connections.branch]
 \begin{synopsis}\begin{lstlisting}
 Connections.branch(A.R, B.R)
 \end{lstlisting}\end{synopsis}
@@ -880,7 +880,7 @@ \subsection{Overconstrained Equation Operators for Connection Graphs}\label{over
 \end{semantics}
 \end{operatordefinition}
 
-\begin{operatordefinition}[Connections.root]\index{Connections.root@\indexinline{Connections.root}}
+\begin{operatordefinition}[Connections.root]
 \begin{synopsis}\begin{lstlisting}
 Connections.root(A.R)
 \end{lstlisting}\end{synopsis}
@@ -893,7 +893,7 @@ \subsection{Overconstrained Equation Operators for Connection Graphs}\label{over
 \end{semantics}
 \end{operatordefinition}
 
-\begin{operatordefinition}[Connections.potentialRoot]\index{Connections.potentialRoot@\indexinline{Connections.potentialRoot}}
+\begin{operatordefinition}[Connections.potentialRoot]
 \begin{synopsis}\begin{lstlisting}
 Connections.potentialRoot(A.R)
 Connections.potentialRoot(A.R, priority=$p$)
@@ -909,7 +909,7 @@ \subsection{Overconstrained Equation Operators for Connection Graphs}\label{over
 \end{semantics}
 \end{operatordefinition}
 
-\begin{operatordefinition}[Connections.isRoot]\index{Connections.isRoot@\indexinline{Connections.isRoot}}
+\begin{operatordefinition}[Connections.isRoot]
 \begin{synopsis}\begin{lstlisting}
 Connections.isRoot(A.R)
 \end{lstlisting}\end{synopsis}
@@ -918,7 +918,7 @@ \subsection{Overconstrained Equation Operators for Connection Graphs}\label{over
 \end{semantics}
 \end{operatordefinition}
 
-\begin{operatordefinition}[Connections.rooted]\index{Connections.rooted@\indexinline{Connections.rooted}}
+\begin{operatordefinition}[Connections.rooted]
 \begin{synopsis}\begin{lstlisting}
 Connections.rooted(A.R)
 rooted(A.R) // deprecated!

diff --git a/chapters/functions.tex b/chapters/functions.tex
@@ -2366,7 +2366,8 @@ \subsubsection{Utility Functions for Reporting Errors}\label{utility-functions-f
 error similarly to an \lstinline!assert! with \lstinline!level = AssertionLevel.Error! in the
 Modelica code.
 
-\begin{functiondefinition*}[ModelicaMessage, ModelicaWarning, ModelicaError]\label{modelica:ModelicaMessage-et-al}
+\begin{functiondefinition*}[ModelicaMessage, ModelicaWarning, ModelicaError]\label{modelica:ModelicaMessage-et-al}%
+\index{ModelicaMessage@\indexinline{ModelicaMessage}}\index{ModelicaWarning@\indexinline{ModelicaWarning}}\index{ModelicaError@\indexinline{ModelicaError}}
 \begin{synopsis}[C]\begin{lstlisting}
 void ModelicaMessage(const char* $\mathit{string}$)
 void ModelicaWarning(const char* $\mathit{string}$)
@@ -2377,7 +2378,8 @@ \subsubsection{Utility Functions for Reporting Errors}\label{utility-functions-f
 \end{semantics}
 \end{functiondefinition*}
 
-\begin{functiondefinition*}[ModelicaFormatMessage, ModelicaFormatWarning, ModelicaFormatError]\label{modelica:ModelicaFormatMessage-et-al}
+\begin{functiondefinition*}[ModelicaFormatMessage, ModelicaFormatWarning, ModelicaFormatError]\label{modelica:ModelicaFormatMessage-et-al}%
+\index{ModelicaFormatMessage@\indexinline{ModelicaMessage}}\index{ModelicaFormatWarning@\indexinline{ModelicaWarning}}\index{ModelicaFormatError@\indexinline{ModelicaError}}
 \begin{synopsis}[C]
 % Note that the "..." below are actual C code, and shouldn't be typeset as \ldots.
 \begin{lstlisting}
@@ -2390,7 +2392,8 @@ \subsubsection{Utility Functions for Reporting Errors}\label{utility-functions-f
 \end{semantics}
 \end{functiondefinition*}
 
-\begin{functiondefinition*}[ModelicaVFormatMessage, ModelicaVFormatWarning, ModelicaVFormatError]\label{modelica:ModelicaVFormatMessage-et-al}
+\begin{functiondefinition*}[ModelicaVFormatMessage, ModelicaVFormatWarning, ModelicaVFormatError]\label{modelica:ModelicaVFormatMessage-et-al}%
+\index{ModelicaVFormatMessage@\indexinline{ModelicaMessage}}\index{ModelicaVFormatWarning@\indexinline{ModelicaWarning}}\index{ModelicaVFormatError@\indexinline{ModelicaError}}
 \begin{synopsis}[C]\begin{lstlisting}
 void ModelicaVFormatMessage(const char* $\mathit{format}$, va_list $\mathit{ap}$)
 void ModelicaVFormatWarning(const char* $\mathit{format}$, va_list $\mathit{ap}$)