From 8e08ea61ffa1c8604de1bd9fafdce292e6711f5b Mon Sep 17 00:00:00 2001 From: Henrik Tidefelt Date: Tue, 8 Jul 2025 09:02:19 +0200 Subject: [PATCH] Update purity exception for Streams.print Reformulating to match the current MSL where 'print' is declared impure. --- chapters/functions.tex | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/chapters/functions.tex b/chapters/functions.tex index 529c02a76..7fbddb44c 100644 --- a/chapters/functions.tex +++ b/chapters/functions.tex @@ -232,7 +232,7 @@ \section{Pure Modelica Functions}\label{pure-modelica-functions} If a function is declared as \lstinline!impure! any function extending from it shall be declared as \lstinline!impure!. \item A deprecated semantics is that external functions (and functions defined in Modelica directly or indirectly calling them) without \lstinline!pure! or \lstinline!impure! keyword are assumed to be impure, but without any restriction on calling them. - Except for the function \lstinline!Modelica.Utilities.Streams.print!, a diagnostic must be given if called in a simulation model. + A diagnostic must be given if called in a simulation model. \end{itemize} Calls of pure functions used inside expression may be skipped if the resulting expression will not depend on the possible returned value; ignoring the possibility of the function generating an error. @@ -279,11 +279,13 @@ \section{Pure Modelica Functions}\label{pure-modelica-functions} Binding equations for external objects. \end{itemize} +An exception is made for \lstinline!Modelica.Utilities.Streams.print!, for which none of the impure function restrictions apply. + It is an error if an impure function call is part of a systems of equations (including linear systems), even if called in agreement with the restrictions above. The reason is that solving systems of equations generally requires expressions to be evaluated an unknown number of times. This includes the special handling of \lstinline!when initial()! during initialization. -There are two ways in which an impure function could be called in a system of equations, namely in the deprecated case of external functions assumed to be impure, and when using \lstinline!pure($\ldots$)! to call an impure function from within a pure function. +There are three ways in which an impure function could be called in a system of equations, namely in the deprecated case of external functions assumed to be impure, when using \lstinline!pure($\ldots$)! to call an impure function from within a pure function, and the exception for \lstinline!Modelica.Utilities.Streams.print!. The side-effect semantics of the function call are then undefined. Specifically, the number of calls with external side-effects is unspecified. However, for impure functions where the outputs only depend on the inputs the system of equations should be solved correctly.