minimage 0.1.1

Minimum-image convention for periodic parallelepiped cells
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

//! Recoverable failures from a cell or a distance call.

use std::fmt;

/// Why a cell or a distance call could not run.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Error {
    /// A box length is not strictly positive, or H is singular.
    BadBox,
    /// Caller output length does not match the candidate count.
    BufferSize,
    /// A pair list or candidate list is empty when a count is required.
    Empty,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::BadBox => write!(f, "singular or non-positive cell"),
            Error::BufferSize => write!(f, "out buffer length must match the pair count"),
            Error::Empty => write!(f, "no pairs"),
        }
    }
}

impl std::error::Error for Error {}