{"title":"YAM2 2.0: Yet another M2 with on-shell mass constraints and beyond","authors":"Chan Beom Park","doi":"10.1016/j.cpc.2025.109835","DOIUrl":null,"url":null,"abstract":"<div><div>We present a new version of YAM2 (“Yet Another <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> calculator”), a C++ library for computing the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> class of kinematic variables widely used in collider phenomenology with invisible particles. The main upgrade is the incorporation of new kinematic constraints: on-shell mass conditions implemented as equality constraints and vertex-reconstruction information as inequality constraints. The former enables precise treatment of the antler decay topology and generalizations such as <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn><mrow><mi>Cons</mi></mrow></mrow></msub></math></span>-like variables, while the latter extends applicability to cases where parent-particle flight directions can be inferred. Both extensions are implemented and validated within the sequential quadratic programming framework, ensuring robust performance in large-scale Monte Carlo studies. Additional improvements include CMake build support, extended example codes, and general code optimizations. With these updates, YAM2 2.0 provides a more versatile and user-friendly toolkit for collider analyses at both hadron and lepton colliders.</div></div><div><h3>New version program summary</h3><div><em>Program Title:</em> YAM2</div><div><em>CPC Library link to program files:</em> <span><span>https://doi.org/10.17632/4g7wfd5fpb.2</span><svg><path></path></svg></span></div><div><em>Developer's repository link:</em> <span><span>https://github.com/cbpark/YAM2</span><svg><path></path></svg></span></div><div><em>Licensing provisions:</em> BSD 3-clause</div><div><em>Programming language:</em> C++</div><div><em>Journal reference of previous version:</em> Comput. Phys. Commun. 264 (2021) 107967</div><div><em>Does the new version supersede the previous version?:</em> Yes</div><div><em>Reasons for the new version:</em> YAM2 2.0 incorporates recent theoretical advances in <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> variables, including on-shell mass and vertex-reconstruction constraints, to ensure consistency with the latest developments in the field. In parallel, user-driven improvements such as CMake support, example codes, ROOT integration, and performance optimizations enhance usability and portability. These updates make the package both more powerful and easier to use for collider analyses at hadron and lepton colliders.</div><div><em>Summary of revisions:</em> One of the main enhancements in the present version is the incorporation of additional kinematic constraints into the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> variables: on-shell mass conditions implemented as equality constraints and vertex-reconstruction information realized as inequality constraints. The on-shell mass condition is particularly relevant for handling the so-called antler decay topology, where a parent particle <em>Y</em> decays via <span><math><mi>Y</mi><mo>→</mo><msub><mrow><mi>A</mi></mrow><mrow><mn>1</mn></mrow></msub><mo>+</mo><msub><mrow><mi>A</mi></mrow><mrow><mn>2</mn></mrow></msub><mo>→</mo><msub><mrow><mi>a</mi></mrow><mrow><mn>1</mn></mrow></msub><msub><mrow><mi>B</mi></mrow><mrow><mn>1</mn></mrow></msub><mo>+</mo><msub><mrow><mi>a</mi></mrow><mrow><mn>2</mn></mrow></msub><msub><mrow><mi>B</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span>. In this decay topology, <em>Y</em> is an on-shell resonance, <span><math><msub><mrow><mi>A</mi></mrow><mrow><mi>i</mi></mrow></msub></math></span> are intermediate states, <span><math><msub><mrow><mi>a</mi></mrow><mrow><mi>i</mi></mrow></msub></math></span> are visible particles, and <span><math><msub><mrow><mi>B</mi></mrow><mrow><mi>i</mi></mrow></msub></math></span> (<span><math><mi>i</mi><mo>=</mo><mn>1</mn><mo>,</mo><mn>2</mn></math></span>) are invisible particles [1]. This corresponds to the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn><mrow><mi>Cons</mi></mrow></mrow></msub></math></span> variable introduced in Ref. [2], which was proposed as a tool for searching for heavy resonances decaying semi-invisibly at hadron colliders. Since the center-of-mass energy is fixed at lepton colliders such as the Belle experiment at SuperKEKB and at future lepton colliders, the same construction can naturally be applied to pair-production decay topologies in these environments, as discussed in Ref. [3, 4]. In this case, the longitudinal component of the missing momentum must also be taken into account, and this functionality has been fully implemented in the new version.</div><div>Furthermore, recent studies have shown that the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> variables can be extended by incorporating constraints on the parent particles' flight directions, inferred from vertex-reconstruction information [5]. These have been implemented in the new version as inequality constraints and successfully tested.</div><div>Minor improvements to the code base include:<ul><li><span>•</span><span><div>Additional example codes for exploring and testing the basic functionalities.</div></span></li><li><span>•</span><span><div>Support for CMake-based builds, improving portability and integration with external projects.</div></span></li><li><span>•</span><span><div>Instructions for integrating YAM2 into analysis codes based on the ROOT framework [6].</div></span></li><li><span>•</span><span><div>General code cleanup and performance optimizations.</div></span></li></ul> As this version introduces breaking changes, users are advised to update their analysis codes to ensure full compatibility.</div><div><em>Nature of problem:</em> The <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> variables form a family of kinematic observables that generalize the well-known stransverse mass <span><math><msub><mrow><mi>M</mi></mrow><mrow><mi>T</mi><mn>2</mn></mrow></msub></math></span> [7] by incorporating additional kinematic constraints, such as on-shell mass conditions, in events with pair-produced particles decaying semi-invisibly [8]. In contrast to <span><math><msub><mrow><mi>M</mi></mrow><mrow><mi>T</mi><mn>2</mn></mrow></msub></math></span>, which relies solely on transverse kinematics, the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> framework can exploit the full event topology by including longitudinal momentum components when suitable constraints are available. The computation of the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> variables is formulated as a constrained numerical minimization, where the invisible momenta are varied subject to the measured missing transverse momentum and the imposed mass-shell conditions. Consequently, suitable numerical algorithms must be adopted, with attention to both efficiency and computational cost.</div><div><em>Solution method:</em> The calculation of the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> variables is formulated as a constrained minimization problem, where the invisible momenta are treated as free parameters subject to the measured missing transverse momentum and additional kinematic conditions, such as on-shell mass constraints. This requires minimizing an objective function defined by the <span><math><msub><mrow><mi>M</mi></mrow><mrow><mn>2</mn></mrow></msub></math></span> variables while simultaneously satisfying nonlinear equality and inequality constraints. Among available constrained optimization methods, YAM2 employs sequential quadratic programming combined with a derivative-based quasi-Newton algorithm. This approach has proven to be both robust and efficient in locating local minima when derivative information is available, which is essential for large-scale Monte Carlo event analyses [9]. The implementation relies on the publicly available NLopt library [10], which offers a broad collection of optimization routines for nonlinear problems. In the current version of YAM2, the set of available algorithms has been extended to include alternative methods, such as the augmented Lagrangian approach, thereby giving users greater flexibility to balance numerical stability, accuracy, and computational cost according to the needs of their analysis.</div></div><div><h3>References</h3><div><ul><li><span> <!-->[1]</span><span><div>T. Han, I.W. Kim, J. Song, Phys. Lett. B 693 (2010) 575–579, <span><span>arXiv:0906.5009 [hep-ph]</span><svg><path></path></svg></span>.</div></span></li><li><span> <!-->[2]</span><span><div>P. Konar, A.K. Swain, Phys. Rev. D 93 (1) (2016) 015021, <span><span>arXiv:1509.00298 [hep-ph]</span><svg><path></path></svg></span>.</div></span></li><li><span> <!-->[3]</span><span><div>D. Guadagnoli, C.B. Park, F. Tenchini, Phys. Lett. B 822 (2021) 136701, <span><span>arXiv:2106.16236 [hep-ph]</span><svg><path></path></svg></span>.</div></span></li><li><span> <!-->[4]</span><span><div>C.B. Park, New Phys. Sae Mulli 73 (8) (2023) 664–674.</div></span></li><li><span> <!-->[5]</span><span><div>G. de Marino, D. Guadagnoli, C.B. Park, K. Trabelsi, Phys. Rev. D 107 (5) (2023) 055010, <span><span>arXiv:2209.03387 [hep-ph]</span><svg><path></path></svg></span>.</div></span></li><li><span> <!-->[6]</span><span><div>R. Brun, F. Rademakers, Nucl. Instrum. Methods. A 389 (1–2) (1997) 81–86.</div></span></li><li><span> <!-->[7]</span><span><div>C.G. Lester, D.J. Summers, Phys. Lett. B 463 (1999) 99–103, <span><span>arXiv:hep-ph/9906349 [hep-ph]</span><svg><path></path></svg></span>.</div></span></li><li><span> <!-->[8]</span><span><div>W.S. Cho, J.S. Gainer, D. Kim, K.T. Matchev, F. Moortgat, L. Pape, M. Park, J. High Energy Phys. 08 (2014) 070, <span><span>arXiv:1401.1449 [hep-ph]</span><svg><path></path></svg></span>.</div></span></li><li><span> <!-->[9]</span><span><div>C.B. Park, Comput. Phys. Commun. 264 (2021) 107967, <span><span>arXiv:2007.15537 [hep-ph]</span><svg><path></path></svg></span>.</div></span></li><li><span>[10]</span><span><div>S.G. Johnson, The NLopt nonlinear-optimization package, <span><span>https://github.com/stevengj/nlopt</span><svg><path></path></svg></span>.</div></span></li></ul></div></div>","PeriodicalId":285,"journal":{"name":"Computer Physics Communications","volume":"317 ","pages":"Article 109835"},"PeriodicalIF":3.4000,"publicationDate":"2025-09-05","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"0","resultStr":null,"platform":"Semanticscholar","paperid":null,"PeriodicalName":"Computer Physics Communications","FirstCategoryId":"101","ListUrlMain":"https://www.sciencedirect.com/science/article/pii/S0010465525003376","RegionNum":2,"RegionCategory":"物理与天体物理","ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"Q1","JCRName":"COMPUTER SCIENCE, INTERDISCIPLINARY APPLICATIONS","Score":null,"Total":0}
引用次数: 0
Abstract
We present a new version of YAM2 (“Yet Another calculator”), a C++ library for computing the class of kinematic variables widely used in collider phenomenology with invisible particles. The main upgrade is the incorporation of new kinematic constraints: on-shell mass conditions implemented as equality constraints and vertex-reconstruction information as inequality constraints. The former enables precise treatment of the antler decay topology and generalizations such as -like variables, while the latter extends applicability to cases where parent-particle flight directions can be inferred. Both extensions are implemented and validated within the sequential quadratic programming framework, ensuring robust performance in large-scale Monte Carlo studies. Additional improvements include CMake build support, extended example codes, and general code optimizations. With these updates, YAM2 2.0 provides a more versatile and user-friendly toolkit for collider analyses at both hadron and lepton colliders.
New version program summary
Program Title: YAM2
CPC Library link to program files:https://doi.org/10.17632/4g7wfd5fpb.2
Does the new version supersede the previous version?: Yes
Reasons for the new version: YAM2 2.0 incorporates recent theoretical advances in variables, including on-shell mass and vertex-reconstruction constraints, to ensure consistency with the latest developments in the field. In parallel, user-driven improvements such as CMake support, example codes, ROOT integration, and performance optimizations enhance usability and portability. These updates make the package both more powerful and easier to use for collider analyses at hadron and lepton colliders.
Summary of revisions: One of the main enhancements in the present version is the incorporation of additional kinematic constraints into the variables: on-shell mass conditions implemented as equality constraints and vertex-reconstruction information realized as inequality constraints. The on-shell mass condition is particularly relevant for handling the so-called antler decay topology, where a parent particle Y decays via . In this decay topology, Y is an on-shell resonance, are intermediate states, are visible particles, and () are invisible particles [1]. This corresponds to the variable introduced in Ref. [2], which was proposed as a tool for searching for heavy resonances decaying semi-invisibly at hadron colliders. Since the center-of-mass energy is fixed at lepton colliders such as the Belle experiment at SuperKEKB and at future lepton colliders, the same construction can naturally be applied to pair-production decay topologies in these environments, as discussed in Ref. [3, 4]. In this case, the longitudinal component of the missing momentum must also be taken into account, and this functionality has been fully implemented in the new version.
Furthermore, recent studies have shown that the variables can be extended by incorporating constraints on the parent particles' flight directions, inferred from vertex-reconstruction information [5]. These have been implemented in the new version as inequality constraints and successfully tested.
Minor improvements to the code base include:
•
Additional example codes for exploring and testing the basic functionalities.
•
Support for CMake-based builds, improving portability and integration with external projects.
•
Instructions for integrating YAM2 into analysis codes based on the ROOT framework [6].
•
General code cleanup and performance optimizations.
As this version introduces breaking changes, users are advised to update their analysis codes to ensure full compatibility.
Nature of problem: The variables form a family of kinematic observables that generalize the well-known stransverse mass [7] by incorporating additional kinematic constraints, such as on-shell mass conditions, in events with pair-produced particles decaying semi-invisibly [8]. In contrast to , which relies solely on transverse kinematics, the framework can exploit the full event topology by including longitudinal momentum components when suitable constraints are available. The computation of the variables is formulated as a constrained numerical minimization, where the invisible momenta are varied subject to the measured missing transverse momentum and the imposed mass-shell conditions. Consequently, suitable numerical algorithms must be adopted, with attention to both efficiency and computational cost.
Solution method: The calculation of the variables is formulated as a constrained minimization problem, where the invisible momenta are treated as free parameters subject to the measured missing transverse momentum and additional kinematic conditions, such as on-shell mass constraints. This requires minimizing an objective function defined by the variables while simultaneously satisfying nonlinear equality and inequality constraints. Among available constrained optimization methods, YAM2 employs sequential quadratic programming combined with a derivative-based quasi-Newton algorithm. This approach has proven to be both robust and efficient in locating local minima when derivative information is available, which is essential for large-scale Monte Carlo event analyses [9]. The implementation relies on the publicly available NLopt library [10], which offers a broad collection of optimization routines for nonlinear problems. In the current version of YAM2, the set of available algorithms has been extended to include alternative methods, such as the augmented Lagrangian approach, thereby giving users greater flexibility to balance numerical stability, accuracy, and computational cost according to the needs of their analysis.
References
[1]
T. Han, I.W. Kim, J. Song, Phys. Lett. B 693 (2010) 575–579, arXiv:0906.5009 [hep-ph].
[2]
P. Konar, A.K. Swain, Phys. Rev. D 93 (1) (2016) 015021, arXiv:1509.00298 [hep-ph].
[3]
D. Guadagnoli, C.B. Park, F. Tenchini, Phys. Lett. B 822 (2021) 136701, arXiv:2106.16236 [hep-ph].
[4]
C.B. Park, New Phys. Sae Mulli 73 (8) (2023) 664–674.
[5]
G. de Marino, D. Guadagnoli, C.B. Park, K. Trabelsi, Phys. Rev. D 107 (5) (2023) 055010, arXiv:2209.03387 [hep-ph].
[6]
R. Brun, F. Rademakers, Nucl. Instrum. Methods. A 389 (1–2) (1997) 81–86.
[7]
C.G. Lester, D.J. Summers, Phys. Lett. B 463 (1999) 99–103, arXiv:hep-ph/9906349 [hep-ph].
[8]
W.S. Cho, J.S. Gainer, D. Kim, K.T. Matchev, F. Moortgat, L. Pape, M. Park, J. High Energy Phys. 08 (2014) 070, arXiv:1401.1449 [hep-ph].
[9]
C.B. Park, Comput. Phys. Commun. 264 (2021) 107967, arXiv:2007.15537 [hep-ph].
[10]
S.G. Johnson, The NLopt nonlinear-optimization package, https://github.com/stevengj/nlopt.
期刊介绍:
The focus of CPC is on contemporary computational methods and techniques and their implementation, the effectiveness of which will normally be evidenced by the author(s) within the context of a substantive problem in physics. Within this setting CPC publishes two types of paper.
Computer Programs in Physics (CPiP)
These papers describe significant computer programs to be archived in the CPC Program Library which is held in the Mendeley Data repository. The submitted software must be covered by an approved open source licence. Papers and associated computer programs that address a problem of contemporary interest in physics that cannot be solved by current software are particularly encouraged.
Computational Physics Papers (CP)
These are research papers in, but are not limited to, the following themes across computational physics and related disciplines.
mathematical and numerical methods and algorithms;
computational models including those associated with the design, control and analysis of experiments; and
algebraic computation.
Each will normally include software implementation and performance details. The software implementation should, ideally, be available via GitHub, Zenodo or an institutional repository.In addition, research papers on the impact of advanced computer architecture and special purpose computers on computing in the physical sciences and software topics related to, and of importance in, the physical sciences may be considered.