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

Rename properties to use atom/expression naming #376

Open
maxitg opened this issue Jun 9, 2020 · 0 comments
Open

Rename properties to use atom/expression naming #376

maxitg opened this issue Jun 9, 2020 · 0 comments
Assignees
Labels
analysis Adds or changes evolution analysis tools, e.g., `WolframModelEvolutionObject` properties refactor Does not change functionality, but makes the code better organized or more readable wolfram language Requires Wolfram Language implementation

Comments

@maxitg
Copy link
Owner

maxitg commented Jun 9, 2020

The problem

Currently, the words "edge" and "vertex" are horribly overused, especially if talking about causal graphs etc., where the word "edge" could refer both to a hyperedge and the causal edge, which leads to a lot of confusion.

Possible solution

The suggestion is to use the following terms instead (which are already heavily used in the internal code):

  • atom: vertex in the space hypergraph;
  • expression: hyperedge in the space hypergraph;

The names for events, matches, and rules are fairly unambiguous and could keep being used as they are.

Comments

This should not break the existing API, so the old property names should still work (we have a mechanism for that, check $oldToNewPropertyNames in WolframModelEvolutionObject.m).

@maxitg maxitg added refactor Does not change functionality, but makes the code better organized or more readable documentation Adds or changes documentation for existing functionality labels Jun 9, 2020
@maxitg maxitg added analysis Adds or changes evolution analysis tools, e.g., `WolframModelEvolutionObject` properties wolfram language Requires Wolfram Language implementation and removed documentation Adds or changes documentation for existing functionality labels Aug 25, 2020
@maxitg maxitg self-assigned this Aug 25, 2020
@maxitg maxitg added this to the Project Yellowstone milestone Jan 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
analysis Adds or changes evolution analysis tools, e.g., `WolframModelEvolutionObject` properties refactor Does not change functionality, but makes the code better organized or more readable wolfram language Requires Wolfram Language implementation
Projects
None yet
Development

No branches or pull requests

1 participant