doc update

Author: kylecarow

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ninterp"
-version = "0.4.0"
+version = "0.5.0"
 edition = "2021"
 description = "Numerical interpolation for N-dimensional rectilinear grids"
 repository = "https://github.com/NREL/ninterp"
@@ -10,7 +10,7 @@ keywords = [
     "multidimensional",
     "multilinear",
     "numerical",
-    "approximation",
+    "linear",
 ]
 categories = ["mathematics"]
 

README.md

@@ -5,6 +5,7 @@
 The `ninterp` crate provides [multivariate interpolation](https://en.wikipedia.org/wiki/Multivariate_interpolation#Regular_grid) over rectilinear grids of any dimensionality.
 
 There are hard-coded interpolators for lower dimensionalities (up to N = 3) for better runtime performance.
+All interpolators work with both owned and borrowed arrays (array views) of various types.
 
 A variety of interpolation strategies are implemented and exposed in the `prelude` module.
 Custom interpolation strategies can be defined in downstream crates.
@@ -27,18 +28,18 @@ See examples in `new` method documentation:
 - [`Interp3D::new`](https://docs.rs/ninterp/latest/ninterp/three/struct.Interp3D.html#method.new)
 - [`InterpND::new`](https://docs.rs/ninterp/latest/ninterp/n/struct.InterpND.html#method.new)
 
-Also see the [`examples`](https://github.com/NREL/ninterp/tree/a26c77caeac9e4ba2c5e8a4dbd652ce00b5747f3/examples) directory for advanced examples:
-- Strategy dynamic dispatch: [`dynamic_strategy.rs`](https://github.com/NREL/ninterp/blob/a26c77caeac9e4ba2c5e8a4dbd652ce00b5747f3/examples/dynamic_strategy.rs)
+Also see the [`examples`](https://github.com/NREL/ninterp/tree/62a62ccd2b3c285919baae609089dee287dc3842/examples) directory for advanced examples:
+- Strategy dynamic dispatch: [`dynamic_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_strategy.rs)
 
   By default, construction of interpolators uses *static dispatch*,
   meaning strategy concrete types are determined at compilation.
   This gives increased performance at the cost of runtime flexibility.
   To allow swapping strategies at runtime,
   use *dynamic dispatch* by providing a trait object `Box<dyn Strategy1D>`/etc. to the `new` method.
 
-- Interpolator dynamic dispatch using `Box<dyn Interpolator>`: [`dynamic_interpolator.rs`](https://github.com/NREL/ninterp/blob/46d8436c4ac389e778392a28048fb9e32a80b8e0/examples/dynamic_interpolator.rs)
+- Interpolator dynamic dispatch using `Box<dyn Interpolator>`: [`dynamic_interpolator.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_interpolator.rs)
 
-- Defining custom strategies: [`custom_strategy.rs`](https://github.com/NREL/ninterp/blob/46d8436c4ac389e778392a28048fb9e32a80b8e0/examples/custom_strategy.rs)
+- Defining custom strategies: [`custom_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/custom_strategy.rs)
 
 ## Overview
 A prelude module has been defined: 
@@ -78,7 +79,7 @@ Not all interpolation strategies are implemented for every dimensionality.
 `Linear` and `Nearest` are implemented for all dimensionalities.
 
 Custom strategies can be defined. See
-[`examples/custom_strategy.rs`](https://github.com/NREL/ninterp/blob/a26c77caeac9e4ba2c5e8a4dbd652ce00b5747f3/examples/custom_strategy.rs)
+[`examples/custom_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/custom_strategy.rs)
 for an example.
 
 ### Extrapolation

src/lib.rs

@@ -3,6 +3,7 @@
 //! over rectilinear grids of any dimensionality.
 //!
 //! There are hard-coded interpolators for lower dimensionalities (up to N = 3) for better runtime performance.
+//! All interpolators work with both owned and borrowed arrays (array views) of various types.
 //!
 //! A variety of interpolation strategies are implemented and exposed in the `prelude` module.
 //! Custom interpolation strategies can be defined in downstream crates.
@@ -11,7 +12,7 @@
 //! cargo add ninterp
 //! ```
 //!
-//! #### Feature Flags
+//! ### Cargo Features
 //! - `serde`: support for [`serde`](https://crates.io/crates/serde)
 //!   ```text
 //!   cargo add ninterp --features serde
@@ -25,19 +26,22 @@
 //! - [`Interp3D::new`](`interpolator::Interp3D::new`)
 //! - [`InterpND::new`](`interpolator::InterpND::new`)
 //!
-//! Also see the [`examples`](https://github.com/NREL/ninterp/tree/a26c77caeac9e4ba2c5e8a4dbd652ce00b5747f3/examples)
+//! Also see the [`examples`](https://github.com/NREL/ninterp/tree/62a62ccd2b3c285919baae609089dee287dc3842/examples)
 //! directory for advanced examples:
-//! - Strategy dynamic dispatch: [`dynamic_strategy.rs`](https://github.com/NREL/ninterp/blob/a26c77caeac9e4ba2c5e8a4dbd652ce00b5747f3/examples/dynamic_strategy.rs)
+//! - Strategy dynamic dispatch:
+//! [`dynamic_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_strategy.rs)
 //!
 //!   By default, construction of interpolators uses *static dispatch*,
 //!   meaning strategy concrete types are determined at compilation.
 //!   This gives increased performance at the cost of runtime flexibility.
 //!   To allow swapping strategies at runtime,
 //!   use *dynamic dispatch* by providing a trait object `Box<dyn Strategy1D>`/etc. to the `new` method.
 //!
-//! - Interpolator dynamic dispatch using `Box<dyn Interpolator>`: [`dynamic_interpolator.rs`](https://github.com/NREL/ninterp/blob/46d8436c4ac389e778392a28048fb9e32a80b8e0/examples/dynamic_interpolator.rs)
+//! - Interpolator dynamic dispatch using `Box<dyn Interpolator>`:
+//! [`dynamic_interpolator.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/dynamic_interpolator.rs)
 //!
-//! - Defining custom strategies: [`custom_strategy.rs`](https://github.com/NREL/ninterp/blob/46d8436c4ac389e778392a28048fb9e32a80b8e0/examples/custom_strategy.rs)
+//! - Defining custom strategies:
+//! [`custom_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/custom_strategy.rs)
 //!
 //! # Overview
 //! A prelude module has been defined:
@@ -73,7 +77,7 @@
 //! [`Linear`] and [`Nearest`] are implemented for all dimensionalities.
 //!
 //! Custom strategies can be defined. See
-//! [`examples/custom_strategy.rs`](https://github.com/NREL/ninterp/blob/a26c77caeac9e4ba2c5e8a4dbd652ce00b5747f3/examples/custom_strategy.rs)
+//! [`examples/custom_strategy.rs`](https://github.com/NREL/ninterp/blob/62a62ccd2b3c285919baae609089dee287dc3842/examples/custom_strategy.rs)
 //! for an example.
 //!
 //! ## Extrapolation
@@ -94,7 +98,7 @@
 //! The length of the interpolant point slice must be equal to the interpolator dimensionality.
 //! The interpolator dimensionality can be retrieved by calling [`Interpolator::ndim`].
 
-/// The `prelude` module exposes:
+/// The `prelude` module exposes a variety of types:
 /// - All interpolator structs:
 ///   - [`Interp0D`](`interpolator::Interp0D`)
 ///   - [`Interp1D`](`interpolator::Interp1D`)

src/n/mod.rs

@@ -232,6 +232,7 @@ where
     D: Data,
     D::Elem: Num + PartialOrd + Copy + Debug,
 {
+    /// Update strategy dynamically.
     pub fn set_strategy(&mut self, strategy: Box<dyn StrategyND<D>>) -> Result<(), ValidateError> {
         self.strategy = strategy;
         self.check_extrapolate(&self.extrapolate)

src/one/mod.rs

@@ -186,6 +186,7 @@ where
     D: Data,
     D::Elem: Num + PartialOrd + Copy + Debug,
 {
+    /// Update strategy dynamically.
     pub fn set_strategy(&mut self, strategy: Box<dyn Strategy1D<D>>) -> Result<(), ValidateError> {
         self.strategy = strategy;
         self.check_extrapolate(&self.extrapolate)

src/three/mod.rs

@@ -228,6 +228,7 @@ where
     D: Data,
     D::Elem: Num + PartialOrd + Copy + Debug,
 {
+    /// Update strategy dynamically.
     pub fn set_strategy(&mut self, strategy: Box<dyn Strategy3D<D>>) -> Result<(), ValidateError> {
         self.strategy = strategy;
         self.check_extrapolate(&self.extrapolate)

src/two/mod.rs

@@ -207,6 +207,7 @@ where
     D: Data,
     D::Elem: Num + PartialOrd + Copy + Debug,
 {
+    /// Update strategy dynamically.
     pub fn set_strategy(&mut self, strategy: Box<dyn Strategy2D<D>>) -> Result<(), ValidateError> {
         self.strategy = strategy;
         self.check_extrapolate(&self.extrapolate)