neopdf 0.3.0-alpha2

A modern, fast, and reliable PDF interpolation library
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

//! This module defines metadata structures and types for describing PDF sets.
//!
//! It includes the `MetaData` struct (deserialized from .info files), PDF set
//! and interpolator type enums, and related utilities for handling PDF set information.
use serde::{Deserialize, Serialize};

/// Represents the type of PDF set.
#[repr(C)]
#[derive(Clone, Debug, Deserialize, Serialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum SetType {
    #[default]
    SpaceLike,
    TimeLike,
}

/// Represents the type of interpolator used for the PDF.
/// WARNING: When adding elements, always append at the end!!!
#[repr(C)]
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub enum InterpolatorType {
    Bilinear,
    LogBilinear,
    #[default]
    LogBicubic,
    LogTricubic,
    InterpNDLinear,
    LogChebyshev,
    LogFourCubic,
    LogFiveCubic,
}

/// Represents the information block of a given PDF set.
///
/// In order to support LHAPDF formats, the fields here are very much influenced by the
/// LHAPDF `.info` file. This struct is generally deserialized from a YAML-like format.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct MetaDataV2 {
    /// Description of the PDF set.
    #[serde(rename = "SetDesc")]
    pub set_desc: String,
    /// Index of the PDF set.
    #[serde(rename = "SetIndex")]
    pub set_index: u32,
    /// Number of members in the PDF set (e.g., for error analysis).
    #[serde(rename = "NumMembers")]
    pub num_members: u32,
    /// Minimum x-value for which the PDF is valid.
    #[serde(rename = "XMin")]
    pub x_min: f64,
    /// Maximum x-value for which the PDF is valid.
    #[serde(rename = "XMax")]
    pub x_max: f64,
    /// Minimum Q-value (energy scale) for which the PDF is valid.
    #[serde(rename = "QMin")]
    pub q_min: f64,
    /// Maximum Q-value (energy scale) for which the PDF is valid.
    #[serde(rename = "QMax")]
    pub q_max: f64,
    /// List of particle data group (PDG) IDs for the flavors included in the PDF.
    #[serde(rename = "Flavors")]
    pub flavors: Vec<i32>,
    /// Format of the PDF data.
    #[serde(rename = "Format")]
    pub format: String,
    /// AlphaS Q values (non-squared) for interpolation.
    #[serde(rename = "AlphaS_Qs", default)]
    pub alphas_q_values: Vec<f64>,
    /// AlphaS values for interpolation.
    #[serde(rename = "AlphaS_Vals", default)]
    pub alphas_vals: Vec<f64>,
    /// Polarisation of the hadrons.
    #[serde(rename = "Polarized", default)]
    pub polarised: bool,
    /// Type of the hadrons.
    #[serde(rename = "SetType", default)]
    pub set_type: SetType,
    /// Type of interpolator used for the PDF (e.g., "LogBicubic").
    #[serde(rename = "InterpolatorType", default)]
    pub interpolator_type: InterpolatorType,
    /// The error type representation of the PDF.
    #[serde(rename = "ErrorType", default)]
    pub error_type: String,
    /// The hadron PID value representation of the PDF.
    #[serde(rename = "Particle", default)]
    pub hadron_pid: i32,
    /// The git version of the code that generated the PDF.
    #[serde(rename = "GitVersion", default)]
    pub git_version: String,
    /// The code version (CARGO_PKG_VERSION) that generated the PDF.
    #[serde(rename = "CodeVersion", default)]
    pub code_version: String,
    /// Scheme for the treatment of heavy flavors
    #[serde(rename = "FlavorScheme", default)]
    pub flavor_scheme: String,
    /// Number of QCD loops in the calculation of PDF evolution.
    #[serde(rename = "OrderQCD", default)]
    pub order_qcd: u32,
    /// Number of QCD loops in the calculation of `alpha_s`.
    #[serde(rename = "AlphaS_OrderQCD", default)]
    pub alphas_order_qcd: u32,
    /// Value of the W boson mass.
    #[serde(rename = "MW", default)]
    pub m_w: f64,
    /// Value of the Z boson mass.
    #[serde(rename = "MZ", default)]
    pub m_z: f64,
    /// Value of the Up quark mass.
    #[serde(rename = "MUp", default)]
    pub m_up: f64,
    /// Value of the Down quark mass.
    #[serde(rename = "MDown", default)]
    pub m_down: f64,
    /// Value of the Strange quark mass.
    #[serde(rename = "MStrange", default)]
    pub m_strange: f64,
    /// Value of the Charm quark mass.
    #[serde(rename = "MCharm", default)]
    pub m_charm: f64,
    /// Value of the Bottom quark mass.
    #[serde(rename = "MBottom", default)]
    pub m_bottom: f64,
    /// Value of the Top quark mass.
    #[serde(rename = "MTop", default)]
    pub m_top: f64,
    /// Type of strong coupling computations.
    #[serde(rename = "AlphaS_Type", default)]
    pub alphas_type: String,
    /// Number of active PDF flavors.
    #[serde(rename = "NumFlavors", default)]
    pub number_flavors: u32,
    /// Minimum xi-value for which the PDF is valid.
    #[serde(rename = "XiMin", default)]
    pub xi_min: f64,
    /// Maximum xi-value for which the PDF is valid.
    #[serde(rename = "XiMax", default)]
    pub xi_max: f64,
    /// Minimum delta-value for which the PDF is valid.
    #[serde(rename = "DeltaMin", default)]
    pub delta_min: f64,
    /// Maximum delta-value for which the PDF is valid.
    #[serde(rename = "DeltaMax", default)]
    pub delta_max: f64,
}

impl MetaDataV2 {
    /// Helper to get quark masses as a tuple
    pub fn quark_masses(&self) -> (f64, f64, f64, f64, f64, f64) {
        (
            self.m_up,
            self.m_down,
            self.m_strange,
            self.m_charm,
            self.m_bottom,
            self.m_top,
        )
    }
}

impl std::fmt::Display for MetaDataV2 {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "Set Description: {}", self.set_desc)?;
        writeln!(f, "Set Index: {}", self.set_index)?;
        writeln!(f, "Number of Members: {}", self.num_members)?;
        writeln!(f, "XMin: {}", self.x_min)?;
        writeln!(f, "XMax: {}", self.x_max)?;
        writeln!(f, "QMin: {}", self.q_min)?;
        writeln!(f, "QMax: {}", self.q_max)?;
        writeln!(f, "Flavors: {:?}", self.flavors)?;
        writeln!(f, "Format: {}", self.format)?;
        writeln!(f, "AlphaS Q Values: {:?}", self.alphas_q_values)?;
        writeln!(f, "AlphaS Values: {:?}", self.alphas_vals)?;
        writeln!(f, "Polarized: {}", self.polarised)?;
        writeln!(f, "Set Type: {:?}", self.set_type)?;
        writeln!(f, "Interpolator Type: {:?}", self.interpolator_type)?;
        writeln!(f, "Error Type: {}", self.error_type)?;
        writeln!(f, "Particle: {}", self.hadron_pid)?;
        writeln!(f, "Flavor Scheme: {}", self.flavor_scheme)?;
        writeln!(f, "Order QCD: {}", self.order_qcd)?;
        writeln!(f, "AlphaS Order QCD: {}", self.alphas_order_qcd)?;
        writeln!(f, "MW: {}", self.m_w)?;
        writeln!(f, "MZ: {}", self.m_z)?;
        writeln!(f, "MUp: {}", self.m_up)?;
        writeln!(f, "MDown: {}", self.m_down)?;
        writeln!(f, "MStrange: {}", self.m_strange)?;
        writeln!(f, "MCharm: {}", self.m_charm)?;
        writeln!(f, "MBottom: {}", self.m_bottom)?;
        writeln!(f, "MTop: {}", self.m_top)?;
        writeln!(f, "AlphaS Type: {}", self.alphas_type)?;
        writeln!(f, "Number of PDF flavors: {}", self.number_flavors)?;
        writeln!(f, "XiMin: {}", self.xi_min)?;
        writeln!(f, "XiMax: {}", self.xi_max)?;
        writeln!(f, "DeltaMin: {}", self.delta_min)?;
        write!(f, "DeltaMax: {}", self.delta_max)
    }
}

/// The following represent the main metadata type for v0.2.1+.
pub type MetaData = MetaDataV2;

/// Converts from legacy v0.2.0 MetaData to new v0.2.1 format
impl From<neopdf_legacy::metadata::MetaData> for MetaData {
    fn from(legacy: neopdf_legacy::metadata::MetaData) -> Self {
        Self {
            set_desc: legacy.set_desc.clone(),
            set_index: legacy.set_index,
            num_members: legacy.num_members,
            x_min: legacy.x_min,
            x_max: legacy.x_max,
            q_min: legacy.q_min,
            q_max: legacy.q_max,
            flavors: legacy.flavors.clone(),
            format: legacy.format.clone(),
            alphas_q_values: legacy.alphas_q_values.clone(),
            alphas_vals: legacy.alphas_vals.clone(),
            polarised: legacy.polarised,
            set_type: match legacy.set_type {
                neopdf_legacy::metadata::SetType::SpaceLike => SetType::SpaceLike,
                neopdf_legacy::metadata::SetType::TimeLike => SetType::TimeLike,
            },
            interpolator_type: match legacy.interpolator_type {
                neopdf_legacy::metadata::InterpolatorType::Bilinear => InterpolatorType::Bilinear,
                neopdf_legacy::metadata::InterpolatorType::LogBilinear => {
                    InterpolatorType::LogBilinear
                }
                neopdf_legacy::metadata::InterpolatorType::LogBicubic => {
                    InterpolatorType::LogBicubic
                }
                neopdf_legacy::metadata::InterpolatorType::LogTricubic => {
                    InterpolatorType::LogTricubic
                }
                neopdf_legacy::metadata::InterpolatorType::InterpNDLinear => {
                    InterpolatorType::InterpNDLinear
                }
                neopdf_legacy::metadata::InterpolatorType::LogChebyshev => {
                    InterpolatorType::LogChebyshev
                }
            },
            error_type: legacy.error_type.clone(),
            hadron_pid: legacy.hadron_pid,
            git_version: legacy.git_version.clone(),
            code_version: legacy.code_version.clone(),
            flavor_scheme: legacy.flavor_scheme.clone(),
            order_qcd: legacy.order_qcd,
            alphas_order_qcd: legacy.alphas_order_qcd,
            m_w: legacy.m_w,
            m_z: legacy.m_z,
            m_up: legacy.m_up,
            m_down: legacy.m_down,
            m_strange: legacy.m_strange,
            m_charm: legacy.m_charm,
            m_bottom: legacy.m_bottom,
            m_top: legacy.m_top,
            alphas_type: legacy.alphas_type.clone(),
            number_flavors: legacy.number_flavors,
            // New V2 fields with defaults
            xi_min: 0.0,
            xi_max: 0.0,
            delta_min: 0.0,
            delta_max: 0.0,
        }
    }
}