pathfinder 0.6.5

Create nodes, clusters of nodes and connection in between.
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

/*!
Extra functionality for Nodes.
*/

use super::*;
use std::{
    cmp::PartialEq,
    fs::File,
    io::{self, prelude::*},
};

impl<'a> PartialEq for Node {
    fn eq(&self, other: &Node) -> bool {
        self.hash == other.hash
    }
}

/**
Returns a list of Strings split using \n in a Vec.


## Errors

Could not open file.
Could not read content to string.
*/
pub fn get_node_names(path: &str) -> Result<Vec<String>, io::Error> {
    let mut file = File::open(path)?;
    let mut contents = String::new();
    file.read_to_string(&mut contents)?;
    Ok(contents.split('\n').fold(vec![], |mut acc, x| {
        acc.push(x.to_string());
        acc
    }))
}

/**
Write the positions to a file.


## Errors

Could not open file.
Could not write to file.
 */
pub fn write_file(path: &str, nodes: &[Node]) -> std::io::Result<()> {
    let mut file = File::create(path)?;
    for n in nodes.iter() {
        let p = n.position();
        writeln!(&mut file, "{},{}", p.x, p.y)?;
    }
    Ok(())
}

/**
Reads the positions from a file.


Expects eact line format to be:

x,y


## Errors

Could not open file.
Could not read to string.

*/
pub fn from_file(path: &str) -> Result<Vec<Node>, io::Error> {
    let mut contents = String::new();
    let mut file = File::open(path)?;
    file.read_to_string(&mut contents)?;
    Ok(contents.split('\n').fold(vec![], |mut acc, x| {
        let vals = x.split(',').collect::<Vec<_>>();
        let c = Coordinate::new(
            vals[0].parse::<i16>().unwrap(),
            vals[1].parse::<i16>().unwrap(),
        );
        acc.push(Node::new(x, c));
        acc
    }))
}

/**
Prints the distance between all the nodes paths and returns a summary of the total distance.
*/
pub fn path_print(path: &[Node]) -> u32 {
    verbose_path(path, true)
}

/**
 Returns the sum distance that all the nodes' are from each other.
*/
pub fn path_distances(path: &[Node]) -> u32 {
    verbose_path(path, false)
}

/**
Implementation of path_distance and path_print, Use those for interfacing.
*/
fn verbose_path<L: Location>(path: &[L], stdout: bool) -> u32 {
    let mut prev = Coordinate::new(0, 0);
    let distance = path.iter().fold(0, |sum, x| {
        let dis = coordinate::distance(prev, x.position());
        prev = x.position();
        if stdout {
            debug!("{} - distance: {}", x.position(), dis);
        }
        sum + dis
    });

    if stdout {
        debug!("Total distance: {}", distance);
    }
    distance
}

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

    #[test]
    fn test_get_node_names_fail() {
        let res = get_node_names("invalid path");
        assert!(res.is_err());
    }

}