Skip to content

Commit

Permalink
Add comments with TODOs after LaTeXML issue is fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
henrikt-ma committed Mar 2, 2021
1 parent fee21a0 commit 31528c1
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
9 changes: 5 additions & 4 deletions chapters/classes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1562,6 +1562,8 @@ \subsubsection{Attributes of Enumeration Types}\label{attributes-of-enumeration-

\subsubsection{Type Conversion of Enumeration Values to String or Integer}\label{type-conversion-of-enumeration-values-to-string-or-integer}

% TODO: Use $\langle\mbox{\emph{expression of enumeration type}}\rangle$ once LaTeXML issue has been fixed:
% https://github.com/brucemiller/LaTeXML/issues/1477
The type conversion function \lstinline!Integer($\mbox{\emph{\textless{}expression of enumeration type\textgreater{}}}$)! returns the ordinal number of the enumeration value \lstinline!E.enumvalue!, to which the expression is evaluated, where $\text{\lstinline!Integer(E.e1)!} = 1$, $\text{\lstinline!Integer(E.en)!} = n$, for an enumeration type \lstinline!E = enumeration(e1, $\ldots$, en)!.

\lstinline!String(E.enumvalue)! gives the \lstinline!String! representation of the enumeration value.
Expand All @@ -1579,10 +1581,9 @@ \subsubsection{Type Conversion of Integer to Enumeration Values}\label{type-conv
implicitly defined. This function can be used in an expression to
convert an integer value to the corresponding (as described in \cref{type-conversion-of-enumeration-values-to-string-or-integer}) enumeration value.

For an enumeration type named \lstinline!EnumTypeName!, the expression
\lstinline!EnumTypeName(<Integer expression>)! returns the
enumeration value \lstinline!EnumTypeName.e! such that \lstinline!Integer(EnumTypeName.e)! is
equal to the original integer expression.
% TODO: Use $\langle\mbox{\emph{Integer expression}}\rangle$ once LaTeXML issue has been fixed:
% https://github.com/brucemiller/LaTeXML/issues/1477
For an enumeration type named \lstinline!EnumTypeName!, the expression \lstinline!EnumTypeName(<Integer expression>)! returns the enumeration value \lstinline!EnumTypeName.e! such that \lstinline!Integer(EnumTypeName.e)! is equal to the original integer expression.

Attempting to convert an integer argument that does not correspond to a
value of the enumeration type is an error.
Expand Down
5 changes: 4 additions & 1 deletion chapters/connectors.tex
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,10 @@ \subsection{Overconstrained Equation Operators for Connection Graphs}\label{over
This function can be used at all places where a \lstinline!connect! statement is allowed.

\begin{nonnormative}
E.g., it is not allowed to use this function in a when-clause. This definition shall be used if in a model with connectors \lstinline!A! and \lstinline!B! the overdetermined records \lstinline!A.R! and \lstinline!B.R! are algebraically coupled in the model, e.g., due to \lstinline!B.R = f(A.R!, \textless{}other unknowns\textgreater{}).
% TODO: Use $\langle\mbox{\emph{other unknowns}}\rangle$ once LaTeXML issue has been fixed:
% https://github.com/brucemiller/LaTeXML/issues/1477
E.g., it is not allowed to use this function in a when-clause.
This definition shall be used if in a model with connectors \lstinline!A! and \lstinline!B! the overdetermined records \lstinline!A.R! and \lstinline!B.R! are algebraically coupled in the model, e.g., due to \lstinline!B.R = f(A.R!, \textless{}other unknowns\textgreater{}).
\end{nonnormative}
\end{semantics}
\end{operatordefinition}
Expand Down
2 changes: 2 additions & 0 deletions chapters/functions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ \section{Function Declaration}\label{function-declaration}
\begin{nonnormative}
The structure of a typical function declaration is sketched by
the following schematic function example:
% TODO: Use $\langle\mbox{\emph{local variables}}\rangle$ (similar for 'statements'), and get rid of escapechar once LaTeXML issue has been fixed:
% https://github.com/brucemiller/LaTeXML/issues/1477
\begin{lstlisting}[language=modelica,escapechar=!]
function $\mathit{functionname}$
input TypeI1 in1;
Expand Down
2 changes: 2 additions & 0 deletions chapters/synchronous.tex
Original file line number Diff line number Diff line change
Expand Up @@ -812,6 +812,8 @@ \subsection{Sub-clock conversion operators}\label{sub-clock-conversion-operators
\section{Clocked When-Clause}\label{clocked-when-clause}

In addition to the previously discussed conditional when-clause, a \emph{clocked} when-clause\index{clocked!when-clause}\index{when-clause!clocked} is introduced:
% TODO: Use $\langle\mbox{\emph{clocked equations}}\rangle$ and get rid of escapechar once LaTeXML issue has been fixed:
% https://github.com/brucemiller/LaTeXML/issues/1477
\begin{lstlisting}[language=modelica,escapechar=!]
when $\mathit{clockExpression}$ then
!\emph{\textless{}clocked equations\textgreater{}}!
Expand Down

0 comments on commit 31528c1

Please sign in to comment.