grammar

Author: espdev

src/lib.rs

@@ -10,11 +10,11 @@
 //! # Algorithm and Implementation
 //!
 //! The crate implements cubic smooting spline algorithm proposed by Carl de Boor in his book
-//! ["A Practical Guide to Splines"](https://www.springer.com/gp/book/9780387953663) and inspired by
+//! ["A Practical Guide to Splines"](https://www.springer.com/gp/book/9780387953663) and has been inspired by
 //! code from MATLAB [CSAPS](https://www.mathworks.com/help/curvefit/csaps.html) function and Fortran
 //! routine SMOOTH from [PGS](http://pages.cs.wisc.edu/~deboor/pgs/) (originally written by Carl de Boor).
 //!
-//! The algorithm implementation based on [ndarray](https://docs.rs/ndarray) and [sprs](https://docs.rs/sprs) crates.
+//! The algorithm implementation is based on [ndarray](https://docs.rs/ndarray) and [sprs](https://docs.rs/sprs) crates.
 //!
 //! # Features
 //!
@@ -70,13 +70,46 @@
 //! println!("yi: {}", yi);
 //! ```
 //!
+//! 2-d grid (surface) data smoothing
+//!
+//! ```
+//! use ndarray::array;
+//! use csaps::GridCubicSmoothingSpline;
+//!
+//! let x0 = array![1.0, 2.0, 3.0, 4.0];
+//! let x1 = array![1.0, 2.0, 3.0, 4.0];
+//! let x = vec![x0.view(), x1.view()];
+//!
+//! let xi0 = array![1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0];
+//! let xi1 = array![1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0];
+//! let xi = vec![xi0.view(), xi1.view()];
+//!
+//! let y = array![
+//!     [0.5, 1.2, 3.4, 2.5],
+//!     [1.5, 2.2, 4.4, 3.5],
+//!     [2.5, 3.2, 5.4, 4.5],
+//!     [3.5, 4.2, 6.4, 5.5],
+//! ];
+//!
+//! let yi = GridCubicSmoothingSpline::new(&x, &y)
+//!     .make().unwrap()
+//!     .evaluate(&x).unwrap();
+//!
+//! println!("xi: {:?}", xi);
+//! println!("yi: {}", yi);
+//! ```
+//!
 //! # Input and Output Data Types
 //!
 //! The input data sites and data values should be array-like containers with floating point items
 //! (`f32` or `f64`). It can be `&ndarray::Array` or `ndarray::ArrayView`, or `&Vec<_>`, or `&[_]`.
 //!
 //! The output evaluated data is always `ndarray::Array`.
 //!
+//! In n-dimensional grid data case the input `x` and `weights` data must be a slice of `ArrayView1`,
+//! but not a slice of `AsArray` array-like because `ndarray::Array` does not implement `AsRef` trait
+//! currently. In the future we might be able to support `AsArray` in n-dimensional grid data case.
+//!
 
 mod errors;
 mod ndarrayext;