Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobwilliams committed Aug 29, 2021
1 parent 690a06c commit 0b92d11
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

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.

### Status

![Build Status](https://github.com/jacobwilliams/pchip/actions/workflows/CI.yml/badge.svg)

### Documentation

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).

### Description

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.)
Expand Down
3 changes: 2 additions & 1 deletion pchip.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ predocmark: <
docmark_alt:
docmark: !
display: public
private
source: true
graph: false
graph: true

### Brief description

Expand Down

0 comments on commit 0b92d11

Please sign in to comment.