ruviz 0.4.0

High-performance 2D plotting library for 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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
//! Strip plot implementations
//!
//! Provides strip plots (jittered scatter for categorical data).
//!
//! # Trait-Based API
//!
//! Strip plots implement the core plot traits:
//! - [`PlotConfig`] for `StripConfig`
//! - [`PlotCompute`] for `Strip` marker struct
//! - [`PlotData`] for `StripData`
//! - [`PlotRender`] for `StripData`

use crate::core::Result;
use crate::plots::traits::{PlotArea, PlotCompute, PlotConfig, PlotData, PlotRender};
use crate::render::skia::SkiaRenderer;
use crate::render::{Color, MarkerStyle, Theme};

/// Configuration for strip plot
#[derive(Debug, Clone)]
pub struct StripConfig {
    /// Jitter amount (0.0-1.0 as fraction of category spacing)
    pub jitter: f64,
    /// Marker size
    pub size: f32,
    /// Marker color (None for auto)
    pub color: Option<Color>,
    /// Marker alpha
    pub alpha: f32,
    /// Orientation
    pub orientation: StripOrientation,
    /// Dodge groups (for grouped strip plots)
    pub dodge: bool,
    /// Random seed for jitter
    pub seed: u64,
}

/// Orientation for strip plots
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum StripOrientation {
    Vertical,
    Horizontal,
}

impl Default for StripConfig {
    fn default() -> Self {
        Self {
            jitter: 0.3,
            size: 5.0,
            color: None,
            alpha: 0.8,
            orientation: StripOrientation::Vertical,
            dodge: false,
            seed: 42,
        }
    }
}

impl StripConfig {
    /// Create new config
    pub fn new() -> Self {
        Self::default()
    }

    /// Set jitter amount
    pub fn jitter(mut self, jitter: f64) -> Self {
        self.jitter = jitter.clamp(0.0, 1.0);
        self
    }

    /// Set marker size
    pub fn size(mut self, size: f32) -> Self {
        self.size = size.max(0.1);
        self
    }

    /// Set color
    pub fn color(mut self, color: Color) -> Self {
        self.color = Some(color);
        self
    }

    /// Set alpha
    pub fn alpha(mut self, alpha: f32) -> Self {
        self.alpha = alpha.clamp(0.0, 1.0);
        self
    }

    /// Set horizontal orientation
    pub fn horizontal(mut self) -> Self {
        self.orientation = StripOrientation::Horizontal;
        self
    }

    /// Enable dodging for groups
    pub fn dodge(mut self, dodge: bool) -> Self {
        self.dodge = dodge;
        self
    }

    /// Set random seed
    pub fn seed(mut self, seed: u64) -> Self {
        self.seed = seed;
        self
    }
}

// Implement PlotConfig marker trait
impl PlotConfig for StripConfig {}

/// Marker struct for Strip plot type (used with PlotCompute trait)
pub struct Strip;

/// A single point in a strip plot
#[derive(Debug, Clone, Copy)]
pub struct StripPoint {
    /// Category index
    pub category: usize,
    /// Value
    pub value: f64,
    /// Jittered x position
    pub x: f64,
    /// Y position (value for vertical, category for horizontal)
    pub y: f64,
    /// Optional group index
    pub group: Option<usize>,
}

/// Simple pseudo-random number generator
struct SimpleRng {
    state: u64,
}

impl SimpleRng {
    fn new(seed: u64) -> Self {
        Self { state: seed }
    }

    fn next_f64(&mut self) -> f64 {
        // xorshift64
        self.state ^= self.state << 13;
        self.state ^= self.state >> 7;
        self.state ^= self.state << 17;
        (self.state as f64) / (u64::MAX as f64)
    }
}

