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

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

#include <BinUtils.h>

Public Member Functions
Bin-interval properties
template<typename T = EdgeT>
enable_if_CAxisT< T >	yMax () const noexcept
	Upper bin edge along Y axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	yMin () const noexcept
	Lower bin edge along Y axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	yMid () const noexcept
	Bin centre along Y axis.
template<typename T = EdgeT>
enable_if_CAxisT< T >	yWidth () const noexcept
	Bin width along Y axis.
template<typename T = EdgeT>
enable_if_DAxisT< T >	yEdge () const noexcept
	Bin edge along Y axis.

Detailed Description

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

CRTP mixin introducing convenience aliases along Y axis.

Definition at line 70 of file BinUtils.h.

Member Function Documentation

yEdge()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_DAxisT< T > YODA::YBinMixin< Derived, EdgeT >::yEdge ( ) const

inlinenoexcept

Bin edge along Y axis.

Note

These are only supported for a discrete axis

Definition at line 111 of file BinUtils.h.

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

yMax()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::YBinMixin< Derived, EdgeT >::yMax ( ) const

inlinenoexcept

Upper bin edge along Y axis.

Note

These are only supported for a continuous axis

Definition at line 79 of file BinUtils.h.

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

yMid()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::YBinMixin< Derived, EdgeT >::yMid ( ) const

inlinenoexcept

Bin centre along Y axis.

Note

These are only supported for a continuous axis

Definition at line 95 of file BinUtils.h.

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

yMin()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::YBinMixin< Derived, EdgeT >::yMin ( ) const

inlinenoexcept

Lower bin edge along Y axis.

Note

These are only supported for a continuous axis

Definition at line 87 of file BinUtils.h.

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

yWidth()

template<class Derived , typename EdgeT = double>

template<typename T = EdgeT>

enable_if_CAxisT< T > YODA::YBinMixin< Derived, EdgeT >::yWidth ( ) const

inlinenoexcept

Bin width along Y axis.

Note

These are only supported for a continuous axis

Definition at line 103 of file BinUtils.h.

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

---

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

• include/YODA/Utils/BinUtils.h