cres 0.9.1

Cell resampling for collider events
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! `cres` is a crate for cell resampling, introduced in
//!
//! Unbiased Elimination of Negative Weights in Monte Carlo Samples\
//! J. Andersen, A. Maier\
//! [arXiv:2109.07851](https://arxiv.org/abs/2109.07851)
//!
//! Efficient negative-weight elimination in large high-multiplicity Monte Carlo event samples\
//! Jeppe R. Andersen, Andreas Maier, Daniel Maître\
//! [arXiv:2303.15246](https://arxiv.org/abs/2303.15246)
//!
//! # How to use
//!
//! Probably the best way to get started is to look at the examples, starting with
//! `examples/minimal.rs`.
//!
//! ## Most relevant modules
//!
//! - [prelude] exports a list of the most relevant classes and objects
//! - [cres] contains the main class and lists the steps that are performed
//! - [io] event input and output (from and to files)
//! - [event] for the internal event format
//! - [distance] for user-defined distance functions
//! - [seeds] and [resampler] for the resampling
//!
#![warn(missing_docs)]

#[cfg(target_family = "unix")]
#[cfg(feature = "capi")]
pub mod c_api;
/// Definition of event cells
pub mod cell;
/// Callbacks used upon cell construction and when writing out events
pub mod cell_collector;
/// Jet clustering helpers
pub mod cluster;
/// Output compression
pub mod compression;
pub mod cres;
/// Distance functions
pub mod distance;
/// Scattering event class
pub mod event;
/// Supported event file formats
pub mod formats;
/// Four-vector class
pub mod four_vector;
/// HepMC2 interface
pub mod hepmc2;
/// Event input/output
pub mod io;
/// LesHouches Event File interface
#[cfg(feature = "lhef")]
pub mod lhef;
/// Nearest neighbour search algorithms
pub mod neighbour_search;
/// BlackHat ntuple interface
#[cfg(feature = "ntuple")]
pub mod ntuple;
/// Phase-space partitions
pub mod partition;
/// Most important exports
pub mod prelude;
/// Progress bar
pub mod progress_bar;
/// Cell resampling
pub mod resampler;
/// Cell seed selection
pub mod seeds;
/// STRIPPER XML interface
#[cfg(feature = "stripper-xml")]
pub mod stripper_xml;
/// Common traits
pub mod traits;
/// Unweighting
pub mod unweight;
/// Vantage-point tree
pub mod vptree;

mod parsing;
mod util;

const fn parse_version(s: &str) -> u32 {
    match u32::from_str_radix(s, 10) {
        Ok(int) => int,
        Err(_) => panic!("Failed to parse version number"),
    }
}

/// cres version
pub const VERSION: &str = env!("CARGO_PKG_VERSION");
/// Major version number
pub const VERSION_MAJOR: u32 = parse_version(env!("CARGO_PKG_VERSION_MAJOR"));
/// Minor version number
pub const VERSION_MINOR: u32 = parse_version(env!("CARGO_PKG_VERSION_MINOR"));
/// Patch version number
pub const VERSION_PATCH: u32 = parse_version(env!("CARGO_PKG_VERSION_PATCH"));
/// Hash of the compiled git commit
pub const GIT_REV: Option<&str> = option_env!("VERGEN_GIT_SHA");
/// git branch during compilation
pub const GIT_BRANCH: Option<&str> = option_env!("VERGEN_GIT_BRANCH");

/// Features enabled during compilation
pub const FEATURES: [&str; NFEATURES] = [
    #[cfg(feature = "lhef")]
    "lhef",
    #[cfg(feature = "multiweight")]
    "multiweight",
    #[cfg(feature = "ntuple")]
    "ntuple",
    #[cfg(feature = "stripper-xml")]
    "stripper-xml",
    #[cfg(feature = "capi")]
    "capi",
];

const NFEATURES: usize = {
    #[allow(unused_mut)]
    let mut nfeatures = 0;
    #[cfg(feature = "lhef")]
    {
        nfeatures += 1;
    }
    #[cfg(feature = "multiweight")]
    {
        nfeatures += 1;
    }
    #[cfg(feature = "ntuple")]
    {
        nfeatures += 1;
    }
    #[cfg(feature = "stripper-xml")]
    {
        nfeatures += 1;
    }
    #[cfg(feature = "capi")]
    {
        nfeatures += 1;
    }
    nfeatures
};

pub use noisy_float::prelude::{n64, N64, Float};
pub use particle_id::*;