/// Compute strip plot points
///
/// # Arguments
/// * `categories` - Category indices for each point
/// * `values` - Values for each point
/// * `groups` - Optional group indices
/// * `config` - Strip plot configuration
///
/// # Returns
/// Vec of StripPoint
pub fn compute_strip_points(
    categories: &[usize],
    values: &[f64],
    groups: Option<&[usize]>,
    config: &StripConfig,
) -> Vec<StripPoint> {
    let n = categories.len().min(values.len());
    if n == 0 {
        return vec![];
    }

    let mut rng = SimpleRng::new(config.seed);
    let mut points = Vec::with_capacity(n);

    // Find number of groups for dodging
    let num_groups = groups.map_or(1, |g| g.iter().max().map_or(1, |&m| m + 1));

    for i in 0..n {
        let cat = categories[i];
        let val = values[i];
        let grp = groups.map(|g| g.get(i).copied().unwrap_or(0));

        // Compute jitter
        let jitter = (rng.next_f64() - 0.5) * config.jitter;

        // Compute position with optional dodging
        let base_x = cat as f64;
        let x = if config.dodge && num_groups > 1 {
            let grp_idx = grp.unwrap_or(0);
            let dodge_width = 0.8 / num_groups as f64;
            let dodge_offset = (grp_idx as f64 - (num_groups - 1) as f64 / 2.0) * dodge_width;
            base_x + dodge_offset + jitter * dodge_width
        } else {
            base_x + jitter
        };

        let (x, y) = match config.orientation {
            StripOrientation::Vertical => (x, val),
            StripOrientation::Horizontal => (val, x),
        };

        points.push(StripPoint {
            category: cat,
            value: val,
            x,
            y,
            group: grp,
        });
    }

    points
}

/// Compute data range for strip plot
pub fn strip_range(
    points: &[StripPoint],
    num_categories: usize,
    orientation: StripOrientation,
) -> ((f64, f64), (f64, f64)) {
    if points.is_empty() {
        return ((0.0, 1.0), (0.0, 1.0));
    }

    let val_min = points.iter().map(|p| p.value).fold(f64::INFINITY, f64::min);
    let val_max = points
        .iter()
        .map(|p| p.value)
        .fold(f64::NEG_INFINITY, f64::max);

    let cat_range = (-0.5, num_categories as f64 - 0.5);

    match orientation {
        StripOrientation::Vertical => (cat_range, (val_min, val_max)),
        StripOrientation::Horizontal => ((val_min, val_max), cat_range),
    }
}

// ============================================================================
// Trait-Based API
// ============================================================================

/// Computed strip plot data
#[derive(Debug, Clone)]
pub struct StripData {
    /// All computed points
    pub points: Vec<StripPoint>,
    /// Number of categories
    pub num_categories: usize,
    /// Configuration used to compute this data
    pub(crate) config: StripConfig,
}

/// Input for strip plot computation
pub struct StripInput<'a> {
    /// Category indices
    pub categories: &'a [usize],
    /// Values
    pub values: &'a [f64],
    /// Optional group indices
    pub groups: Option<&'a [usize]>,
}

impl<'a> StripInput<'a> {
    /// Create new strip input
    pub fn new(categories: &'a [usize], values: &'a [f64]) -> Self {
        Self {
            categories,
            values,
            groups: None,
        }
    }

    /// Add groups
    pub fn with_groups(mut self, groups: &'a [usize]) -> Self {
        self.groups = Some(groups);
        self
    }
}

impl PlotCompute for Strip {
    type Input<'a> = StripInput<'a>;
    type Config = StripConfig;
    type Output = StripData;

    fn compute(input: Self::Input<'_>, config: &Self::Config) -> Result<Self::Output> {
        let points = compute_strip_points(input.categories, input.values, input.groups, config);

        if points.is_empty() {
            return Err(crate::core::PlottingError::EmptyDataSet);
        }

        // Calculate number of categories
        let num_categories = input.categories.iter().max().map_or(0, |&m| m + 1);

        Ok(StripData {
            points,
            num_categories,
            config: config.clone(),
        })
    }
}

impl PlotData for StripData {
    fn data_bounds(&self) -> ((f64, f64), (f64, f64)) {
        strip_range(&self.points, self.num_categories, self.config.orientation)
    }

    fn is_empty(&self) -> bool {
        self.points.is_empty()
    }
}

