Skip to content

Commit 0b92d11

Browse files
committed
doc updates
1 parent 690a06c commit 0b92d11

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
PCHIP, a Fortran package for piecewise cubic Hermite interpolation of data. This is a modern Fortran update of the code in the [SLATEC](http://www.netlib.org/slatec/pchip/) library.
44

5+
### Status
6+
7+
![Build Status](https://github.com/jacobwilliams/pchip/actions/workflows/CI.yml/badge.svg)
8+
9+
### Documentation
10+
11+
The latest API documentation can be found [here](https://jacobwilliams.github.io/PCHIP/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford).
12+
513
### Description
614

715
This document describes the contents of PCHIP, which is a Fortran package for piecewise cubic Hermite interpolation of data. It features software to produce a monotone and "visually pleasing" interpolant to monotone data. As is demonstrated in Reference 4, such an interpolant may be more reasonable than a cubic spline if the data contains both "steep" and "flat" sections. Interpolation of cumulative probability distribution functions is another application. (See References 2-4 for examples.)

pchip.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ predocmark: <
1111
docmark_alt:
1212
docmark: !
1313
display: public
14+
private
1415
source: true
15-
graph: false
16+
graph: true
1617

1718
### Brief description
1819

0 commit comments

Comments
 (0)