copyright update: 2021 -> 2023

phip1611 · Feb 28, 2023 · ebc6bf5 · ebc6bf5
1 parent 3eae87d
commit ebc6bf5
Show file tree

Hide file tree

Showing 18 changed files with 47 additions and 49 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/examples/bench.rs b/examples/bench.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/examples/live-visualization.rs b/examples/live-visualization.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/examples/minimal.rs b/examples/minimal.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/examples/mp3-samples.rs b/examples/mp3-samples.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/error.rs b/src/error.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/fft/microfft_complex.rs b/src/fft/microfft_complex.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/fft/microfft_real.rs b/src/fft/microfft_real.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/fft/mod.rs b/src/fft/mod.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/fft/rustfft_complex.rs b/src/fft/rustfft_complex.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/frequency.rs b/src/frequency.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -28,16 +28,14 @@ use core::cmp::Ordering;
 use core::fmt::{Display, Formatter, Result};
 use core::ops::{Add, Div, Mul, Sub};
 
-/// A frequency. A convenient wrapper type around `f32`.
+/// A frequency in Hertz. A convenient wrapper type around `f32`.
 pub type Frequency = OrderableF32;
-/// The value of a frequency in a frequency spectrum. Convenient wrapper around `f32`.
-/// Not necessarily the magnitude of the complex numbers because scaling/normalization
-/// functions could have been applied.
+/// The value of a [`Frequency`] in a frequency spectrum. Also called the
+/// magnitude.
 pub type FrequencyValue = OrderableF32;
 
-/// Small convenient wrapper around `f32`.
-/// Mainly required to make `f32` operable in a sorted tree map.
-/// You should only use the type aliases `Frequency` and `FrequencyValue`.
+/// Wrapper around [`f32`] that guarantees a valid number, hence, the number is
+/// neither `NaN` or `infinite`. This makes the number orderable and sortable.
 #[derive(Debug, Copy, Clone, Default)]
 pub struct OrderableF32(f32);
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/limit.rs b/src/limit.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/scaling.rs b/src/scaling.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -84,27 +84,27 @@ pub type SpectrumScalingFunction = dyn Fn(f32, &SpectrumDataStats) -> f32;
 /// ```
 /// Function is of type [`SpectrumScalingFunction`].
 #[must_use]
-pub fn scale_20_times_log10(frequency_magnitude: f32, _stats: &SpectrumDataStats) -> f32 {
-    debug_assert!(!frequency_magnitude.is_infinite());
-    debug_assert!(!frequency_magnitude.is_nan());
-    debug_assert!(frequency_magnitude >= 0.0);
-    if frequency_magnitude == 0.0 {
+pub fn scale_20_times_log10(fr_val: f32, _stats: &SpectrumDataStats) -> f32 {
+    debug_assert!(!fr_val.is_infinite());
+    debug_assert!(!fr_val.is_nan());
+    debug_assert!(fr_val >= 0.0);
+    if fr_val == 0.0 {
         0.0
     } else {
-        20.0 * libm::log10f(frequency_magnitude)
+        20.0 * libm::log10f(fr_val)
     }
 }
 
 /// Scales each frequency value/amplitude in the spectrum to interval `[0.0; 1.0]`.
 /// Function is of type [`SpectrumScalingFunction`]. Expects that [`SpectrumDataStats::min`] is
 /// not negative.
 #[must_use]
-pub fn scale_to_zero_to_one(frequency_magnitude: f32, stats: &SpectrumDataStats) -> f32 {
-    debug_assert!(!frequency_magnitude.is_infinite());
-    debug_assert!(!frequency_magnitude.is_nan());
-    debug_assert!(frequency_magnitude >= 0.0);
+pub fn scale_to_zero_to_one(fr_val: f32, stats: &SpectrumDataStats) -> f32 {
+    debug_assert!(!fr_val.is_infinite());
+    debug_assert!(!fr_val.is_nan());
+    debug_assert!(fr_val >= 0.0);
     if stats.max != 0.0 {
-        frequency_magnitude / stats.max
+        fr_val / stats.max
     } else {
         0.0
     }
@@ -114,14 +114,14 @@ pub fn scale_to_zero_to_one(frequency_magnitude: f32, stats: &SpectrumDataStats)
 /// by the length of samples, so that values of different samples lengths are comparable.
 #[allow(non_snake_case)]
 #[must_use]
-pub fn divide_by_N(frequency_magnitude: f32, stats: &SpectrumDataStats) -> f32 {
-    debug_assert!(!frequency_magnitude.is_infinite());
-    debug_assert!(!frequency_magnitude.is_nan());
-    debug_assert!(frequency_magnitude >= 0.0);
+pub fn divide_by_N(fr_val: f32, stats: &SpectrumDataStats) -> f32 {
+    debug_assert!(!fr_val.is_infinite());
+    debug_assert!(!fr_val.is_nan());
+    debug_assert!(fr_val >= 0.0);
     if stats.n == 0.0 {
-        frequency_magnitude
+        fr_val
     } else {
-        frequency_magnitude / stats.n
+        fr_val / stats.n
     }
 }
 
@@ -130,15 +130,15 @@ pub fn divide_by_N(frequency_magnitude: f32, stats: &SpectrumDataStats) -> f32 {
 /// See <https://docs.rs/rustfft/latest/rustfft/#normalization>
 #[allow(non_snake_case)]
 #[must_use]
-pub fn divide_by_N_sqrt(frequency_magnitude: f32, stats: &SpectrumDataStats) -> f32 {
-    debug_assert!(!frequency_magnitude.is_infinite());
-    debug_assert!(!frequency_magnitude.is_nan());
-    debug_assert!(frequency_magnitude >= 0.0);
+pub fn divide_by_N_sqrt(fr_val: f32, stats: &SpectrumDataStats) -> f32 {
+    debug_assert!(!fr_val.is_infinite());
+    debug_assert!(!fr_val.is_nan());
+    debug_assert!(fr_val >= 0.0);
     if stats.n == 0.0 {
-        frequency_magnitude
+        fr_val
     } else {
         // https://docs.rs/rustfft/latest/rustfft/#normalization
-        frequency_magnitude / libm::sqrtf(stats.n)
+        fr_val / libm::sqrtf(stats.n)
     }
 }
 
@@ -195,7 +195,7 @@ mod tests {
         let _combined_static = combined(&[&scale_20_times_log10, &divide_by_N, &divide_by_N_sqrt]);
 
         // doesn't compile yet.. fix this once someone requests it
-        /*let closure_scaling_fnc = |frequency_magnitude: f32, _stats: &SpectrumDataStats| {
+        /*let closure_scaling_fnc = |fr_val: f32, _stats: &SpectrumDataStats| {
            0.0
         };
 

diff --git a/src/spectrum.rs b/src/spectrum.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/tests/mod.rs b/src/tests/mod.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/tests/sine.rs b/src/tests/sine.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/windows.rs b/src/windows.rs
@@ -1,7 +1,7 @@
 /*
 MIT License
 
-Copyright (c) 2021 Philipp Schuster
+Copyright (c) 2023 Philipp Schuster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal