Skip to content

Commit e9dff74

Browse files
committed
README update
Providing a better description of what is in the repository and a little bit of markup touchup.
1 parent 26346fc commit e9dff74

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# numerical\_routines
22

3-
This repository holds efficient routines for performing value saturation, rounded division, and rounded shift operations on integer types. These routines are intended for programmers who use fixed point arithmetic on microcontrollers or other constrained devices.
3+
This repository holds a variety of programs that either implement or employ numerical methods.
44

5-
There are two numerical solvers related to Negative Temperature Coefficient (NTC) thermistors: (1) a simulator of the measurement errors encountered when monitoring an NTC thermistor with a typical ADC and (2) a near-optimal linear interpolation table generator for NTC thermistors.
5+
The integer/ directory holds efficient routines for performing value saturation, rounded division, and rounded shift operations on integer types. These are intended for programmers who use fixed point arithmetic on microcontrollers or other constrained devices.
6+
7+
The number\_theory/ directory has code implementing Greatest Common Divisor (GCD) and Least Common Multiple (LCM) on the most common unsigned integer types.
8+
9+
The statistics/ directory contains an implementation of Sn, a robust estimator of scale.
10+
11+
The thermistor/ directory contains two programs related to Negative Temperature Coefficient (NTC) thermistors: (1) a simulator of the worst‑case measurement errors encountered when monitoring an NTC thermistor with an ADC and (2) a near‑optimal linear interpolation table generator for NTC thermistors.
612

713
## Getting Started
814

9-
Take a look in the integer/ and thermistor/ directories.
15+
The README files the individual directories descibed above are a good place to start.
1016

1117
## Contributing
1218

@@ -18,7 +24,7 @@ Ben Tesch – [slugrustle](https://github.com/slugrustle)
1824

1925
## License
2026

21-
All code in this repository that has been produced by the author is distributed under the [CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/). See also LICENSE.txt and the individual program files.
27+
All files in this repository that have been produced by the author are distributed under the [CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/). See also LICENSE.txt and the files themselves.
2228

2329
A portion of the boost library is distributed in the integer/boost directory. See integer/boost\_license\_report.hml and integer/LICENSE\_1\_0.txt for more information.
2430

0 commit comments

Comments
 (0)