MatrixElementApi¶

class madspace.MatrixElementApi¶

Bases: pybind11_object

Loaded UMAMI shared library for one matrix element.

UMAMI (Unified MAtrix eleMent Interface) is madspace’s uniform way of calling matrix-element code, currently the cudacpp plugin [1]; see MatrixElement for the compute-graph function built on top of it. A MatrixElementApi dynamically loads the library, resolves its exported UMAMI entry points, and exposes the metadata queries and the raw call. Obtained from Context::load_matrix_element, or from Context::add_matrix_element for entry points given as UmamiFunctions, never constructed directly.

References

[1] S. Hageböck et al., “Data-parallel leading-order event generation in MadGraph5_aMC@NLO”, https://arxiv.org/abs/2507.21039

device_type(self: madspace._madspace_py.MatrixElementApi) → str¶: Device the library was built for: cpu, cuda or hip.

diagram_count(self: madspace._madspace_py.MatrixElementApi) → int¶: Number of Feynman diagrams.

helicity_count(self: madspace._madspace_py.MatrixElementApi) → int¶: Number of helicity configurations.

index(self: madspace._madspace_py.MatrixElementApi) → int¶: Index of this matrix element in its Context, in load order.

particle_count(self: madspace._madspace_py.MatrixElementApi) → int¶: Number of external particles.