map2fig 0.7.7

Fast, publication-quality HEALPix sky map visualization in Rust
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351

//! Property-based tests for critical functions using proptest
//!
//! These tests verify mathematical properties that should ALWAYS hold,
//! across thousands of randomly-generated inputs. Unlike unit tests,
//! property tests discover edge cases humans wouldn't think of.

use map2fig::scale::{Scale, scale_value};
use map2fig::{NegMode, PixelValue};
use proptest::prelude::*;

// ============================================================================
// SCALING PROPERTIES
// ============================================================================

/// Property: Linear scaling always produces normalized output in [0.0, 1.0]
#[test]
fn prop_linear_scaling_bounded() {
    proptest!(|(
        value in -1e6f64..1e6f64,
        min in -1e6f64..0f64,
        max in 0f64..1e6f64,
    )| {
        let result = scale_value(value, min, max, Scale::Linear, NegMode::Zero, None, None);

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (0.0..=1.0).contains(&t),
                "Linear scale produced out-of-bounds value: {} (value={}, min={}, max={})",
                t, value, min, max
            );
        }
    });
}

/// Property: Values equal to min always scale to 0.0
#[test]
fn prop_linear_min_value_scales_to_zero() {
    proptest!(|(
        min in -1e6f64..1e6f64,
        max in -1e6f64..1e6f64,
    )| {
        let min = min.min(max);
        let max = max.max(min + 1e-6); // Ensure min < max

        let result = scale_value(min, min, max, Scale::Linear, NegMode::Zero, None, None);

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (t - 0.0).abs() < 1e-10,
                "Value at min should scale to 0.0, got {} (min={}, max={})",
                t, min, max
            );
        }
    });
}

/// Property: Values equal to max always scale to 1.0
#[test]
fn prop_linear_max_value_scales_to_one() {
    proptest!(|(
        min in -1e6f64..1e6f64,
        max in -1e6f64..1e6f64,
    )| {
        let min = min.min(max);
        let max = max.max(min + 1e-6); // Ensure min < max

        let result = scale_value(max, min, max, Scale::Linear, NegMode::Zero, None, None);

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (t - 1.0).abs() < 1e-10,
                "Value at max should scale to 1.0, got {} (min={}, max={})",
                t, min, max
            );
        }
    });
}

/// Property: Log scaling always produces normalized [0.0, 1.0] output
#[test]
fn prop_log_scaling_bounded() {
    proptest!(|(
        value in 1e-6f64..1e6f64,  // Log scale requires positive values
        min in 1e-6f64..1e3f64,
        max in 1e-6f64..1e6f64,
    )| {
        let min = min.min(max);
        let max = max.max(min * 1.0001); // Ensure min < max

        let result = scale_value(value, min, max, Scale::Log, NegMode::Zero, None, None);

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (0.0..=1.0).contains(&t),
                "Log scale produced out-of-bounds value: {} (value={}, min={}, max={})",
                t, value, min, max
            );
        }
    });
}

/// Property: SymLog scaling always produces normalized [0.0, 1.0] output
#[test]
fn prop_symlog_scaling_bounded() {
    proptest!(|(
        value in -1e6f64..1e6f64,
        min in -1e6f64..1e6f64,
        max in -1e6f64..1e6f64,
    )| {
        let min = min.min(max);
        let max = max.max(min + 1e-6); // Ensure min < max

        let result = scale_value(
            value, min, max,
            Scale::Symlog { linthresh: 1.0 },
            NegMode::Zero,
            None,
            None
        );

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (0.0..=1.0).contains(&t),
                "SymLog scale produced out-of-bounds value: {} (value={}, min={}, max={})",
                t, value, min, max
            );
        }
    });
}

/// Property: Asinh scaling always produces normalized [0.0, 1.0] output
#[test]
fn prop_asinh_scaling_bounded() {
    proptest!(|(
        value in -1e6f64..1e6f64,
        min in -1e6f64..1e6f64,
        max in -1e6f64..1e6f64,
    )| {
        let min = min.min(max);
        let max = max.max(min + 1e-6); // Ensure min < max

        let result = scale_value(
            value, min, max,
            Scale::Asinh { scale: 1.0 },
            NegMode::Zero,
            None,
            None
        );

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (0.0..=1.0).contains(&t),
                "Asinh scale produced out-of-bounds value: {} (value={}, min={}, max={})",
                t, value, min, max
            );
        }
    });
}

/// Property: NaN values always produce PixelValue::Bad
#[test]
fn prop_nan_always_bad() {
    proptest!(|(
        min in -1e6f64..1e6f64,
        max in -1e6f64..1e6f64,
    )| {
        let min = min.min(max);
        let max = max.max(min + 1e-6);

        let result = scale_value(f64::NAN, min, max, Scale::Linear, NegMode::Zero, None, None);

        match result {
            PixelValue::Bad => {/* OK */},
            other => prop_assert!(false, "NaN should produce PixelValue::Bad, got {:?}", other),
        }
    });
}

