1.0.0.

Implement Spline::add.

.github/workflows/ci.yaml

@@ -0,0 +1,39 @@
+name: CI
+on: [push]
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Build
+        run: cargo build --verbose
+      - name: Test
+        run: cargo test --verbose
+
+  build-windows:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Build
+        run: cargo build --verbose
+      - name: Test
+        run: cargo test --verbose
+
+  build-macosx:
+    runs-on: macosx-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Build
+        run: cargo build --verbose
+      - name: Test
+        run: cargo test --verbose
+
+  check-readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install cargo-sync-readme
+        run: cargo install --force cargo-sync-readme
+      - name: Check
+        run: cargo sync-readme -c

.travis.yml

@@ -1,23 +0,0 @@
-language: rust
-
-rust:
-  - stable
-  - beta
-  - nightly
-
-os:
-  - linux
-  - osx
-
-script:
-  - rustc --version
-  - cargo --version
-  - echo "Testing default crate configuration"
-  - cargo build --verbose
-  - cargo test --verbose
-  - cd examples && cargo check --verbose
-  - echo "Testing feature serialization"
-  - cargo build --verbose --features serialization
-  - cargo test --verbose --features serialization
-  - echo "Building without std"
-  - cargo build --verbose --no-default-features

CHANGELOG.md

@@ -1,43 +1,65 @@
-## 0.2.3
+# 1.0
+
+> Sun Sep 22th 2019
+
+## Major changes
+
+- Make `Spline::clamped_sample` failible via `Option` instead of panicking.
+- Add support for polymorphic sampling type.
+
+## Minor changes
+
+- Add the `std` feature (and hence support for `no_std`).
+- Add `impl-nalgebra` feature.
+- Add `impl-cgmath` feature.
+- Add support for adding keys to splines.
+- Add support for removing keys from splines.
+
+## Patch changes
+
+- Migrate to Rust 2018.
+- Documentation typo fixes.
+
+# 0.2.3
 
 > Sat 13th October 2018
 
-  - Add the `"impl-nalgebra"` feature gate. It gives access to some implementors for the `nalgebra`
+- Add the `"impl-nalgebra"` feature gate. It gives access to some implementors for the `nalgebra`
-    crate.
+  crate.
-  - Enhance the documentation.
+- Enhance the documentation.
 
-## 0.2.2
+# 0.2.2
 
 > Sun 30th September 2018
 
-  - Bump version numbers (`splines-0.2`) in examples.
+- Bump version numbers (`splines-0.2`) in examples.
-  - Fix several typos in the documentation.
+- Fix several typos in the documentation.
 
-## 0.2.1
+# 0.2.1
 
 > Thu 20th September 2018
 
-  - Enhance the features documentation.
+- Enhance the features documentation.
 
 # 0.2
 
 > Thu 6th September 2018
 
-  - Add the `"std"` feature gate, that can be used to compile with the standard library.
+- Add the `"std"` feature gate, that can be used to compile with the standard library.
-  - Add the `"impl-cgmath"` feature gate in order to make optional, if wanted, the `cgmath`
+- Add the `"impl-cgmath"` feature gate in order to make optional, if wanted, the `cgmath`
-    dependency.
+  dependency.
-  - Enhance the documentation.
+- Enhance the documentation.
 
-## 0.1.1
+# 0.1.1
 
 > Wed 8th August 2018
 
-  - Add a feature gate, `"serialization"`, that can be used to automatically derive `Serialize` and
+- Add a feature gate, `"serialization"`, that can be used to automatically derive `Serialize` and
-    `Deserialize` from the [serde](https://crates.io/crates/serde) crate.
+  `Deserialize` from the [serde](https://crates.io/crates/serde) crate.
-  - Enhance the documentation.
+- Enhance the documentation.
 
 # 0.1
 
 > Sunday 5th August 2018
 
-  - Initial revision.
+- Initial revision.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "splines"
-version = "1.0.0-rc.1"
+version = "1.0.0"
 license = "BSD-3-Clause"
 authors = ["Dimitri Sabadie <dimitri.sabadie@gmail.com>"]
 description = "Spline interpolation made easy"
@@ -33,3 +33,6 @@ nalgebra = { version = ">=0.14, <0.19", optional = true }
 num-traits = { version = "0.2", optional = true }
 serde =  { version = "1", optional = true }
 serde_derive = { version = "1", optional = true }
+
+[package.metadata.docs.rs]
+all-features = true

README.md

@@ -13,9 +13,9 @@ switch to a cubic Hermite interpolator for the next section.
 
 Most of the crate consists of three types:
 
-- [`Key`], which represents the control points by which the spline must pass.
+  - [`Key`], which represents the control points by which the spline must pass.
-- [`Interpolation`], the type of possible interpolation for each segment.
+  - [`Interpolation`], the type of possible interpolation for each segment.
-- [`Spline`], a spline from which you can *sample* points by interpolation.
+  - [`Spline`], a spline from which you can *sample* points by interpolation.
 
 When adding control points, you add new sections. Two control points define a section – i.e.
 it’s not possible to define a spline without at least two control points. Every time you add a
@@ -40,17 +40,13 @@ key. We use the default one because we don’t care.
 # Interpolate values
 
 The whole purpose of splines is to interpolate discrete values to yield continuous ones. This is
-usually done with the `Spline::sample` method. This method expects the interpolation parameter
+usually done with the [`Spline::sample`] method. This method expects the sampling parameter
 (often, this will be the time of your simulation) as argument and will yield an interpolated
 value.
 
-If you try to sample in out-of-bounds interpolation parameter, you’ll get no value.
+If you try to sample in out-of-bounds sampling parameter, you’ll get no value.
 
 ```
-# use splines::{Interpolation, Key, Spline};
-# let start = Key::new(0., 0., Interpolation::Linear);
-# let end = Key::new(1., 10., Interpolation::Linear);
-# let spline = Spline::from_vec(vec![start, end]);
 assert_eq!(spline.sample(0.), Some(0.));
 assert_eq!(spline.clamped_sample(1.), Some(10.));
 assert_eq!(spline.sample(1.1), None);
@@ -61,14 +57,17 @@ important for simulations / animations. Feel free to use the `Spline::clamped_in
 that purpose.
 
 ```
-# use splines::{Interpolation, Key, Spline};
-# let start = Key::new(0., 0., Interpolation::Linear);
-# let end = Key::new(1., 10., Interpolation::Linear);
-# let spline = Spline::from_vec(vec![start, end]);
 assert_eq!(spline.clamped_sample(-0.9), Some(0.)); // clamped to the first key
 assert_eq!(spline.clamped_sample(1.1), Some(10.)); // clamped to the last key
 ```
 
+# Polymorphic sampling types
+
+[`Spline`] curves are parametered both by the carried value (being interpolated) but also the
+sampling type. It’s very typical to use `f32` or `f64` but really, you can in theory use any
+kind of type; that type must, however, implement a contract defined by a set of traits to
+implement. See [the documentation of this module](crate::interpolate) for further details.
+
 # Features and customization
 
 This crate was written with features baked in and hidden behind feature-gates. The idea is that
@@ -84,20 +83,20 @@ not. It’s especially important to see how it copes with the documentation.
 
 So here’s a list of currently supported features and how to enable them:
 
-- **Serialization / deserialization.**
+  - **Serialization / deserialization.**
-+ This feature implements both the `Serialize` and `Deserialize` traits from `serde` for all
+    + This feature implements both the `Serialize` and `Deserialize` traits from `serde` for all
-types exported by this crate.
+      types exported by this crate.
-+ Enable with the `"serialization"` feature.
+    + Enable with the `"serialization"` feature.
-- **[cgmath](https://crates.io/crates/cgmath) implementors.**
+  - **[cgmath](https://crates.io/crates/cgmath) implementors.**
-+ Adds some useful implementations of `Interpolate` for some cgmath types.
+    + Adds some useful implementations of `Interpolate` for some cgmath types.
-+ Enable with the `"impl-cgmath"` feature.
+    + Enable with the `"impl-cgmath"` feature.
-- **[nalgebra](https://crates.io/crates/nalgebra) implementors.**
+  - **[nalgebra](https://crates.io/crates/nalgebra) implementors.**
-+ Adds some useful implementations of `Interpolate` for some nalgebra types.
+    + Adds some useful implementations of `Interpolate` for some nalgebra types.
-+ Enable with the `"impl-nalgebra"` feature.
+    + Enable with the `"impl-nalgebra"` feature.
-- **Standard library / no standard library.**
+  - **Standard library / no standard library.**
-+ It’s possible to compile against the standard library or go on your own without it.
+    + It’s possible to compile against the standard library or go on your own without it.
-+ Compiling with the standard library is enabled by default.
+    + Compiling with the standard library is enabled by default.
-+ Use `default-features = []` in your `Cargo.toml` to disable.
+    + Use `default-features = []` in your `Cargo.toml` to disable.
-+ Enable explicitly with the `"std"` feature.
+    + Enable explicitly with the `"std"` feature.
 
 <!-- cargo-sync-readme end -->

examples/01-hello-world/Cargo.toml

@@ -4,4 +4,4 @@ version = "0.2.0"
 authors = ["Dimitri Sabadie <dimitri.sabadie@gmail.com>"]
 
 [dependencies]
-splines = "0.2"
+splines = "1.0.0-rc.2"

examples/02-serialization/Cargo.toml

@@ -5,7 +5,4 @@ authors = ["Dimitri Sabadie <dimitri.sabadie@gmail.com>"]
 
 [dependencies]
 serde_json = "1"
-
+splines =  { version = "1.0.0-rc.2", features = ["serialization"] }
-[dependencies.splines]
-version = "0.2"
-features = ["serialization"]

src/interpolate.rs

@@ -1,3 +1,33 @@
+//! The [`Interpolate`] trait and associated symbols.
+//!
+//! The [`Interpolate`] trait is the central concept of the crate. It enables a spline to be
+//! sampled at by interpolating in between control points.
+//!
+//! In order for a type to be used in [`Spline<K, V>`], some properties must be met about the `K`
+//! type must implementing several traits:
+//!
+//!   - [`One`], giving a neutral element for the multiplication monoid.
+//!   - [`Additive`], making the type additive (i.e. one can add or subtract with it).
+//!   - [`Linear`], unlocking linear combinations, required for interpolating.
+//!   - [`Trigo`], a trait giving *π* and *cosine*, required for e.g. cosine interpolation.
+//!
+//! Feel free to have a look at current implementors for further help.
+//!
+//! > *Why doesn’t this crate use [num-traits] instead of
+//! > defining its own traits?*
+//!
+//! The reason for this is quite simple: this crate provides a `no_std` support, which is not
+//! currently available easily with [num-traits]. Also, if something changes in [num-traits] with
+//! those traits, it would make this whole crate unstable.
+//!
+//! [`Interpolate`]: crate::interpolate::Interpolate
+//! [`Spline<K, V>`]: crate::spline::Spline
+//! [`One`]: crate::interpolate::One
+//! [`Additive`]: crate::interpolate::Additive
+//! [`Linear`]: crate::interpolate::Linear
+//! [`Trigo`]: crate::interpolate::Trigo
+//! [num-traits]: https://crates.io/crates/num-traits
+
 #[cfg(feature = "std")] use std::f32;
 #[cfg(not(feature = "std"))] use core::f32;
 #[cfg(not(feature = "std"))] use core::intrinsics::cosf32;
@@ -10,21 +40,28 @@
 /// Keys that can be interpolated in between. Implementing this trait is required to perform
 /// sampling on splines.
 ///
-/// `T` is the variable used to sample with. Typical implementations use `f32` or `f64`, but you’re
+/// `T` is the variable used to sample with. Typical implementations use [`f32`] or [`f64`], but
-/// free to use the ones you like.
+/// you’re free to use the ones you like. Feel free to have a look at [`Spline::sample`] for
+/// instance to know which trait your type must implement to be usable.
+///
+/// [`Spline::sample`]: crate::spline::Spline::sample
 pub trait Interpolate<T>: Sized + Copy {
   /// Linear interpolation.
   fn lerp(a: Self, b: Self, t: T) -> Self;
 
   /// Cubic hermite interpolation.
   ///
-  /// Default to `Self::lerp`.
+  /// Default to [`lerp`].
+  ///
+  /// [`lerp`]: Interpolate::lerp
   fn cubic_hermite(_: (Self, T), a: (Self, T), b: (Self, T), _: (Self, T), t: T) -> Self {
     Self::lerp(a.0, b.0, t)
   }
 }
 
-/// A trait for anything that supports additions, subtraction, multiplication and division.
+/// Set of types that support additions and subtraction.
+///
+/// The [`Copy`] trait is also a supertrait as it’s likely to be used everywhere.
 pub trait Additive:
   Copy +
   Add<Self, Output = Self> +
@@ -37,8 +74,8 @@ where T: Copy +
          Sub<Self, Output = Self> {
 }
 
-/// Linear combination.
+/// Set of additive types that support outer multiplication and division, making them linear.
-pub trait Linear<T> {
+pub trait Linear<T>: Additive {
   /// Apply an outer multiplication law.
   fn outer_mul(self, t: T) -> Self;
 
@@ -84,7 +121,7 @@ impl_linear_cast!(f64, f32);
 
 /// Types with a neutral element for multiplication.
 pub trait One {
-  /// Return the neutral element for the multiplicative monoid.
+  /// The neutral element for the multiplicative monoid — typically called `1`.
   fn one() -> Self;
 }
 
@@ -151,11 +188,11 @@ impl Trigo for f64 {
   }
 }
 
-// Default implementation of Interpolate::cubic_hermite.
+/// Default implementation of [`Interpolate::cubic_hermite`].
-//
+///
-// `V` is the value being interpolated. `T` is the sampling value (also sometimes called time).
+/// `V` is the value being interpolated. `T` is the sampling value (also sometimes called time).
-pub(crate) fn cubic_hermite_def<V, T>(x: (V, T), a: (V, T), b: (V, T), y: (V, T), t: T) -> V
+pub fn cubic_hermite_def<V, T>(x: (V, T), a: (V, T), b: (V, T), y: (V, T), t: T) -> V
-where V: Additive + Linear<T>,
+where V: Linear<T>,
       T: Additive + Mul<T, Output = T> + One {
   // some stupid generic constants, because Rust doesn’t have polymorphic literals…
   let one_t = T::one();

src/interpolation.rs

@@ -1,17 +1,23 @@
+//! Available interpolation modes.
+
 #[cfg(feature = "serialization")] use serde_derive::{Deserialize, Serialize};
 
-/// Interpolation mode.
+/// Available kind of interpolations.
-#[derive(Copy, Clone, Debug)]
+///
+/// Feel free to visit each variant for more documentation.
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
 #[cfg_attr(feature = "serialization", serde(rename_all = "snake_case"))]
 pub enum Interpolation<T> {
-  /// Hold a [`Key`] until the interpolator value passes the normalized step threshold, in which
+  /// Hold a [`Key<T, _>`] until the sampling value passes the normalized step threshold, in which
   /// case the next key is used.
   ///
   /// > Note: if you set the threshold to `0.5`, the first key will be used until half the time
   /// > between the two keys; the second key will be in used afterwards. If you set it to `1.0`, the
   /// > first key will be kept until the next key. Set it to `0.` and the first key will never be
   /// > used.
+  ///
+  /// [`Key<T, _>`]: crate::key::Key
   Step(T),
   /// Linear interpolation between a key and the next one.
   Linear,
@@ -22,7 +28,7 @@ pub enum Interpolation<T> {
 }
 
 impl<T> Default for Interpolation<T> {
-  /// `Interpolation::Linear` is the default.
+  /// [`Interpolation::Linear`] is the default.
   fn default() -> Self {
     Interpolation::Linear
   }

src/iter.rs

@@ -1,10 +1,18 @@
+//! Spline [`Iterator`], in a nutshell.
+//!
+//! You can iterate over a [`Spline<K, V>`]’s keys with the [`IntoIterator`] trait on
+//! `&Spline<K, V>`. This gives you iterated [`Key<K, V>`] keys.
+//!
+//! [`Spline<K, V>`]: crate::spline::Spline
+//! [`Key<K, V>`]: crate::key::Key
+
 use crate::{Key, Spline};
 
 /// Iterator over spline keys.
 ///
-/// This iterator type assures you to iterate over sorted keys.
+/// This iterator type is guaranteed to iterate over sorted keys.
 pub struct Iter<'a, T, V> where T: 'a, V: 'a {
-  anim_param: &'a Spline<T, V>,
+  spline: &'a Spline<T, V>,
   i: usize
 }
 
@@ -12,7 +20,7 @@ impl<'a, T, V> Iterator for Iter<'a, T, V> {
   type Item = &'a Key<T, V>;
 
   fn next(&mut self) -> Option<Self::Item> {
-    let r = self.anim_param.0.get(self.i);
+    let r = self.spline.0.get(self.i);
 
     if let Some(_) = r {
       self.i += 1;
@@ -28,7 +36,7 @@ impl<'a, T, V> IntoIterator for &'a Spline<T, V> {
 
   fn into_iter(self) -> Self::IntoIter {
     Iter {
-      anim_param: self,
+      spline: self,
       i: 0
     }
   }

src/key.rs

@@ -1,3 +1,11 @@
+//! Spline control points.
+//!
+//! A control point associates to a “sampling value” (a.k.a. time) a carriede value that can be
+//! interpolated along the curve made by the control points.
+//!
+//! Splines constructed with this crate have the property that it’s possible to change the
+//! interpolation mode on a key-based way, allowing you to implement and encode complex curves.
+
 #[cfg(feature = "serialization")] use serde_derive::{Deserialize, Serialize};
 
 use crate::interpolation::Interpolation;
@@ -5,15 +13,17 @@ use crate::interpolation::Interpolation;
 /// A spline control point.
 ///
 /// This type associates a value at a given interpolation parameter value. It also contains an
-/// interpolation hint used to determine how to interpolate values on the segment defined by this
+/// interpolation mode used to determine how to interpolate values on the segment defined by this
-/// key and the next one – if existing.
+/// key and the next one – if existing. Have a look at [`Interpolation`] for further details.
-#[derive(Copy, Clone, Debug)]
+///
+/// [`Interpolation`]: crate::interpolation::Interpolation
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
 #[cfg_attr(feature = "serialization", serde(rename_all = "snake_case"))]
 pub struct Key<T, V> {
   /// Interpolation parameter at which the [`Key`] should be reached.
   pub t: T,
-  /// Held value.
+  /// Carried value.
   pub value: V,
   /// Interpolation mode.
   pub interpolation: Interpolation<T>
@@ -25,4 +35,3 @@ impl<T, V> Key<T, V> {
     Key { t, value, interpolation }
   }
 }
-

src/lib.rs

@@ -33,11 +33,11 @@
 //! # Interpolate values
 //!
 //! The whole purpose of splines is to interpolate discrete values to yield continuous ones. This is
-//! usually done with the `Spline::sample` method. This method expects the interpolation parameter
+//! usually done with the [`Spline::sample`] method. This method expects the sampling parameter
 //! (often, this will be the time of your simulation) as argument and will yield an interpolated
 //! value.
 //!
-//! If you try to sample in out-of-bounds interpolation parameter, you’ll get no value.
+//! If you try to sample in out-of-bounds sampling parameter, you’ll get no value.
 //!
 //! ```
 //! # use splines::{Interpolation, Key, Spline};
@@ -62,6 +62,13 @@
 //! assert_eq!(spline.clamped_sample(1.1), Some(10.)); // clamped to the last key
 //! ```
 //!
+//! # Polymorphic sampling types
+//!
+//! [`Spline`] curves are parametered both by the carried value (being interpolated) but also the
+//! sampling type. It’s very typical to use `f32` or `f64` but really, you can in theory use any
+//! kind of type; that type must, however, implement a contract defined by a set of traits to
+//! implement. See [the documentation of this module](crate::interpolate) for further details.
+//!
 //! # Features and customization
 //!
 //! This crate was written with features baked in and hidden behind feature-gates. The idea is that

src/nalgebra.rs

@@ -1,9 +1,5 @@
 use alga::general::{ClosedAdd, ClosedDiv, ClosedMul, ClosedSub};
-use nalgebra::{
+use nalgebra::{Scalar, Vector, Vector1, Vector2, Vector3, Vector4, Vector5, Vector6};
-  DefaultAllocator, DimName, Point, Scalar, Vector, Vector1, Vector2, Vector3, Vector4, Vector5,
-  Vector6
-};
-use nalgebra::allocator::Allocator;
 use num_traits as nt;
 use std::ops::Mul;
 
@@ -12,7 +8,7 @@ use crate::interpolate::{Interpolate, Linear, Additive, One, cubic_hermite_def};
 macro_rules! impl_interpolate_vector {
   ($($t:tt)*) => {
     // implement Linear
-    impl<T> Linear<T> for $($t)*<T> where T: Scalar + ClosedMul + ClosedDiv {
+    impl<T> Linear<T> for $($t)*<T> where T: Scalar + ClosedAdd + ClosedSub + ClosedMul + ClosedDiv {
       #[inline(always)]
       fn outer_mul(self, t: T) -> Self {
         self * t
@@ -54,19 +50,3 @@ impl_interpolate_vector!(Vector3);
 impl_interpolate_vector!(Vector4);
 impl_interpolate_vector!(Vector5);
 impl_interpolate_vector!(Vector6);
-
-impl<T, D> Linear<T> for Point<T, D>
-where D: DimName,
-      DefaultAllocator: Allocator<T, D>,
-      <DefaultAllocator as Allocator<T, D>>::Buffer: Copy,
-      T: Scalar + ClosedDiv + ClosedMul {
-  #[inline(always)]
-  fn outer_mul(self, t: T) -> Self {
-    self * t
-  }
-
-  #[inline(always)]
-  fn outer_div(self, t: T) -> Self {
-    self / t
-  }
-}

src/spline.rs

@@ -1,3 +1,5 @@
+//! Spline curves and operations.
+
 #[cfg(feature = "serialization")] use serde_derive::{Deserialize, Serialize};
 #[cfg(not(feature = "std"))] use alloc::vec::Vec;
 #[cfg(feature = "std")] use std::cmp::Ordering;
@@ -10,17 +12,33 @@ use crate::interpolation::Interpolation;
 use crate::key::Key;
 
 /// Spline curve used to provide interpolation between control points (keys).
+///
+/// Splines are made out of control points ([`Key`]). When creating a [`Spline`] with
+/// [`Spline::from_vec`] or [`Spline::from_iter`], the keys don’t have to be sorted (they are sorted
+/// automatically by the sampling value).
+///
+/// You can sample from a spline with several functions:
+///
+///   - [`Spline::sample`]: allows you to sample from a spline. If not enough keys are available
+///     for the required interpolation mode, you get `None`.
+///   - [`Spline::clamped_sample`]: behaves like [`Spline::sample`] but will return either the first
+///     or last key if out of bound; it will return `None` if not enough key.
 #[derive(Debug, Clone)]
 #[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
 pub struct Spline<T, V>(pub(crate) Vec<Key<T, V>>);
 
 impl<T, V> Spline<T, V> {
+  /// Internal sort to ensure invariant of sorting keys is valid.
+  fn internal_sort(&mut self) where T: PartialOrd {
+    self.0.sort_by(|k0, k1| k0.t.partial_cmp(&k1.t).unwrap_or(Ordering::Less));
+  }
+
   /// Create a new spline out of keys. The keys don’t have to be sorted even though it’s recommended
   /// to provide ascending sorted ones (for performance purposes).
-  pub fn from_vec(mut keys: Vec<Key<T, V>>) -> Self where T: PartialOrd {
+  pub fn from_vec(keys: Vec<Key<T, V>>) -> Self where T: PartialOrd {
-    keys.sort_by(|k0, k1| k0.t.partial_cmp(&k1.t).unwrap_or(Ordering::Less));
+    let mut spline = Spline(keys);
-
+    spline.internal_sort();
-    Spline(keys)
+    spline
   }
 
   /// Create a new spline by consuming an `Iterater<Item = Key<T>>`. They keys don’t have to be
@@ -29,7 +47,7 @@ impl<T, V> Spline<T, V> {
   /// # Note on iterators
   ///
   /// It’s valid to use any iterator that implements `Iterator<Item = Key<T>>`. However, you should
-  /// use `Spline::from_vec` if you are passing a `Vec<_>`. This will remove dynamic allocations.
+  /// use [`Spline::from_vec`] if you are passing a [`Vec`].
   pub fn from_iter<I>(iter: I) -> Self where I: Iterator<Item = Key<T, V>>, T: PartialOrd {
     Self::from_vec(iter.collect())
   }
@@ -39,6 +57,18 @@ impl<T, V> Spline<T, V> {
     &self.0
   }
 
+  /// Number of keys.
+  #[inline(always)]
+  pub fn len(&self) -> usize {
+    self.0.len()
+  }
+
+  /// Check whether the spline has no key.
+  #[inline(always)]
+  pub fn is_empty(&self) -> bool {
+    self.0.is_empty()
+  }
+
   /// Sample a spline at a given time.
   ///
   /// The current implementation, based on immutability, cannot perform in constant time. This means
@@ -50,9 +80,10 @@ impl<T, V> Spline<T, V> {
   ///
   /// `None` if you try to sample a value at a time that has no key associated with. That can also
   /// happen if you try to sample between two keys with a specific interpolation mode that makes the
-  /// sampling impossible. For instance, `Interpolate::CatmullRom` requires *four* keys. If you’re
+  /// sampling impossible. For instance, [`Interpolation::CatmullRom`] requires *four* keys. If
-  /// near the beginning of the spline or its end, ensure you have enough keys around to make the
+  /// you’re near the beginning of the spline or its end, ensure you have enough keys around to make
-  /// sampling.
+  /// the sampling.
+  ///
   pub fn sample(&self, t: T) -> Option<V>
   where T: Additive + One + Trigo + Mul<T, Output = T> + Div<T, Output = T> + PartialOrd,
         V: Interpolate<T> {
@@ -105,11 +136,11 @@ impl<T, V> Spline<T, V> {
   /// # Return
   ///
   /// If you sample before the first key or after the last one, return the first key or the last
-  /// one, respectively. Otherwise, behave the same way as `Spline::sample`.
+  /// one, respectively. Otherwise, behave the same way as [`Spline::sample`].
   ///
   /// # Error
   ///
-  /// This function returns `None` if you have no key.
+  /// This function returns [`None`] if you have no key.
   pub fn clamped_sample(&self, t: T) -> Option<V>
   where T: Additive + One + Trigo + Mul<T, Output = T> + Div<T, Output = T> + PartialOrd,
         V: Interpolate<T> {
@@ -132,6 +163,21 @@ impl<T, V> Spline<T, V> {
       }
     })
   }
+
+  /// Add a key into the spline.
+  pub fn add(&mut self, key: Key<T, V>) where T: PartialOrd {
+    self.0.push(key);
+    self.internal_sort();
+  }
+
+  /// Remove a key from the spline.
+  pub fn remove(&mut self, index: usize) -> Option<Key<T, V>> {
+    if index >= self.0.len() {
+      None
+    } else {
+      Some(self.0.remove(index))
+    }
+  }
 }
 
 // Normalize a time ([0;1]) given two control points.

tests/mod.rs

@@ -172,3 +172,51 @@ fn nalgebra_vector_interpolation() {
   assert_eq!(Interpolate::lerp(start, end, 1.0), end);
   assert_eq!(Interpolate::lerp(start, end, 0.5), mid);
 }
+
+#[test]
+fn add_key_empty() {
+  let mut spline: Spline<f32, f32> = Spline::from_vec(vec![]);
+  spline.add(Key::new(0., 0., Interpolation::Linear));
+
+  assert_eq!(spline.keys(), &[Key::new(0., 0., Interpolation::Linear)]);
+}
+
+#[test]
+fn add_key() {
+  let start = Key::new(0., 0., Interpolation::Step(0.5));
+  let k1 = Key::new(1., 5., Interpolation::Linear);
+  let k2 = Key::new(2., 0., Interpolation::Step(0.1));
+  let k3 = Key::new(3., 1., Interpolation::Linear);
+  let k4 = Key::new(10., 2., Interpolation::Linear);
+  let end = Key::new(11., 4., Interpolation::default());
+  let new = Key::new(2.4, 40., Interpolation::Linear);
+  let mut spline = Spline::from_vec(vec![start, k1, k2.clone(), k3, k4, end]);
+
+  assert_eq!(spline.keys(), &[start, k1, k2, k3, k4, end]);
+  spline.add(new);
+  assert_eq!(spline.keys(), &[start, k1, k2, new, k3, k4, end]);
+}
+
+#[test]
+fn remove_element_empty() {
+  let mut spline: Spline<f32, f32> = Spline::from_vec(vec![]);
+  let removed = spline.remove(0);
+
+  assert_eq!(removed, None);
+  assert!(spline.is_empty());
+}
+
+#[test]
+fn remove_element() {
+  let start = Key::new(0., 0., Interpolation::Step(0.5));
+  let k1 = Key::new(1., 5., Interpolation::Linear);
+  let k2 = Key::new(2., 0., Interpolation::Step(0.1));
+  let k3 = Key::new(3., 1., Interpolation::Linear);
+  let k4 = Key::new(10., 2., Interpolation::Linear);
+  let end = Key::new(11., 4., Interpolation::default());
+  let mut spline = Spline::from_vec(vec![start, k1, k2.clone(), k3, k4, end]);
+  let removed = spline.remove(2);
+
+  assert_eq!(removed, Some(k2));
+  assert_eq!(spline.len(), 5);
+}