spherical-cow 0.1.3

Spherical Cow: High volume fraction sphere packing in arbitrary geometries
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

//! Handles any errors that could occur during packing.

use std::error::Error;
use std::fmt;

#[derive(Debug)]
/// All errors thrown by the library
pub enum SphericalCowError {
    /// If a sphere is given a negative radius.
    NegativeRadius,
    /// If a cuboid is given a negative half extent.
    NegativeExtents,
    /// If a sphere is created but is not confined by the `Container`.
    /// This happens quite a lot and is generally handled silently. This error
    /// is only thrown by the `init_spheres` method. Usually this means the geometry
    /// of the container is perhaps not aligned to the origin, it is scaled too small,
    /// or the spheres you're attempting to pack are too large.
    Uncontained,
    /// We choose a random value from the `set_f` vector. `rand` returns an option and we pop
    /// the value. If it's `None` this error is thrown. Due to the contstuction of the
    /// rest of the method, it's safe to say this is unreachable.
    NoneSetF,
    /// We choose a random value from the `front` vector. `rand` returns an option and we pop
    /// the value. If it's `None` this error is thrown. Due to the contstuction of the
    /// rest of the method, it's safe to say this is unreachable.
    NoneFront,
}

impl fmt::Display for SphericalCowError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            SphericalCowError::NegativeRadius => write!(f, "Supplied radius is negative."),
            SphericalCowError::NegativeExtents => write!(f, "A supplied half extent is negative."),
            SphericalCowError::Uncontained => {
                write!(f, "Sphere is not contained within bounding geometry.")
            }
            SphericalCowError::NoneSetF => {
                write!(f, "Returned none when choosing value from set f.")
            }
            SphericalCowError::NoneFront => {
                write!(f, "Returned none when choosing value from front.")
            }
        }
    }
}

impl Error for SphericalCowError {}

#[test]
fn error_display_negative_radius() {
    use crate::shapes::Sphere;
    use nalgebra::Point3;

    let err = Sphere::new(Point3::origin(), -1.).unwrap_err();
    assert_eq!(format!("{}", err), format!("Supplied radius is negative."));
}

#[test]
fn error_display_negative_extent() {
    use crate::shapes::Cuboid;

    let err = Cuboid::new(1., 1., -1.).unwrap_err();
    assert_eq!(
        format!("{}", err),
        format!("A supplied half extent is negative.")
    );
}

#[test]
fn error_display_containment() {
    use crate::init_spheres;
    use crate::shapes::Sphere;
    use nalgebra::Point3;

    let container = Sphere::new(Point3::origin(), 0.1).unwrap();

    let err = init_spheres(&[10., 15., 20.], &container).unwrap_err();
    assert_eq!(
        format!("{}", err),
        format!("Sphere is not contained within bounding geometry.")
    );
}

#[test]
fn error_display_empty_values() {
    use crate::shapes::Sphere;
    use rand::prelude::SliceRandom;
    use rand::thread_rng;

    let empty_vec: Vec<Sphere> = Vec::new();
    let mut rng = thread_rng();

    let mut err = empty_vec
        .choose(&mut rng)
        .ok_or(SphericalCowError::NoneSetF)
        .unwrap_err();
    assert_eq!(
        format!("{}", err),
        format!("Returned none when choosing value from set f.")
    );

    err = empty_vec
        .choose(&mut rng)
        .ok_or(SphericalCowError::NoneFront)
        .unwrap_err();
    assert_eq!(
        format!("{}", err),
        format!("Returned none when choosing value from front.")
    );
}