shortestpath 0.10.0

Shortest Path is an experimental library finding the shortest path from A to B.
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

// Copyright (C) 2025 Christian Mauduit <ufoot@ufoot.org>

//! String representation utilities for sources.
//!
//! This module provides functions to convert `Source2D` and `Source3D` objects
//! into human-readable ASCII art strings, useful for debugging, testing, and
//! visualization.

use super::{CellType, Source2D, Source3D};

/// Represents a 2D source as a string.
///
/// Converts a `Source2D` into ASCII art where:
/// - `.` represents free/walkable cells
/// - `#` represents wall/blocked cells
/// - `?` represents cells that returned an error
///
/// Each row ends with a newline character.
///
/// # Example
///
/// ```
/// use shortestpath::mesh_source::{Source2DFromText, repr_source_2d};
///
/// let source = Source2DFromText::from_text("...\n.#.\n...");
/// let repr = repr_source_2d(&source);
/// assert_eq!(repr, "...\n.#.\n...\n");
/// ```
pub fn repr_source_2d(source: &impl Source2D) -> String {
    let mut output = String::new();
    for y in 0..source.height() {
        for x in 0..source.width() {
            let c = match source.get(x, y) {
                Ok(CellType::FLOOR) => '.',
                Ok(CellType::WALL) => '#',
                Err(_) => '?',
            };
            output.push(c);
        }
        output.push('\n');
    }
    output
}

/// Represents a 3D source as a string.
///
/// Converts a `Source3D` into ASCII art where:
/// - `.` represents free/walkable cells
/// - `#` represents wall/blocked cells
/// - `?` represents cells that returned an error
/// - `----` separates layers (z-levels)
///
/// Each row ends with a newline, and each layer is followed by "----\n".
///
/// # Example
///
/// ```
/// use shortestpath::mesh_source::{Source3DFromText, repr_source_3d};
///
/// let source = Source3DFromText::from_text("...\n.#.\n---\n...\n...");
/// let repr = repr_source_3d(&source);
/// // repr contains both layers separated by "----\n"
/// ```
pub fn repr_source_3d(source: &impl Source3D) -> String {
    let mut output = String::new();
    for z in 0..source.depth() {
        for y in 0..source.height() {
            for x in 0..source.width() {
                let c = match source.get(x, y, z) {
                    Ok(CellType::FLOOR) => '.',
                    Ok(CellType::WALL) => '#',
                    Err(_) => '?',
                };
                output.push(c);
            }
            output.push('\n');
        }
        output.push_str("----\n");
    }
    output
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::mesh_source::{Source2DFromText, Source3DFromText};

    #[test]
    fn test_repr_source_2d() {
        let source = Source2DFromText::from_text("...\n.#.\n...");
        let repr = repr_source_2d(&source);
        assert_eq!(repr, "...\n.#.\n...\n");
    }

    #[test]
    fn test_repr_source_3d() {
        let source = Source3DFromText::from_text("...\n.#.\n---\n...\n...");
        let repr = repr_source_3d(&source);
        assert_eq!(repr, "...\n.#.\n----\n...\n...\n----\n");
    }

    #[test]
    fn test_repr_source_2d_all_walls() {
        let source = Source2DFromText::from_text("###\n###");
        let repr = repr_source_2d(&source);
        assert_eq!(repr, "###\n###\n");
    }

    #[test]
    fn test_repr_source_2d_empty() {
        let source = Source2DFromText::from_text("");
        let repr = repr_source_2d(&source);
        assert_eq!(repr, "");
    }
}