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

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

#include <BinUtils.h>

Public Member Functions
Bin-interval properties
template<typename T = EdgeT>
enable_if_CAxisT< T >	xMax () const noexcept
	Upper bin edge along X axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	xMin () const noexcept
	Lower bin edge along X axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	xMid () const noexcept
	Bin centre along X axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	xWidth () const noexcept
	Bin width along X axis.
template<typename T = EdgeT>
enable_if_DAxisT< T >	xEdge () const noexcept
	Bin edge along X axis.

Detailed Description

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

CRTP mixin introducing convenience aliases along X axis.

Definition at line 18 of file BinUtils.h.

Member Function Documentation

xEdge()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_DAxisT< T > YODA::XBinMixin< Derived, EdgeT >::xEdge ( ) const

inlinenoexcept

Bin edge along X axis.

Note

These are only supported for a discrete axis

Definition at line 59 of file BinUtils.h.

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

xMax()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::XBinMixin< Derived, EdgeT >::xMax ( ) const

inlinenoexcept

Upper bin edge along X axis.

Note

These are only supported for a continuous axis

Definition at line 27 of file BinUtils.h.

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

xMid()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::XBinMixin< Derived, EdgeT >::xMid ( ) const

inlinenoexcept

Bin centre along X axis.

Note

These are only supported for a continuous axis

Definition at line 43 of file BinUtils.h.

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

xMin()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::XBinMixin< Derived, EdgeT >::xMin ( ) const

inlinenoexcept

Lower bin edge along X axis.

Note

These are only supported for a continuous axis

Definition at line 35 of file BinUtils.h.

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

xWidth()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::XBinMixin< Derived, EdgeT >::xWidth ( ) const

inlinenoexcept

Bin width along X axis.

Note

These are only supported for a continuous axis

Definition at line 51 of file BinUtils.h.

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

---

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

• include/YODA/Utils/BinUtils.h