JJSierraM/squiggle.c
1
0
Fork 0
forked from personal/squiggle.c
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README, end for the day.

Browse Source
This commit is contained in:
NunoSempere 2023-09-23 22:19:59 +01:00
parent ccad14b318
commit f1834341a9
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -12,7 +12,7 @@ squiggle.c is a self-contained C99 library that provides functions for simple Mo
- Because if you can implement something in C, you can implement it anywhere else - Because if you can implement something in C, you can implement it anywhere else
- Because it can be made faster if need be - Because it can be made faster if need be
- e.g., with a multi-threading library like OpenMP, - e.g., with a multi-threading library like OpenMP,
- or by implementing faster but more complex algorithms - o by implementing faster but more complex algorithms
- or more simply, by inlining the sampling functions (adding an `inline` directive before their function declaration) - or more simply, by inlining the sampling functions (adding an `inline` directive before their function declaration)
- **Because there are few abstractions between it and machine code** (C => assembly => machine code with gcc, or C => machine code, with tcc), leading to fewer errors beyond the programmer's control. - **Because there are few abstractions between it and machine code** (C => assembly => machine code with gcc, or C => machine code, with tcc), leading to fewer errors beyond the programmer's control.
@ -34,7 +34,7 @@ You can follow some example usage in the examples/ folder
### squiggle.c is short ### squiggle.c is short
[squiggle.c](squiggle.c) is less than 500 lines of C. The reader could just read it and grasp its contents. [squiggle.c](squiggle.c) is less than 600 lines of C, with a core of <250 lines. The reader could just read it and grasp its contents.
### Core strategy ### Core strategy
@ -345,8 +345,9 @@ It emits one warning about something I already took care of, so by default I've
- [x] Add prototypes - [x] Add prototypes
- [x] Use named structs - [x] Use named structs
- [x] Add to header file - [x] Add to header file
- [ ] Provide example - [x] Provide example
- [ ] Test results - [ ] Test results
- [ ] Add conversion between 90% ci and parameters. - [ ] Add conversion between 90% ci and parameters.
- [ ] Move to own file? Or signpost in file? - [x] Move to own file? Or signpost in file? => signposted in file.
- [ ] Disambiguate sample_laplace--successes vs failures || successes vs total trials as two distinct and differently named functions - [ ] Disambiguate sample_laplace--successes vs failures || successes vs total trials as two distinct and differently named functions
- [ ] Write twitter thread.