/// Property: Infinity values always produce PixelValue::Bad
#[test]
fn prop_infinity_always_bad() {
    proptest!(|(
        min in -1e6f64..1e6f64,
        max in -1e6f64..1e6f64,
    )| {
        let min = min.min(max);
        let max = max.max(min + 1e-6);

        let pos_inf = scale_value(f64::INFINITY, min, max, Scale::Linear, NegMode::Zero, None, None);
        let neg_inf = scale_value(f64::NEG_INFINITY, min, max, Scale::Linear, NegMode::Zero, None, None);

        match pos_inf {
            PixelValue::Bad => {/* OK */},
            other => prop_assert!(false, "Positive infinity should produce PixelValue::Bad, got {:?}", other),
        }

        match neg_inf {
            PixelValue::Bad => {/* OK */},
            other => prop_assert!(false, "Negative infinity should produce PixelValue::Bad, got {:?}", other),
        }
    });
}

/// Property: Monotonicity - if value1 < value2, their scaled values should satisfy scale1 <= scale2
#[test]
fn prop_linear_monotonic() {
    proptest!(|(
        v1 in -1e6f64..1e6f64,
        v2 in -1e6f64..1e6f64,
        min in -1e6f64..0f64,
        max in 0f64..1e6f64,
    )| {
        let (v1, v2) = if v1 < v2 { (v1, v2) } else { (v2, v1) };

        let r1 = scale_value(v1, min, max, Scale::Linear, NegMode::Zero, None, None);
        let r2 = scale_value(v2, min, max, Scale::Linear, NegMode::Zero, None, None);

        if let (PixelValue::Color(t1), PixelValue::Color(t2)) = (r1, r2) {
            prop_assert!(
                t1 <= t2,
                "Monotonicity violated: {} scaled to {}, {} scaled to {}",
                v1, t1, v2, t2
            );
        }
    });
}

/// Property: Values outside [min, max] clamp to [0.0, 1.0]
#[test]
fn prop_clamping() {
    proptest!(|(
        offset in 1e3f64..1e6f64,
        min in -1e3f64..0f64,
        max in 0f64..1e3f64,
    )| {
        // Test value below min
        let below_min = min - offset;
        let result_below = scale_value(below_min, min, max, Scale::Linear, NegMode::Zero, None, None);
        if let PixelValue::Color(t) = result_below {
            prop_assert!((t - 0.0).abs() < 1e-10, "Values below min should clamp to 0.0, got {}", t);
        }

        // Test value above max
        let above_max = max + offset;
        let result_above = scale_value(above_max, min, max, Scale::Linear, NegMode::Zero, None, None);
        if let PixelValue::Color(t) = result_above {
            prop_assert!((t - 1.0).abs() < 1e-10, "Values above max should clamp to 1.0, got {}", t);
        }
    });
}

// ============================================================================
// EDGE CASE PROPERTIES
// ============================================================================

/// Property: When min == max, any valid value scales to 0.5
#[test]
fn prop_min_equals_max_scales_to_half() {
    proptest!(|(
        val in -1e6f64..1e6f64,
        same_val in -1e6f64..1e6f64,
    )| {
        // Ensure same_val is not NaN/Inf
        prop_assume!(same_val.is_finite());

        let result = scale_value(val, same_val, same_val, Scale::Linear, NegMode::Zero, None, None);

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (t - 0.5).abs() < 1e-10,
                "When min == max, valid values should scale to 0.5, got {}",
                t
            );
        }
    });
}

/// Property: Negative scaling ranges work correctly
#[test]
fn prop_negative_range() {
    proptest!(|(
        value in -100f64..-1f64,
        min in -100f64..-50f64,
        max in -50f64..-1f64,
    )| {
        let result = scale_value(value, min, max, Scale::Linear, NegMode::Zero, None, None);

        if let PixelValue::Color(t) = result {
            prop_assert!(
                (0.0..=1.0).contains(&t),
                "Negative range scaling should still produce normalized output"
            );
        }
    });
}

/// Property: Very small ranges (near-zero differences) don't cause division by zero
#[test]
fn prop_tiny_range_safe() {
    proptest!(|(
        min in -1e6f64..1e6f64,
    )| {
        let max = min + 1e-12; // Extremely small range
        let value = (min + max) / 2.0;

        let result = scale_value(value, min, max, Scale::Linear, NegMode::Zero, None, None);

        if let PixelValue::Color(t) = result {
            prop_assert!(
                t.is_finite(),
                "Very small ranges should not produce NaN/Inf"
            );
        }
    });
}
// ============================================================================
// COLORMAP PROPERTIES
// ============================================================================

/// Property: Colormap sampling always produces valid output without panicking
#[test]
fn prop_colormap_sampling_bounds() {
    use map2fig::get_colormap;

    proptest!(|(
        t in 0.0f64..=1.0f64,
    )| {
        let cmap = get_colormap("viridis");
        // Should not panic - the actual result is valid if no panic occurs
        let _ = cmap.sample(t);
    });
}

/// Property: All available colormaps work without panicking
#[test]
fn prop_all_colormaps_valid() {
    use map2fig::available_colormaps;
    use map2fig::get_colormap;

    let cmap_names = available_colormaps();
    for name in cmap_names {
        // Should not panic
        let cmap = get_colormap(name);

        // Sample across the range - just verify no panic
        for i in 0..=10 {
            let t = i as f64 / 10.0;
            let _ = cmap.sample(t);
        }
    }
}