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

Missing Documentation for different types of evaluation #48

Open
ItzcoR opened this issue Mar 18, 2021 · 1 comment
Open

Missing Documentation for different types of evaluation #48

ItzcoR opened this issue Mar 18, 2021 · 1 comment
Labels
documentation Indicates a need for improvements or additions to documentation

Comments

@ItzcoR
Copy link

ItzcoR commented Mar 18, 2021

I'm interested in how to use the Evaluttion type Interval, but the documentation is lacking examples of this type of evalution and for vectors

@fkleon fkleon added the documentation Indicates a need for improvements or additions to documentation label Mar 18, 2021
@fkleon
Copy link
Owner

fkleon commented Mar 18, 2021

Hi @ItzcoR thanks for bringing this up. A word of caution upfront - both VECTOR and INTERVAL implementations aren't as complete as the REAL type. The basic operations should work everywhere but YMMV for other functions.

Interval is in reasonable shape, implementing most operations in this paper. A slightly more detailed overview about supported cases is in the Interval documentation.
If you bind IntervalLiteral to a variable and then evaluate with the interval type you can expect an Interval result.
Some examples are in the unit tests, and an actual use case is implemented by this ray tracing library.

The supported vector operations aren't documented anywhere yet. Evaluating unsupported functions will throw a runtime exception if not implemented. The library currently only supports vectors of up to 4 elements. The best source of documentation at the moment are the unit tests or source code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants