Skip to content

Commit 8bddbce

Browse files
committed
Renamed function names to their full names instead of abbreviations
1 parent d78bed0 commit 8bddbce

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

src/signal_analysis/yin.rs

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ impl Yin {
5858
}
5959

6060
pub fn yin(&self, frequencies: &[f64]) -> YinResult {
61-
let df = df_values(frequencies, self.max_lag);
62-
let cmndf = cmndf_values(&df, self.max_lag);
61+
let df = difference_function_values(frequencies, self.max_lag);
62+
let cmndf = cumulative_mean_normalized_difference_function(&df, self.max_lag);
6363
let best_lag = find_cmndf_argmin(&cmndf, self.min_lag, self.max_lag, self.threshold);
6464
YinResult {
6565
sample_rate: self.sample_rate,
@@ -70,15 +70,15 @@ impl Yin {
7070
}
7171

7272
#[allow(clippy::needless_range_loop)]
73-
fn df_values(frequencies: &[f64], max_lag: usize) -> Vec<f64> {
73+
fn difference_function_values(frequencies: &[f64], max_lag: usize) -> Vec<f64> {
7474
let mut df_list = vec![0.0; max_lag + 1];
7575
for lag in 1..=max_lag {
76-
df_list[lag] = df(frequencies, lag);
76+
df_list[lag] = difference_function(frequencies, lag);
7777
}
7878
df_list
7979
}
8080

81-
fn df(f: &[f64], lag: usize) -> f64 {
81+
fn difference_function(f: &[f64], lag: usize) -> f64 {
8282
let mut sum = 0.0;
8383
let n = f.len();
8484
for i in 0..(n - lag) {
@@ -88,8 +88,7 @@ fn df(f: &[f64], lag: usize) -> f64 {
8888
sum
8989
}
9090

91-
// Cumulative Mean Normalized Difference Function
92-
fn cmndf_values(df: &[f64], max_lag: usize) -> Vec<f64> {
91+
fn cumulative_mean_normalized_difference_function(df: &[f64], max_lag: usize) -> Vec<f64> {
9392
let mut cmndf = vec![0.0; max_lag + 1];
9493
cmndf[0] = 1.0;
9594
let mut sum = 0.0;

0 commit comments

Comments
 (0)