hoomd-utility 1.1.0

Types and methods commonly used in hoomd-rs.
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

// Copyright (c) 2024-2026 The Regents of the University of Michigan.
// Part of hoomd-rs, released under the BSD 3-Clause License.

//! Ensure that values are in well-defined ranges.

mod open_unit_interval_number;
mod positive_real;

use thiserror::Error;

pub use open_unit_interval_number::OpenUnitIntervalNumber;
pub use positive_real::PositiveReal;

/// Enumerate possible sources of error in fallible validation methods.
#[non_exhaustive]
#[derive(Error, PartialEq, Debug)]
pub enum Error {
    /// A positive value greater than 0 is required.
    #[error("{0} is not greater than 0")]
    NotPositive(f64),

    /// A finite value is required.
    #[error("{0} is not finite")]
    NotFinite(f64),

    /// An value in (0,1) is required.
    #[error("{0} is not in (0,1)")]
    NotInOpenUnitInterval(f64),
}