Skip to content

Commit a8592f8

Browse files
committed
Update README.md
1 parent 447969f commit a8592f8

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ cargo add ninterp
2222

2323
## Examples
2424
See examples in `new` method documentation:
25-
- [`Interp0D::new`](https://docs.rs/ninterp/latest/ninterp/zero/struct.Interp0D.html#method.new)
26-
- [`Interp1D::new`](https://docs.rs/ninterp/latest/ninterp/one/struct.Interp1D.html#method.new)
27-
- [`Interp2D::new`](https://docs.rs/ninterp/latest/ninterp/two/struct.Interp2D.html#method.new)
28-
- [`Interp3D::new`](https://docs.rs/ninterp/latest/ninterp/three/struct.Interp3D.html#method.new)
29-
- [`InterpND::new`](https://docs.rs/ninterp/latest/ninterp/n/struct.InterpND.html#method.new)
25+
- [`Interp0D::new`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp0D.html#method.new)
26+
- [`Interp1D::new`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp1D.html#method.new)
27+
- [`Interp2D::new`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp2D.html#method.new)
28+
- [`Interp3D::new`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp3D.html#method.new)
29+
- [`InterpND::new`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.InterpND.html#method.new)
3030

3131
Also see the [`examples`](examples) directory for advanced examples:
3232
- Strategy dynamic dispatch: [`dynamic_strategy.rs`](examples/dynamic_strategy.rs)
@@ -51,20 +51,20 @@ use ninterp::prelude::*;
5151
```
5252

5353
This exposes all strategies and a variety of interpolators:
54-
- [`Interp1D`](https://docs.rs/ninterp/latest/ninterp/one/struct.Interp1D.html)
55-
- [`Interp2D`](https://docs.rs/ninterp/latest/ninterp/two/struct.Interp2D.html)
56-
- [`Interp3D`](https://docs.rs/ninterp/latest/ninterp/three/struct.Interp3D.html)
57-
- [`InterpND`](https://docs.rs/ninterp/latest/ninterp/n/struct.InterpND.html)
54+
- [`Interp1D`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp1D.html)
55+
- [`Interp2D`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp2D.html)
56+
- [`Interp3D`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp3D.html)
57+
- [`InterpND`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.InterpND.html)
5858

5959
There is also a constant-value 'interpolator':
60-
[`Interp0D`](https://docs.rs/ninterp/latest/ninterp/zero/struct.Interp0D.html).
60+
[`Interp0D`](https://docs.rs/ninterp/latest/ninterp/interpolator/struct.Interp0D.html).
6161
This is useful when working with a `Box<dyn Interpolator>`
6262

6363
Instantiation is done by calling an interpolator's `new` method.
6464
For dimensionalities N ≥ 1, this executes a validation step, preventing runtime panics.
6565
After editing interpolator data,
6666
call the InterpData's `validate` method
67-
or [`Interpolator::validate`](https://docs.rs/ninterp/latest/ninterp/trait.Interpolator.html#tymethod.validate)
67+
or [`Interpolator::validate`](https://docs.rs/ninterp/latest/ninterp/interpolator/trait.Interpolator.html#tymethod.validate)
6868
to rerun these checks.
6969

7070
To change the extrapolation setting, call `set_extrapolate`.
@@ -88,20 +88,21 @@ Custom strategies can be defined. See
8888
for an example.
8989

9090
### Extrapolation
91-
An [`Extrapolate`](https://docs.rs/ninterp/latest/ninterp/enum.Extrapolate.html)
91+
An [`Extrapolate`](https://docs.rs/ninterp/latest/ninterp/interpolator/enum.Extrapolate.html)
9292
setting must be provided in the `new` method.
9393
This controls what happens when a point is beyond the range of supplied coordinates.
9494
The following settings are applicable for all interpolators:
9595
- `Extrapolate::Fill(T)`
9696
- `Extrapolate::Clamp`
97+
- `Extrapolate::Wrap`
9798
- `Extrapolate::Error`
9899

99100
`Extrapolate::Enable` is valid for `Linear` for all dimensionalities.
100101

101102
If you are unsure which variant to choose, `Extrapolate::Error` is likely what you want.
102103

103104
### Interpolation
104-
Interpolation is executed by calling [`Interpolator::interpolate`](https://docs.rs/ninterp/latest/ninterp/trait.Interpolator.html#tymethod.interpolate).
105+
Interpolation is executed by calling [`Interpolator::interpolate`](https://docs.rs/ninterp/latest/ninterp/interpolator/trait.Interpolator.html#tymethod.interpolate).
105106

106107
The length of the interpolant point slice must be equal to the interpolator dimensionality.
107-
The interpolator dimensionality can be retrieved by calling [`Interpolator::ndim`](https://docs.rs/ninterp/latest/ninterp/trait.Interpolator.html#tymethod.ndim).
108+
The interpolator dimensionality can be retrieved by calling [`Interpolator::ndim`](https://docs.rs/ninterp/latest/ninterp/interpolator/trait.Interpolator.html#tymethod.ndim).

0 commit comments

Comments
 (0)