impl PlotRender for StripData {
    fn render(
        &self,
        renderer: &mut SkiaRenderer,
        area: &PlotArea,
        _theme: &Theme,
        color: Color,
    ) -> Result<()> {
        if self.points.is_empty() {
            return Ok(());
        }

        let config = &self.config;
        let point_color = config.color.unwrap_or(color).with_alpha(config.alpha);

        for point in &self.points {
            let (px, py) = area.data_to_screen(point.x, point.y);
            renderer.draw_marker(px, py, config.size, MarkerStyle::Circle, point_color)?;
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_strip_basic() {
        let categories = vec![0, 0, 0, 1, 1, 1, 2, 2, 2];
        let values = vec![1.0, 1.5, 2.0, 3.0, 3.5, 4.0, 2.0, 2.5, 3.0];
        let config = StripConfig::default();
        let points = compute_strip_points(&categories, &values, None, &config);

        assert_eq!(points.len(), 9);
        // Points should be jittered around their categories
        for point in &points {
            let expected_x = point.category as f64;
            assert!((point.x - expected_x).abs() < 0.5);
        }
    }

    #[test]
    fn test_strip_horizontal() {
        let categories = vec![0, 1, 2];
        let values = vec![1.0, 2.0, 3.0];
        let config = StripConfig::default().horizontal();
        let points = compute_strip_points(&categories, &values, None, &config);

        // For horizontal, x should be value, y should be category
        for point in &points {
            assert!((point.x - point.value).abs() < 1e-10);
        }
    }

    #[test]
    fn test_strip_with_groups() {
        let categories = vec![0, 0, 1, 1];
        let values = vec![1.0, 2.0, 1.0, 2.0];
        let groups = vec![0, 1, 0, 1];
        let config = StripConfig::default().dodge(true);
        let points = compute_strip_points(&categories, &values, Some(&groups), &config);

        assert_eq!(points.len(), 4);
        // Each point should have a group
        for point in &points {
            assert!(point.group.is_some());
        }
    }

    #[test]
    fn test_strip_range() {
        let categories = vec![0, 1, 2];
        let values = vec![1.0, 5.0, 3.0];
        let config = StripConfig::default();
        let points = compute_strip_points(&categories, &values, None, &config);
        let ((x_min, x_max), (y_min, y_max)) = strip_range(&points, 3, StripOrientation::Vertical);

        assert!(x_min < 0.0);
        assert!(x_max > 2.0);
        assert!((y_min - 1.0).abs() < 1e-10);
        assert!((y_max - 5.0).abs() < 1e-10);
    }

    #[test]
    fn test_strip_empty() {
        let categories: Vec<usize> = vec![];
        let values: Vec<f64> = vec![];
        let config = StripConfig::default();
        let points = compute_strip_points(&categories, &values, None, &config);

        assert!(points.is_empty());
    }

    #[test]
    fn test_strip_config_implements_plot_config() {
        fn assert_plot_config<T: PlotConfig>() {}
        assert_plot_config::<StripConfig>();
    }

    #[test]
    fn test_strip_plot_compute_trait() {
        use crate::plots::traits::PlotCompute;

        let categories = vec![0, 0, 1, 1, 2, 2];
        let values = vec![1.0, 1.5, 2.0, 2.5, 3.0, 3.5];
        let config = StripConfig::default();
        let input = StripInput::new(&categories, &values);
        let result = Strip::compute(input, &config);

        assert!(result.is_ok());
        let strip_data = result.unwrap();
        assert_eq!(strip_data.points.len(), 6);
        assert_eq!(strip_data.num_categories, 3);
    }

    #[test]
    fn test_strip_plot_compute_with_groups() {
        use crate::plots::traits::PlotCompute;

        let categories = vec![0, 0, 1, 1];
        let values = vec![1.0, 2.0, 1.0, 2.0];
        let groups = vec![0, 1, 0, 1];
        let config = StripConfig::default().dodge(true);
        let input = StripInput::new(&categories, &values).with_groups(&groups);
        let result = Strip::compute(input, &config);

        assert!(result.is_ok());
        let strip_data = result.unwrap();
        assert_eq!(strip_data.points.len(), 4);
    }

    #[test]
    fn test_strip_plot_compute_empty() {
        use crate::plots::traits::PlotCompute;

        let categories: Vec<usize> = vec![];
        let values: Vec<f64> = vec![];
        let config = StripConfig::default();
        let input = StripInput::new(&categories, &values);
        let result = Strip::compute(input, &config);

        assert!(result.is_err());
    }

    #[test]
    fn test_strip_plot_data_trait() {
        use crate::plots::traits::{PlotCompute, PlotData};

        let categories = vec![0, 1, 2];
        let values = vec![1.0, 5.0, 3.0];
        let config = StripConfig::default();
        let input = StripInput::new(&categories, &values);
        let strip_data = Strip::compute(input, &config).unwrap();

        // Test data_bounds
        let ((x_min, x_max), (y_min, y_max)) = strip_data.data_bounds();
        assert!(x_min <= x_max);
        assert!(y_min <= y_max);

        // Test is_empty
        assert!(!strip_data.is_empty());
    }
}