Crate pineappl

PineAPPL is not an extension of APPLgrid.

Overview

The main type of this crate is Grid, which represents the interpolation grids that PineAPPL implements. Roughly speaking, a Grid is a three-dimensional array of Subgrid objects together with metadata. The three dimensions are

1. bins, whose limits can be accessed by Grid::bwfl(), and
2. (perturbative) orders, represented by the type Order and accessible by Grid::orders(),
3. channels, whose definition is returned by Grid::channels().

Subgrid is a trait and objects that implement it are of the type SubgridEnum. The latter is an enum of different types that are optimized to different scenarios: fast event filling, small storage profile, etc.

Metadata

Metadata is a collection of key–value pairs, in which both keys and values are String objects. In metadata anything a user whishes can be stored. However, there are special keys, which have meaning to PineAPPL and/or its CLI pineappl. This metadata enables the CLI to automatically generate plots that are correctly labeled, for instance. For more applications see also the CLI tutorial.

Modules

boc

Module containing structures for the 3 dimensions of a Grid: Bin, Order and channels (boc).

convolutions

Module for everything related to convolution functions.

error

TODO

evolution

Supporting classes and functions for Grid::evolve.

fk_table

Provides the FkTable type.

grid

Module containing all traits and supporting structures for grids.

interpolation

Interpolation module.

packed_array

Provides the PackedArray struct.

pids

TODO

reference

TODO

subgrid

Module containing the trait Subgrid and supporting structs.

Macros

channel

Helper macro to quickly generate a Channel at compile time.