Utilities/detail/AxisFwd.hpp

0001 // This file is part of the Acts project.
0002 //
0003 // Copyright (C) 2019 CERN for the benefit of the Acts project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 namespace Acts::detail {
0012 /// Enum which determines how the axis handle its outer boundaries
0013 /// possible values values
0014 /// - Open is the default behaviour: out of bounds
0015 /// positions are filled into the over or underflow bins
0016 /// - Bound: out-of-bounds positions resolve to first/last bin
0017 /// respectively
0018 /// - Closed: out-of-bounds positions resolve to the outermost
0019 /// bin on the opposite side
0020 enum class AxisBoundaryType { Open, Bound, Closed };
0021
0022 /// Enum which determines the binning type of the axis
0023 enum class AxisType { Equidistant, Variable };
0024
0025 /// @brief calculate bin indices from a given binning structure
0026 ///
0027 /// This class provides some basic functionality for calculating bin indices
0028 /// for a given binning configuration. Both equidistant as well as variable
0029 /// binning structures are supported.
0030 ///
0031 /// Bin intervals are defined such that the lower bound is closed and the
0032 /// upper bound is open.
0033 ///
0034 /// @tparam equidistant flag whether binning is equidistant (@c true)
0035 ///                     or not (@c false)
0036 template <AxisType type, AxisBoundaryType bdt = AxisBoundaryType::Open>
0037 class Axis;
0038
0039 using EquidistantAxis = Axis<AxisType::Equidistant>;
0040 using VariableAxis = Axis<AxisType::Variable>;
0041
0042 }  // namespace Acts::detail