Struct FkTable

Source

pub struct FkTable { /* private fields */ }

Expand description

Structure implementing FK tables. These are special Grids, for which the following additional guarantees are given:

all subgrids of the grid evaluate the convolution functions at a single factorization and fragmentation scale given by FkTable::fac0 and FkTable::frg0, respectively.
all subgrids share the same x grid. See FkTable::x_grid.
the channel definitions are simple, meaning that every entry consists of a single tuple of partons with trivial factor 1.0, and all tuples are distinct from each other. See Grid::channels.
the FK table’s grid contains only a single Order, whose exponents are all zero.

Implementations§

Source §

impl FkTable

Source

pub const fn grid(&self) -> &Grid

Returns the Grid object for this FkTable.

Source

pub fn into_grid(self) -> Grid

Converts the FkTable back to a Grid.

Source

pub fn table(&self) -> ArrayD<f64>

Return the FK-table represented as an n-dimensional array indexed by bin, channel and parton fractions, in this order.

§Panics

TODO

Source

pub fn channels(&self) -> Vec<Vec<i32>>

Return the channel definition for this FkTable. All factors are 1.0.

Source

pub fn fac0(&self) -> Option<f64>

Return the squared factorization scale.

Source

pub fn frg0(&self) -> Option<f64>

Return the squared fragmentation scale.

Source

pub fn metadata_mut(&mut self) -> &mut BTreeMap<String, String>

Return the metadata of this FK-table.

Source

pub fn x_grid(&self) -> Vec<f64>

Returns the x grid that all subgrids for all hadronic initial states share.

Source

pub fn convolve( &self, convolution_cache: &mut ConvolutionCache<'_>, bin_indices: &[usize], channel_mask: &[bool], ) -> Vec<f64>

Convolve the FK-table. This method has fewer arguments than Grid::convolve, because FK-tables have all orders merged together and do not support scale variations.

Source

pub fn rotate_pid_basis(&mut self, pid_basis: PidBasis)

Rotate the FK Table into the specified basis.

Source

pub fn optimize(&mut self, assumptions: FkAssumptions)

Optimize the size of this FK-table by throwing away heavy quark flavors assumed to be zero at the FK-table’s scales and calling Grid::optimize.

Trait Implementations§

Source §

impl TryFrom<Grid> for FkTable

Source §

type Error = Error

The type returned in the event of a conversion error.

Source §

fn try_from(grid: Grid) -> Result<Self>

Performs the conversion.

Auto Trait Implementations§

§

impl UnwindSafe for FkTable

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §