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.

Sign up for GitHub

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

Add more documentation of value evaluation #1302

Merged
merged 1 commit into from
Aug 28, 2023
Merged

Add more documentation of value evaluation #1302

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/docs/GettingStarted/query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@ set of analyses and functions to use them. These are:

- **min(n: Node)**: Minimal value of a node
- **max(n: Node)**: Maximal value of a node
- **evaluate(evaluator: ValueEvaluator)**: Evaluates the value of a node. You
can use different evaluators which can affect the possible results. In general,
it makes sense to check if the evaluation succeeded and/or transfer the types.
E.g., the default value evaluator could return different numbers (transferring
them e.g. with `toLong()` or `toFloat()` could make sense), a string, or an error.
- **sizeof(n: Node)**: The length of an array or string
- **dataFlow(from: Node, to: Node)**: Checks if a data flow is possible between
the nodes `from` as a source and `to` as sink.
Expand Down