ATLAS Offline Software
Loading...
Searching...
No Matches
columnar::ColumnarModeArray Struct Reference

the array mode More...

#include <ColumnarDef.h>

Collaboration diagram for columnar::ColumnarModeArray:

Public Types

using LinkKeyColumnType = SG::sgkey_t
 The type used for the link-key column.
using LinkIndexColumnType = std::uint32_t
 The type used for the link-index column.

Static Public Attributes

static constexpr bool isColumnarMode = true
 Whather this is a columnar mode.
static constexpr bool isXAOD = false
 Whether this is the xAOD mode.
static constexpr bool isArrayMode = true
 Whether this is an array mode.
static constexpr bool useNestedVectors = false
 Whether we use nested vectors for std::vector<...> columns.
static constexpr bool useOffsetMaps = true
 Whether we use offset maps for std::vector<...> and std::string columns, i.e.
static constexpr bool useKeyIndexAsLink = true
 Whether element links are represented as a key column and an index column, with the index being relative to the start of the event, not the column.
static constexpr bool isUprootMode = true
 Whether this is the mode used for uproot/awkward-style inputs.
static constexpr bool inPlaceReplace = false
 Whether for this columnar mode decorators that replace the original column will also refer to the input column.
static constexpr std::string_view eventIndexColumnName = "eventIndex"
 The name of the column used for the event-index-per-entry column.
static constexpr std::string_view linkKeyColumnName = "m_persKey"
 The name/suffix of the column used for the link-key column.
static constexpr std::string_view linkIndexColumnName = "m_persIndex"
 The name/suffix of the column used for the link-index column.
static constexpr LinkKeyColumnType nullLinkKey = 0
 The key used for writing null links.
static constexpr LinkIndexColumnType nullLinkIndex = static_cast<LinkIndexColumnType>(-1)
 The index used for writing null links.
static constexpr bool skipLinkValidation = false
 Whether to skip validation checks on link columns that are not strictly needed, e.g.

Detailed Description

the array mode

Links are read as the key and index columns found in the file.

Definition at line 63 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

Member Typedef Documentation

◆ LinkIndexColumnType

The type used for the link-index column.

Definition at line 125 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ LinkKeyColumnType

The type used for the link-key column.

Definition at line 122 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

Member Data Documentation

◆ eventIndexColumnName

std::string_view columnar::ColumnarModeArray::eventIndexColumnName = "eventIndex"
staticconstexpr

The name of the column used for the event-index-per-entry column.

Element Link Definition

Links are represented by a key column and an index column, as found in the input file. The key is the StoreGate key of the target container, and the index is relative to the start of the event in the target container. To turn them into an object the link accessors also read the event-index column for the offset map of the link column and the offset maps of all the targets.

Definition at line 113 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ inPlaceReplace

bool columnar::ColumnarModeArray::inPlaceReplace = false
staticconstexpr

Whether for this columnar mode decorators that replace the original column will also refer to the input column.

This is very obscure, but can be queried if it avoids copying over the input column in the tool first.

Definition at line 99 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ isArrayMode

bool columnar::ColumnarModeArray::isArrayMode = true
staticconstexpr

Whether this is an array mode.

Definition at line 72 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ isColumnarMode

bool columnar::ColumnarModeArray::isColumnarMode = true
staticconstexpr

Whather this is a columnar mode.

Definition at line 66 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ isUprootMode

bool columnar::ColumnarModeArray::isUprootMode = true
staticconstexpr

Whether this is the mode used for uproot/awkward-style inputs.

This is a catch-all flag for code that has no more specific flag to rely on. It makes no promises beyond being the mode used with uproot.

Definition at line 92 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ isXAOD

bool columnar::ColumnarModeArray::isXAOD = false
staticconstexpr

Whether this is the xAOD mode.

Definition at line 69 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ linkIndexColumnName

std::string_view columnar::ColumnarModeArray::linkIndexColumnName = "m_persIndex"
staticconstexpr

The name/suffix of the column used for the link-index column.

Definition at line 119 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ linkKeyColumnName

std::string_view columnar::ColumnarModeArray::linkKeyColumnName = "m_persKey"
staticconstexpr

The name/suffix of the column used for the link-key column.

Definition at line 116 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ nullLinkIndex

LinkIndexColumnType columnar::ColumnarModeArray::nullLinkIndex = static_cast<LinkIndexColumnType>(-1)
staticconstexpr

The index used for writing null links.

On reading a link is null if either its key or its index matches the null value.

Definition at line 133 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ nullLinkKey

LinkKeyColumnType columnar::ColumnarModeArray::nullLinkKey = 0
staticconstexpr

The key used for writing null links.

On reading a link is null if either its key or its index matches the null value.

Definition at line 129 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ skipLinkValidation

bool columnar::ColumnarModeArray::skipLinkValidation = false
staticconstexpr

Whether to skip validation checks on link columns that are not strictly needed, e.g.

whether the sgkey is valid for a single target link, or whether the index is less than the number of objects in the target container.

Definition at line 139 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ useKeyIndexAsLink

bool columnar::ColumnarModeArray::useKeyIndexAsLink = true
staticconstexpr

Whether element links are represented as a key column and an index column, with the index being relative to the start of the event, not the column.

This is the layout as found on disk for xAODs.

Definition at line 85 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ useNestedVectors

bool columnar::ColumnarModeArray::useNestedVectors = false
staticconstexpr

Whether we use nested vectors for std::vector<...> columns.

Definition at line 75 of file ColumnarCore/ColumnarCore/ColumnarDef.h.

◆ useOffsetMaps

bool columnar::ColumnarModeArray::useOffsetMaps = true
staticconstexpr

Whether we use offset maps for std::vector<...> and std::string columns, i.e.

an offset column together with a flat data column

Definition at line 79 of file ColumnarCore/ColumnarCore/ColumnarDef.h.


The documentation for this struct was generated from the following file: