rename hanning to hann

Author: chohner

Diff for: CHANGELOG.md

@@ -1,6 +1,6 @@
 # Unreleased
 
-*No unreleased changes as of yet.*
+- Renamed `window-hanning` to `window-hann`
 
 ---
 

Diff for: README.md

@@ -36,7 +36,7 @@ within this repository:
 | [**`dasp_rms`**][dasp_rms] | [![Crates.io][dasp_rms-crates-io-svg]][dasp_rms-crates-io] [![docs.rs][dasp_rms-docs-rs-svg]][dasp_rms-docs-rs] | RMS detection with configurable window. |
 | [**`dasp_envelope`**][dasp_envelope] | [![Crates.io][dasp_envelope-crates-io-svg]][dasp_envelope-crates-io] [![docs.rs][dasp_envelope-docs-rs-svg]][dasp_envelope-docs-rs] | Envelope detection with peak and RMS impls. |
 | [**`dasp_interpolate`**][dasp_interpolate] | [![Crates.io][dasp_interpolate-crates-io-svg]][dasp_interpolate-crates-io] [![docs.rs][dasp_interpolate-docs-rs-svg]][dasp_interpolate-docs-rs] | Inter-frame rate interpolation (linear, sinc, etc). |
-| [**`dasp_window`**][dasp_window] | [![Crates.io][dasp_window-crates-io-svg]][dasp_window-crates-io] [![docs.rs][dasp_window-docs-rs-svg]][dasp_window-docs-rs] | Windowing function abstraction (hanning, rectangle). |
+| [**`dasp_window`**][dasp_window] | [![Crates.io][dasp_window-crates-io-svg]][dasp_window-crates-io] [![docs.rs][dasp_window-docs-rs-svg]][dasp_window-docs-rs] | Windowing function abstraction (hann, rectangle). |
 | [**`dasp_signal`**][dasp_signal] | [![Crates.io][dasp_signal-crates-io-svg]][dasp_signal-crates-io] [![docs.rs][dasp_signal-docs-rs-svg]][dasp_signal-docs-rs] | Iterator-like API for streams of audio frames. |
 
 [![deps-graph][deps-graph]][deps-graph]

Diff for: dasp/Cargo.toml

@@ -42,12 +42,12 @@ all-no-std = [
     "signal-envelope",
     "signal-rms",
     "signal-window",
-    "signal-window-hanning",
+    "signal-window-hann",
     "signal-window-rectangle",
     "slice",
     "slice-boxed",
     "window",
-    "window-hanning",
+    "window-hann",
     "window-rectangle",
 ]
 std = [
@@ -78,12 +78,12 @@ signal-bus = ["dasp_signal/bus"]
 signal-envelope = ["dasp_signal/envelope", "envelope"]
 signal-rms = ["dasp_signal/rms", "rms"]
 signal-window = ["dasp_signal/window", "window"]
-signal-window-hanning = ["dasp_signal/window-hanning", "window-hanning"]
+signal-window-hann = ["dasp_signal/window-hann", "window-hann"]
 signal-window-rectangle = ["dasp_signal/window-rectangle", "window-rectangle"]
 slice = ["dasp_slice"]
 slice-boxed = ["dasp_slice/boxed"]
 window = ["dasp_window"]
-window-hanning = ["dasp_window/hanning"]
+window-hann = ["dasp_window/hann"]
 window-rectangle = ["dasp_window/rectangle"]
 
 [package.metadata.docs.rs]

Diff for: dasp/src/lib.rs

@@ -61,16 +61,16 @@
 //!       trait.
 //!     - The **signal-window** feature enables the
 //!       [**signal::window**](./signal/window/index.html) module.
-//!     - The **signal-window-hanning** enables the
-//!       [**signal::window::hanning**](./signal/window/fn.hanning.html) window constructor.
+//!     - The **signal-window-hann** enables the
+//!       [**signal::window::hann**](./signal/window/fn.hann.html) window constructor.
 //!     - The **signal-window-rectangle** enables the
 //!       [**signal::window::rectangle**](./signal/window/fn.rectangle.html) window constructor.
 //! - The **slice** feature enables the `dasp_slice` crate via the [slice](./slice/index.html)
 //!   module.
 //!     - The **slice-boxed** feature enables boxed slice conversion traits and functions.
 //! - The **window** feature enables the `dasp_window` crate via the [window](./window/index.html)
 //!   module.
-//!     - The **window-hanning** feature enables the [**Hanning**](./window/struct.Hanning.html)
+//!     - The **window-hann** feature enables the [**Hann**](./window/struct.Hann.html)
 //!       window implementation.
 //!     - The **window-rectangle** feature enables the
 //!       [**Rectangle**](./window/struct.Rectangle.html) window implementation.

Diff for: dasp_signal/Cargo.toml

@@ -23,7 +23,7 @@ dasp_window = { version = "0.11", path = "../dasp_window", default-features = fa
 [dev-dependencies]
 dasp_envelope = { version = "0.11", path = "../dasp_envelope", default-features = false, features = ["peak"] }
 dasp_interpolate = { version = "0.11", path = "../dasp_interpolate", default-features = false, features = ["floor", "linear", "sinc"] }
-dasp_window = { version = "0.11", path = "../dasp_window", default-features = false, features = ["hanning"] }
+dasp_window = { version = "0.11", path = "../dasp_window", default-features = false, features = ["hann"] }
 
 [features]
 default = ["std"]
@@ -34,7 +34,7 @@ all-no-std = [
     "envelope",
     "rms",
     "window",
-    "window-hanning",
+    "window-hann",
     "window-rectangle",
 ]
 std = [
@@ -52,7 +52,7 @@ bus = []
 envelope = ["dasp_envelope"]
 rms = ["dasp_rms"]
 window = ["dasp_window"]
-window-hanning = ["dasp_window/hanning"]
+window-hann = ["dasp_window/hann"]
 window-rectangle = ["dasp_window/rectangle"]
 
 [package.metadata.docs.rs]

Diff for: dasp_signal/src/window/hanning.rs renamed to dasp_signal/src/window/hann.rs

@@ -1,29 +1,29 @@
 use super::{Window, Windower};
 use dasp_frame::Frame;
-use dasp_window::Hanning;
+use dasp_window::Hann;
 
-impl<'a, F> Windower<'a, F, Hanning>
+impl<'a, F> Windower<'a, F, Hann>
 where
     F: 'a + Frame,
 {
-    /// Constructor for a `Windower` using the `Hanning` window function.
+    /// Constructor for a `Windower` using the `Hann` window function.
     ///
     /// ### Required Features
     ///
-    /// - When using `dasp_signal`, this item requires the **window-hanning** feature to be enabled.
-    /// - When using `dasp`, this item requires the **signal-window-hanning** feature to be enabled.
-    pub fn hanning(frames: &'a [F], bin: usize, hop: usize) -> Self {
+    /// - When using `dasp_signal`, this item requires the **window-hann** feature to be enabled.
+    /// - When using `dasp`, this item requires the **signal-window-hann** feature to be enabled.
+    pub fn hann(frames: &'a [F], bin: usize, hop: usize) -> Self {
         Windower::new(frames, bin, hop)
     }
 }
 
-/// A helper function for constructing a `Window` that uses a `Hanning` `Type` function.
+/// A helper function for constructing a `Window` that uses a `Hann` `Type` function.
 ///
 /// ### Required Features
 ///
-/// - When using `dasp_signal`, this item requires the **window-hanning** feature to be enabled.
-/// - When using `dasp`, this item requires the **signal-window-hanning** feature to be enabled.
-pub fn hanning<F>(num_frames: usize) -> Window<F, Hanning>
+/// - When using `dasp_signal`, this item requires the **window-hann** feature to be enabled.
+/// - When using `dasp`, this item requires the **signal-window-hann** feature to be enabled.
+pub fn hann<F>(num_frames: usize) -> Window<F, Hann>
 where
     F: Frame,
 {

Diff for: dasp_signal/src/window/mod.rs

@@ -6,13 +6,13 @@ use dasp_frame::Frame;
 use dasp_sample::Sample;
 use dasp_window::Window as WindowType;
 
-#[cfg(feature = "window-hanning")]
-pub use hanning::hanning;
+#[cfg(feature = "window-hann")]
+pub use hann::hann;
 #[cfg(feature = "window-rectangle")]
 pub use rectangle::rectangle;
 
-#[cfg(feature = "window-hanning")]
-mod hanning;
+#[cfg(feature = "window-hann")]
+mod hann;
 #[cfg(feature = "window-rectangle")]
 mod rectangle;
 

Diff for: dasp_signal/tests/window.rs

@@ -3,10 +3,10 @@
 use dasp_frame::Frame;
 use dasp_signal::window::{self, Windower};
 
-#[cfg(feature = "window-hanning")]
+#[cfg(feature = "window-hann")]
 #[test]
 fn test_window_at_phase() {
-    let window = window::hanning::<f64>(9);
+    let window = window::hann::<f64>(9);
     let expected = [
         0.0, 0.1464, 0.5000, 0.8536, 1., 0.8536, 0.5000, 0.1464, 0., 0.1464,
     ];
@@ -39,11 +39,11 @@ fn test_windower() {
     }
 }
 
-#[cfg(feature = "window-hanning")]
+#[cfg(feature = "window-hann")]
 #[test]
 fn test_window_size() {
     let v = [1f32; 16];
-    let windows: Vec<Vec<_>> = Windower::hanning(&v, 8, 4)
+    let windows: Vec<Vec<_>> = Windower::hann(&v, 8, 4)
         .map(|i| i.take(8).collect::<Vec<f32>>())
         .take(3)
         .collect();

Diff for: dasp_window/Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "dasp_window"
-description = "Windowing function abstractions (e.g. hanning, rectangle) for audio PCM DSP."
+description = "Windowing function abstractions (e.g. hann, rectangle) for audio PCM DSP."
 version = "0.11.0"
 authors = ["mitchmindtree <[email protected]>"]
 readme = "../README.md"
-keywords = ["dsp", "window", "hanning", "pcm", "audio"]
+keywords = ["dsp", "window", "hann", "pcm", "audio"]
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/rustaudio/dasp.git"
 homepage = "https://github.com/rustaudio/dasp"
@@ -17,13 +17,13 @@ dasp_sample = { version = "0.11", path = "../dasp_sample", default-features = fa
 default = ["std"]
 all = ["std", "all-no-std"]
 all-no-std = [
-    "hanning",
+    "hann",
     "rectangle",
 ]
 std = [
     "dasp_sample/std",
 ]
-hanning = []
+hann = []
 rectangle = []
 
 [package.metadata.docs.rs]

Diff for: dasp_window/src/hanning/mod.rs renamed to dasp_window/src/hann/mod.rs

@@ -6,16 +6,16 @@ mod ops;
 
 /// A type of window function, also known as the "raised cosine window".
 ///
-/// [Wiki entry](https://en.wikipedia.org/wiki/Window_function#Hann_.28Hanning.29_window).
+/// [Wiki entry](https://en.wikipedia.org/wiki/Hann_function).
 ///
 /// ### Required Features
 ///
-/// - When using `dasp_window`, this item requires the **hanning** feature to be enabled.
-/// - When using `dasp`, this item requires the **window-hanning** feature to be enabled.
+/// - When using `dasp_window`, this item requires the **hann** feature to be enabled.
+/// - When using `dasp`, this item requires the **window-hann** feature to be enabled.
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
-pub struct Hanning;
+pub struct Hann;
 
-impl<S> Window<S> for Hanning
+impl<S> Window<S> for Hann
 where
     S: Sample,
 {

Diff for: dasp_window/src/hanning/ops.rs renamed to dasp_window/src/hann/ops.rs

@@ -1,10 +1,10 @@
-//! Module for windowing over a batch of Frames. Includes default Hanning and Rectangle window
+//! Module for windowing over a batch of Frames. Includes default Hann and Rectangle window
 //! types.
 //!
 //! ### Optional Features
 //!
-//! - The **hanning** feature (or **window-hanning** feature if using `dasp`) provides the
-//!   [**Hanning**](./struct.Hanning.html) window function implementation.
+//! - The **hann** feature (or **window-hann** feature if using `dasp`) provides the
+//!   [**Hann**](./struct.Hann.html) window function implementation.
 //! - The **rectangle** feature (or **window-rectangle** feature if using `dasp`) provides the
 //!   [**Rectangle**](./struct.Rectangle.html) window function implementation.
 //!
@@ -18,13 +18,13 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![cfg_attr(not(feature = "std"), feature(core_intrinsics))]
 
-#[cfg(feature = "hanning")]
-pub use hanning::Hanning;
+#[cfg(feature = "hann")]
+pub use hann::Hann;
 #[cfg(feature = "rectangle")]
 pub use rectangle::Rectangle;
 
-#[cfg(feature = "hanning")]
-mod hanning;
+#[cfg(feature = "hann")]
+mod hann;
 #[cfg(feature = "rectangle")]
 mod rectangle;