commit db75cc9afd21fe991a4b02196144773699b11ae9
parent 827fa3823b6298ddc8824bb2590b71ed0586ab65
Author: NunoSempere <nuno.sempere@protonmail.com>
Date: Sat, 19 Aug 2023 19:22:49 +0200
add reference to clang-tidy in README
Diffstat:
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -262,6 +262,16 @@ Overall, I would caution that if you really care about the very far tails of dis
In fact, squiggle.c does have a few functions for algebraic manipulations of simple distributions at the end of squiggle.c. But these are pretty rudimentary, and I don't know whether I'll end up expanding or deleting them.
+### Results of running clang-tidy
+
+clang-tidy is a utility to detect common errors in C/C++. You can run it with:
+
+```
+make tidy
+```
+
+It emits one warning about something I already took care of, so by default I've suppressed it. I think this is good news in terms of making me more confident that this simple library is correct :).
+
## Related projects
- [Squiggle](https://www.squiggle-language.com/)
@@ -274,7 +284,7 @@ In fact, squiggle.c does have a few functions for algebraic manipulations of sim
- [ ] Think about whether to write a simple version of this for [uxn](https://100r.co/site/uxn.html), a minimalistic portable programming stack which, sadly, doesn't have doubles (64 bit floats)
- [ ] Point out that, even though the C standard is ambiguous about this, this code assumes that doubles are 64 bit precision (otherwise the xorshift should be different).
-- [ ] Document rudimentary algebra manipulations
+- [ ] Document rudimentary algebra manipulations for normal/lognormal
- [ ] Think through whether to delete cdf => samples function
- [ ] Think through whether to:
- simplify and just abort on error
