blobtk 0.8.1

Core utilities for BlobToolKit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310

use indicatif::{ProgressBar, ProgressStyle};

use rust_decimal::prelude::*;

use crate::{cli::RoundingStrategyWrapper, plot::axis::Scale};

pub mod compact_float {
    //! rounds a float to 3 significant figures, when serialized into a str, such as for JSON
    //! offers space savings when such precision is not needed.
    use rust_decimal::prelude::*;
    use rust_decimal::RoundingStrategy;
    use serde::{Deserialize, Deserializer, Serializer};

    pub fn serialize<S>(float: &f64, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let parsed = Decimal::from_f64_retain(*float)
            .and_then(|d| {
                d.round_sf_with_strategy(3, RoundingStrategy::MidpointAwayFromZero)
                    .map(|rounded| rounded.normalize())
            })
            .and_then(|d| d.to_f64())
            .unwrap_or(*float);
        serializer.serialize_f64(parsed)
    }

    pub fn serialize_option<S>(float: &Option<f64>, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match float {
            Some(value) => serialize(value, serializer),
            None => serializer.serialize_none(),
        }
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<f64, D::Error>
    where
        D: Deserializer<'de>,
    {
        f64::deserialize(deserializer)
    }
}

/// # Examples
///
/// ```
/// # use crate::blobtk::utils::format_si;
/// assert_eq!(format_si(&123456.0, 1, None), "100k");
/// assert_eq!(format_si(&123456.0, 2, None), "120k");
/// assert_eq!(format_si(&123456.0, 3, None), "123k");
/// assert_eq!(format_si(&123456.0, 4, None), "123.5k");
/// assert_eq!(format_si(&12.3, 3, None), "12.3");
/// assert_eq!(format_si(&12.3, 2, None), "12");
/// assert_eq!(format_si(&0.02655, 3, None), "0.03");
/// assert_eq!(format_si(&0.021, 3, None), "0.02");
/// assert_eq!(format_si(&0.02, 1, None), "0");
/// assert_eq!(format_si(&0.0002, 3, None), "200μ");
/// assert_eq!(format_si(&0.000246, 2, None), "250μ");
/// assert_eq!(format_si(&0.00000246, 2, None), "2.5μ");
/// ```
pub fn format_si(value: &f64, digits: u32, rounding: Option<RoundingStrategyWrapper>) -> String {
    fn set_suffix(thousands: i8) -> String {
        const POSITIVE: [&str; 9] = ["", "k", "M", "G", "T", "P", "E", "Z", "Y"];
        const NEGATIVE: [&str; 8] = ["", "μ", "p", "n", "f", "a", "z", "y"];
        let suffix = if (-8..0).contains(&thousands) {
            NEGATIVE[-thousands as usize]
        } else if (0..=9).contains(&thousands) {
            POSITIVE[thousands as usize]
        } else {
            ""
        };
        suffix.to_string()
    }

    let magnitude = if *value == 0.0 {
        0
    } else {
        (*value).log10() as i8
    };
    let thousands = magnitude / 3;
    let prefix = if thousands < 0 {
        *value * 10u32.pow(3 * (thousands.unsigned_abs() as u32 + 1)) as f64
    } else {
        *value / 10u32.pow(3 * thousands as u32) as f64
    };
    let d = Decimal::from_f64_retain(prefix).unwrap();
    let rounding_strategy = match rounding {
        Some(RoundingStrategyWrapper::MidpointAwayFromZero) => {
            RoundingStrategy::MidpointAwayFromZero
        }
        Some(RoundingStrategyWrapper::ToZero) => RoundingStrategy::ToZero,
        Some(RoundingStrategyWrapper::AwayFromZero) => RoundingStrategy::AwayFromZero,
        _ => RoundingStrategy::MidpointAwayFromZero,
    };
    let mut rounded = d
        .round_sf_with_strategy(digits, rounding_strategy)
        .unwrap()
        .normalize()
        .to_string();
    if thousands == 0 && rounded.starts_with("0.") {
        let rounded_value = (rounded.parse::<f64>().unwrap() * 1000.0).round() / 1000.0;
        let digits_usize = &(digits as usize - 1);
        rounded = format!("{:.digits_usize$}", rounded_value);
    }

    let suffix = set_suffix(thousands);
    format!("{}{}", rounded, suffix)
}

pub fn format_pct(value: &f64, digits: u32, rounding: Option<RoundingStrategyWrapper>) -> String {
    let mut rounded = Decimal::from_f64_retain(*value).unwrap();
    let rounding_strategy = match rounding {
        Some(RoundingStrategyWrapper::MidpointAwayFromZero) => {
            RoundingStrategy::MidpointAwayFromZero
        }
        Some(RoundingStrategyWrapper::ToZero) => RoundingStrategy::ToZero,
        Some(RoundingStrategyWrapper::AwayFromZero) => RoundingStrategy::AwayFromZero,
        _ => RoundingStrategy::MidpointAwayFromZero,
    };
    rounded = rounded
        .round_dp_with_strategy(digits, rounding_strategy)
        .normalize();
    format!("{}%", rounded)
}

pub fn indexed_sort<T: Ord>(list: &[T]) -> Vec<usize> {
    let mut indices = (0..list.len()).collect::<Vec<_>>();
    indices.sort_by_key(|&i| &list[i]);
    indices.reverse();
    indices
}

pub fn styled_bytes_progress_bar(total: u64, message: &str) -> ProgressBar {
    let progress_bar = ProgressBar::new(total);
    let format_string = format!(
        "[+]\t{}: {{bar:40.cyan/blue}} {{bytes:>10}}/{{total_bytes:12}} ({{eta}})",
        message
    );
    let pb_style_result = ProgressStyle::with_template(format_string.as_str());
    let pb_style = match pb_style_result {
        Ok(style) => style,
        Err(error) => panic!("Problem with the progress bar: {:?}", error),
    };
    progress_bar.set_style(pb_style);
    progress_bar
}

pub fn styled_progress_bar(total: usize, message: &str) -> ProgressBar {
    let progress_bar = ProgressBar::new(total as u64);
    let format_string = format!(
        "[+]\t{}: {{bar:40.cyan/blue}} {{pos:>7}}/{{len:12}}",
        message
    );

    let pb_style_result = ProgressStyle::with_template(format_string.as_str());
    let pb_style = match pb_style_result {
        Ok(style) => style,
        Err(error) => panic!("Problem with the progress bar: {:?}", error),
    };
    progress_bar.set_style(pb_style);
    progress_bar
}

/// Scale a usize value from input domain to output range as f64.
/// # Examples
///
/// ```
/// # use crate::blobtk::utils::linear_scale;
/// let domain = [10, 20];
/// let range = [0.0, 100.0];
/// assert_eq!(linear_scale(15, &domain, &range), 50.0);
/// ```
pub fn linear_scale(value: usize, domain: &[usize; 2], range: &[f64; 2]) -> f64 {
    let proportion = (value - domain[0]) as f64 / (domain[1] - domain[0]) as f64;
    (range[1] - range[0]) * proportion + range[0]
}

/// Scale a f64 value from input domain to output range as f64.
/// # Examples
///
/// ```
/// # use crate::blobtk::utils::linear_scale_float;
/// let domain = [10.0, 20.0];
/// let range = [0.0, 100.0];
/// assert_eq!(linear_scale_float(15.0, &domain, &range), 50.0);
/// ```
pub fn linear_scale_float(value: f64, domain: &[f64; 2], range: &[f64; 2]) -> f64 {
    let proportion = (value - domain[0]) / (domain[1] - domain[0]);
    (range[1] - range[0]) * proportion + range[0]
}

pub fn log_scale(value: usize, domain: &[usize; 2], range: &[f64; 2]) -> f64 {
    let proportion = ((value as f64).log10() - (domain[0] as f64).log10())
        / ((domain[1] as f64).log10() - (domain[0] as f64).log10());
    (range[1] - range[0]) * proportion + range[0]
}

pub fn log_scale_float(value: f64, domain: &[f64; 2], range: &[f64; 2]) -> f64 {
    let proportion = (value.log10() - domain[0].log10()) / (domain[1].log10() - domain[0].log10());
    (range[1] - range[0]) * proportion + range[0]
}

/// # Examples
///
/// ```
/// # use crate::blobtk::utils::sqrt_scale;
/// let domain = [1, 25];
/// let range = [0.0, 100.0];
/// assert_eq!(sqrt_scale(1, &domain, &range), 0.0);
/// assert_eq!(sqrt_scale(4, &domain, &range), 25.0);
/// assert_eq!(sqrt_scale(9, &domain, &range), 50.0);
/// assert_eq!(sqrt_scale(16, &domain, &range), 75.0);
/// assert_eq!(sqrt_scale(25, &domain, &range), 100.0);
/// ```

pub fn sqrt_scale(value: usize, domain: &[usize; 2], range: &[f64; 2]) -> f64 {
    let proportion = ((value as f64).sqrt() - (domain[0] as f64).sqrt())
        / ((domain[1] as f64).sqrt() - (domain[0] as f64).sqrt());
    (range[1] - range[0]) * proportion + range[0]
}

/// # Examples
///
/// ```
/// # use crate::blobtk::utils::sqrt_scale_float;
/// let domain = [1.0, 25.0];
/// let range = [0.0, 100.0];
/// assert_eq!(sqrt_scale_float(1.0, &domain, &range), 0.0);
/// assert_eq!(sqrt_scale_float(4.0, &domain, &range), 25.0);
/// assert_eq!(sqrt_scale_float(9.0, &domain, &range), 50.0);
/// assert_eq!(sqrt_scale_float(16.0, &domain, &range), 75.0);
/// assert_eq!(sqrt_scale_float(25.0, &domain, &range), 100.0);
/// ```
pub fn sqrt_scale_float(value: f64, domain: &[f64; 2], range: &[f64; 2]) -> f64 {
    let proportion = (value.sqrt() - domain[0].sqrt()) / (domain[1].sqrt() - domain[0].sqrt());
    (range[1] - range[0]) * proportion + range[0]
}

pub fn scale_float(
    value: f64,
    domain: &[f64; 2],
    range: &[f64; 2],
    scale_type: &String,
    clamp: Option<f64>,
) -> f64 {
    let scale_log = &String::from("scaleLog");
    let scale_sqrt = &String::from("scaleSqrt");
    if let Some(clamp_value) = clamp {
        if value < clamp_value {
            return clamp_value;
        }
    }
    if scale_type == scale_log {
        log_scale_float(value, domain, range)
    } else if scale_type == scale_sqrt {
        sqrt_scale_float(value, domain, range)
    } else {
        linear_scale_float(value, domain, range)
    }
}

pub fn scale_floats(
    value: f64,
    domain: &[f64; 2],
    range: &[f64; 2],
    scale_type: &Scale,
    clamp: Option<f64>,
) -> f64 {
    if let Some(clamp_value) = clamp {
        if value < clamp_value {
            return match scale_type {
                Scale::LINEAR => linear_scale_float(clamp_value, domain, range),
                Scale::SQRT => sqrt_scale_float(clamp_value, domain, range),
                Scale::LOG => log_scale_float(clamp_value, domain, range),
            };
        }
    }
    match scale_type {
        Scale::LINEAR => linear_scale_float(value, domain, range),
        Scale::SQRT => sqrt_scale_float(value, domain, range),
        Scale::LOG => log_scale_float(value, domain, range),
    }
}

pub fn max_float<T: PartialOrd>(a: T, b: T) -> T {
    if b > a {
        b
    } else {
        a
    }
}

pub fn min_float<T: PartialOrd>(a: T, b: T) -> T {
    if a < b {
        a
    } else {
        b
    }
}

pub fn format_element_id(title: &str) -> String {
    title
        .to_lowercase()
        .replace(' ', "_")
        .chars()
        .filter(|c| c.is_alphanumeric() || *c == '_')
        .collect::<String>()
}