.. Generated by docs/generate_api_pages.py - do not edit by hand.

Python API
==========

Reference for the classes and free functions exposed by the :mod:`madspace` Python module, one page per class or function.

Phase-space mappings
--------------------

Invertible maps between the unit hypercube and physical phase space; each also returns its Jacobian weight.

.. toctree::
   :maxdepth: 1

   python/ChiliMapping
   python/ColorOrderedMapping
   python/DiscreteFlow
   python/DiscreteSampler
   python/DoubleT
   python/FastRamboMapping
   python/Flow
   python/Invariant
   python/Luminosity
   python/Mapping
   python/MultiChannelMapping
   python/PhaseSpaceMapping
   python/TPropagatorMapping
   python/ThreeBodyDecay
   python/TwoBodyDecay
   python/TwoToThreeParticleScattering
   python/TwoToTwoParticleScattering
   python/VegasMapping

Function generators
-------------------

Builders that assemble compute-graph functions for channel weights, energy scales and network outputs.

.. toctree::
   :maxdepth: 1

   python/BufferUnweighter
   python/CachedPdf
   python/CachedScale
   python/ChannelWeightNetwork
   python/CustomFunction
   python/CutItem
   python/Cuts
   python/DifferentialCrossSection
   python/DiscreteHistogram
   python/EnergyScale
   python/FunctionGenerator
   python/HistItem
   python/Integrand
   python/IntegrandProbability
   python/MLP
   python/MadnisLoss
   python/MatrixElement
   python/MomentumPreprocessing
   python/MultiChannelFunction
   python/MultiChannelIntegrand
   python/Observable
   python/ObservableHistograms
   python/ObservableValues
   python/PartonDensity
   python/PropagatorChannelWeights
   python/RunningCoupling
   python/SubchannelWeights
   python/Unweighter
   python/VegasHistogram

Phase-space building blocks
---------------------------

Supporting types shared by the mappings: topologies, cuts, observables and density grids.

.. toctree::
   :maxdepth: 1

   python/AlphaSGrid
   python/CustomPdf
   python/Decay
   python/Diagram
   python/LineRef
   python/PdfGrid
   python/Propagator
   python/Topology
   python/initialize_vegas_grid

Compute graph
-------------

The typed value model and the builder API used to record and compile functions from instructions.

.. toctree::
   :maxdepth: 1

   python/BatchSize
   python/DataType
   python/Function
   python/FunctionBuilder
   python/FunctionRuntime
   python/Instruction
   python/InstructionCall
   python/Type
   python/Value
   python/batch_float_array
   python/batch_four_vec_array
   python/multichannel_batch_size

Driver and runtime
------------------

The high-level driver plus the tensor and device layer it runs on: integration, unweighting, event output and execution.

.. toctree::
   :maxdepth: 1

   python/AdamOptimizer
   python/ChannelEventGenerator
   python/Context
   python/Device
   python/DiscreteOptimizer
   python/EventGenerator
   python/EventHistogramSpec
   python/EventHistograms
   python/GeneratorConfig
   python/GeneratorStatus
   python/Histogram
   python/LHECompleter
   python/LHEEvent
   python/LHEFileWriter
   python/LHEHeader
   python/LHEMeta
   python/LHEParticle
   python/LHEProcess
   python/Logger
   python/MadnisConfig
   python/MadnisTraining
   python/MatrixElementApi
   python/MixMaxRandom
   python/MultiMadnisTraining
   python/PdfGroupInfo
   python/PdfMemberSpec
   python/PrettyBox
   python/StatusFile
   python/SubprocArgs
   python/SubprocessObservables
   python/SubprocessSystArgs
   python/SystematicsCalculator
   python/SystematicsConfig
   python/Tensor
   python/TrainingArgs
   python/Variation
   python/VegasGridOptimizer
   python/Verbosity
   python/available_backends
   python/compute_generation_batch_event_count
   python/cpu_device
   python/cuda_device
   python/default_context
   python/default_cuda_context
   python/default_hip_context
   python/format_progress
   python/format_si_prefix
   python/format_with_error
   python/hip_device
   python/select_combine_channel_index
   python/set_lib_path
   python/set_simd_vector_size

Utilities
---------

Lower-level helpers and containers.

.. toctree::
   :maxdepth: 1

   python/NamedTypes
   python/NamedValues
   python/PythonFunction
   python/get_stream
   python/set_stream
   python/stream