Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify naming of "continuous states" and "derivatives" in API and XML #1355

Merged
merged 3 commits into from
Mar 17, 2021

Conversation

t-sommer
Copy link
Collaborator

to clearly distinguish the different types of derivatives in

  • fmi3GetContinuousStateDerivatives()
  • fmi3GetOutputDerivatives()
  • fmi3GetDirectionalDerivative()
  • fmi3GetAdjointDerivative()

and

fixes #1343

@t-sommer t-sommer marked this pull request as ready for review March 17, 2021 08:33
Copy link
Contributor

@andreas-junghanns andreas-junghanns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to be correct, you have to call "states" "continuous-time states" and their derivatives "continuous-time state derivatives".
So your suggestion is now a compromise that uses longer names and still is not correct.
You even removed at least one "-time" where it makes perfect sense.

If we want to keep it short (and I would prefer short) we need to ask: is there a way to reasonably misunderstand what is ment. I see little danger of that.

@t-sommer
Copy link
Collaborator Author

If you want to be correct, you have to call "states" "continuous-time states" and their derivatives "continuous-time state derivatives".

The correct term would be "continuous w.r.t. the independent variable". But is continuous ever referring to something else in the document? If not we could just state that and use "continuous".

So your suggestion is now a compromise that uses longer names and still is not correct.

See above.

You even removed at least one "-time" where it makes perfect sense.

By accident. Fixed it.

@andreas-junghanns
Copy link
Contributor

We do have discrete states. Well, discrete w.r.t. value and discrete w.r.t. time.
"Continuous states" could mean a discrete-time state with a continuous value (float/double).
To be clear, we tried to consistently name them "continuous-time states".

@t-sommer
Copy link
Collaborator Author

t-sommer commented Mar 17, 2021

"Continuous states" could mean a discrete-time state with a continuous value (float/double).

The question is: do we currently or will we ever have to refer to these in the docs?

@andreas-junghanns
Copy link
Contributor

"Continuous states" could mean a discrete-time state with a continuous value (float/double).

The question is: do we currently or will we ever have to refer to these in the docs?

We refer to discrete states, yes - there it is always clear what we mean.

@andreas-junghanns
Copy link
Contributor

WEB design meeting: agreed with Torsten´s proposal.

@chrbertsch chrbertsch mentioned this pull request Mar 17, 2021
4 tasks
@beutlich beutlich added this to the v3.0 milestone Mar 17, 2021
@t-sommer t-sommer merged commit 1e26e82 into modelica:master Mar 17, 2021
@t-sommer t-sommer deleted the 1343-unify-continuous-states branch March 17, 2021 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unify naming of "continues states" and "derivatives" in API, XML, and docs
3 participants