YODA::ZBinMixin< Derived, EdgeT > Struct Template Reference

CRTP mixin introducing convenience aliases along Z axis. More...

#include <BinUtils.h>

Public Member Functions
Bin-interval properties
template<typename T = EdgeT>
enable_if_CAxisT< T >	zMax () const noexcept
	Upper bin edge along Z axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	zMin () const noexcept
	Lower bin edge along Z axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	zMid () const noexcept
	Bin centre along Z axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	zWidth () const noexcept
	Bin width along Z axis.
template<typename T = EdgeT>
enable_if_DAxisT< T >	zEdge () const noexcept
	Bin edge along Z axis.

Detailed Description

template<class Derived, typename EdgeT = double>
struct YODA::ZBinMixin< Derived, EdgeT >

CRTP mixin introducing convenience aliases along Z axis.

Definition at line 122 of file BinUtils.h.

Member Function Documentation

zEdge()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_DAxisT< T > YODA::ZBinMixin< Derived, EdgeT >::zEdge ( ) const

inlinenoexcept

Bin edge along Z axis.

Note

These are only supported for a discrete axis

Definition at line 161 of file BinUtils.h.

                                               {
      return static_cast<const Derived*>(this)->template edge<2>();
    }

zMax()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::ZBinMixin< Derived, EdgeT >::zMax ( ) const

inlinenoexcept

Upper bin edge along Z axis.

Definition at line 129 of file BinUtils.h.

                                              {
      return static_cast<const Derived*>(this)->template max<2>();
    }

zMid()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::ZBinMixin< Derived, EdgeT >::zMid ( ) const

inlinenoexcept

Bin centre along Z axis.

Note

These are only supported for a continuous axis

Definition at line 145 of file BinUtils.h.

                                              {
      return static_cast<const Derived*>(this)->template mid<2>();
    }

zMin()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::ZBinMixin< Derived, EdgeT >::zMin ( ) const

inlinenoexcept

Lower bin edge along Z axis.

Note

These are only supported for a continuous axis

Definition at line 137 of file BinUtils.h.

                                              {
      return static_cast<const Derived*>(this)->template min<2>();
    }

zWidth()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::ZBinMixin< Derived, EdgeT >::zWidth ( ) const

inlinenoexcept

Bin width along Z axis.

Note

These are only supported for a continuous axis

Definition at line 153 of file BinUtils.h.

                                                {
      return static_cast<const Derived*>(this)->template width<2>();
    }

---

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

• include/YODA/Utils/BinUtils.h