From 7d058359305f14999cc2138cfcb33624053568f0 Mon Sep 17 00:00:00 2001 From: Nikolai Fast Date: Sun, 10 Nov 2024 17:13:28 +0100 Subject: [PATCH] Fixed typos --- docs/2_2_common_mechanisms.adoc | 6 +++--- docs/2_4_common_schema.adoc | 2 +- docs/2_5_fmu_distribution.adoc | 2 +- docs/examples/co_simulation_early_return.xml | 2 +- docs/images/cs_intermediate_update.svg | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/2_2_common_mechanisms.adoc b/docs/2_2_common_mechanisms.adoc index 7ac34dbdd..a6bbb01a1 100644 --- a/docs/2_2_common_mechanisms.adoc +++ b/docs/2_2_common_mechanisms.adoc @@ -1151,7 +1151,7 @@ with the Jacobian \end{bmatrix} ++++ -where latexmath:[\mathbf{v}_{\mathit{known}}] are the latexmath:[n] knowns, and latexmath:[\mathbf{g}] are the latexmath:[m] functions to calculate the latexmath:[m] unknown variables latexmath:[\mathbf{v}_{\mathit{unknwon}}] from the knowns. +where latexmath:[\mathbf{v}_{\mathit{known}}] are the latexmath:[n] knowns, and latexmath:[\mathbf{g}] are the latexmath:[m] functions to calculate the latexmath:[m] unknown variables latexmath:[\mathbf{v}_{\mathit{unknown}}] from the knowns. Both functions can also be used to construct the partial derivative matrices. The functions may only be called if their availability is indicated by the attributes <> and <>, respectively. @@ -1217,7 +1217,7 @@ _Note that a direct implementation of this function with analytic derivatives:_ (b) _Initializes all seed-values to zero; so in the <>: latexmath:[{\Delta x = \Delta u_1 = \Delta u_3 = \Delta u_4 = 0}]_ -(c) _Computes the directional derivative with the seed-values provided in the function arguments; so in the <>: latexmath:[{v_{\mathit{sensitivity}} = \Delta y_1 (\Delta x = 0, \Delta u_1 = 1, \Delta u_3 = 0, \Delta u_4 = 0)}]] and latexmath:[{v_{\mathit{sensitivity}} = \Delta y_1 (\Delta x = 0, \Delta u_1 = 0, \Delta u_3 = 1, \Delta u_4 = 0)}]]_ +(c) _Computes the directional derivative with the seed-values provided in the function arguments; so in the <>: latexmath:[{v_{\mathit{sensitivity}} = \Delta y_1 (\Delta x = 0, \Delta u_1 = 1, \Delta u_3 = 0, \Delta u_4 = 0)}] and latexmath:[{v_{\mathit{sensitivity}} = \Delta y_1 (\Delta x = 0, \Delta u_1 = 0, \Delta u_3 = 1, \Delta u_4 = 0)}]]_ _[Note, function <> can be utilized for the following purposes:_ @@ -1227,7 +1227,7 @@ _[Note, function <> can be utilized for the follow - _If the FMU shall be linearized, the same <> as in the previous item are needed._ -- _If the FMU is used as the model for an extended Kalman filter, latexmath:[{\frac{\partial \mathbf{f}}{\partial \mathbf{x}}}] and latexmath:[{\frac{\partial \mathbf{g}}{\partial \mathbf{x}}}] are needed._ +- _If the FMU is used as the model for an extended Kalman filter, latexmath:[{\frac{\partial \mathbf{f}}{\partial \mathbf{x}}}] and latexmath:[{\frac{\partial \mathbf{g}}{\partial \mathbf{x}}}] are needed._] _If a dense matrix shall be computed, the columns of the matrix can be easily constructed by successive calls of <>._ _For example, constructing the system Jacobian latexmath:[{\mathbf{J} = \frac{\partial \mathbf{f}}{\partial \mathbf{x}}}] as dense matrix can be performed in the following way:_ diff --git a/docs/2_4_common_schema.adoc b/docs/2_4_common_schema.adoc index 3043b1760..b9bb65f8d 100644 --- a/docs/2_4_common_schema.adoc +++ b/docs/2_4_common_schema.adoc @@ -2339,7 +2339,7 @@ image::images/schema/Library.png[width=50%] |`version` |Version specifier of the library as defined in https://www.python.org/dev/peps/pep-0440/#version-specifiers[PEP 440]. -The characters `>` (greater-than) and `<` (less-than) must be escaped as `>` and `<`. +The characters `>` (greater-than) and `<` (less-than) must be escaped as `&gt;` and `&lt;`. _[For example `2.5`, `>=2.0,<3.0` or `>=1.0,!=1.2`]_. |`external` diff --git a/docs/2_5_fmu_distribution.adoc b/docs/2_5_fmu_distribution.adoc index 0d1c992a7..8bd6d8316 100644 --- a/docs/2_5_fmu_distribution.adoc +++ b/docs/2_5_fmu_distribution.adoc @@ -138,7 +138,7 @@ Operating system ``:: |==== When shipping the implementation as a static library an optional ABI (Application Binary Interface) directory `-{-}` may be added to separate binaries for different toolchains on the same platform and a description must be provided in `documentation/staticLinking.{txt|html}` that contains all necessary information to link against the provided library _[e.g. supported compilers]_. -The ABI directory must only contain lowercase characters `a...z`, digits `0...9`, and underscores `_` and start with a lowercase character `a...z` _[e.g. `x86_64-windows-msvc140mt` for a static library for 64-bit Windows generated with Visual Studio 2015 with `/MT` flag]_. +The ABI directory must only contain lowercase characters `a...z`, digits `0...9`, and underscores `$$_$$` and start with a lowercase character `a...z` _[e.g. `x86_64-windows-msvc140mt` for a static library for 64-bit Windows generated with Visual Studio 2015 with `/MT` flag]_. ====== Platform Tuple Examples [[platform-tuple-examples]] diff --git a/docs/examples/co_simulation_early_return.xml b/docs/examples/co_simulation_early_return.xml index 8462f3dc4..167706e2a 100644 --- a/docs/examples/co_simulation_early_return.xml +++ b/docs/examples/co_simulation_early_return.xml @@ -1,4 +1,4 @@ - + +