Avoid speaking of 'instance hierarchy'#3916
Conversation
henrikt-ma
force-pushed
the
cleanup/instance-hierarchy
branch
from
104d263 to
acef07f
Compare
|
Maybe it would be a good idea to update the labels too, such as |
Yes, they should be consistent. |
| \section{Inner Declarations - Instance Tree Name Lookup}\label{instance-hierarchy-name-lookup-of-inner-declarations}\label{inner-declarations-instance-hierarchy-name-lookup} | ||
|
|
||
| An element declared with the prefix \lstinline!outer!\indexinline{outer} references an element instance with the same name but using the prefix \lstinline!inner!\indexinline{inner} which is nearest in the enclosing instance hierarchy of the \lstinline!outer! element declaration. | ||
| An element declared with the prefix \lstinline!outer!\indexinline{outer} references an element instance with the same name but using the prefix \lstinline!inner!\indexinline{inner} which is nearest in the enclosing instance tree of the \lstinline!outer! element declaration. |
There was a problem hiding this comment.
I think it was problematic before, but the new change adds issues.
A model has only one "instance tree", so "nearest in the enclosing instance tree" seems to roughly mean "nearest enclosing in the instance tree". However, roughly is doing quite a lot of work, and something like "nearest enclosing" is needed (but not explained) as it isn't "nearest" in the instance graph (as trees are graphs).
The intent (as we all know) is that you go up the tree (or hierarchy) step-by-step stop as soon as you find a "sibling" that is an inner element with the same name, so using "instance sub-tree" might fix some issues - but it really should be explained in more detail.
There was a problem hiding this comment.
So something like:
| An element declared with the prefix \lstinline!outer!\indexinline{outer} references an element instance with the same name but using the prefix \lstinline!inner!\indexinline{inner} which is nearest in the enclosing instance tree of the \lstinline!outer! element declaration. | |
| An element declared with the prefix \lstinline!outer!\indexinline{outer} references an element instance with the same name but using the prefix \lstinline!inner!\indexinline{inner} whose parent in the instance tree is the closest ancestor of the \lstinline!outer! element declaration, having a matching \indexinline{inner} element. |
| \begin{nonnormative} | ||
| \lstinline!inner!/\lstinline!outer! components may be used to model simple fields, where some physical quantities, such as gravity vector, environment temperature or environment pressure, are accessible from all components in a specific model hierarchy. | ||
| Inner components are accessible throughout the model, if they are not ``shadowed'' by a corresponding \lstinline!inner! declaration in a more deeply nested level of the model hierarchy. | ||
| \lstinline!inner!/\lstinline!outer! components may be used to model simple fields, where some physical quantities, such as gravity vector, environment temperature or environment pressure, are accessible from all components in a specific instance tree. |
There was a problem hiding this comment.
"specific instance tree" make it sound as if a model may have multiple instance trees, but during translation the model only has one - so I would more say that it is accessible in a sub-tree or part of the tree, and "instance sub-tree" would be a new term, so prefer the latter:
| \lstinline!inner!/\lstinline!outer! components may be used to model simple fields, where some physical quantities, such as gravity vector, environment temperature or environment pressure, are accessible from all components in a specific instance tree. | |
| \lstinline!inner!/\lstinline!outer! components may be used to model simple fields, where some physical quantities, such as gravity vector, environment temperature or environment pressure, are accessible from all components in a part of the instance tree. |
There was a problem hiding this comment.
Or possibly something like "in the instance tree, or part of it".
3 participants
Fixing a few places where the term instance hierarchy was used, and where I believe the correct term to use is instance tree.