JFlux.hh

Go to the documentation of this file.

#ifndef __JAANET__JFLUX__
#define __JAANET__JFLUX__

#include "JAAnet/JEvtWeightFactor.hh"
#include "JAAnet/JEvtWeightFactorHelper.hh"
#include "JAAnet/JEvtWeightFactorFunction.hh"
#include "JAAnet/JEvtWeightFactorMultiParticle.hh"

/**
 * \author bjung
 */

namespace JAANET {

  /**
   * Alias for flux function interface.
   */
  using JFlux = JEvtWeightFactor;

  /**
   * Alias for flux function interface helper.
   */
  using JFluxHelper = JEvtWeightFactorHelper;

  /**
   * Alias for pointer to flux function. 
   */
  using pFlux = pEvtWeightFactor;

  /**
   * Alias for implementation of flux function interface for functors.
   */
  template<class JFunction_t>
  using JFluxFunction = JEvtWeightFactorFunction<JFunction_t>;

  /**
   * Alias for implementation of an interface to multiple flux functions.
   */
  using JFluxMultiParticle = JEvtWeightFactorMultiParticle;

  /**
   * Auxiliary method for creating an interface to a flux function.
   *
   * \param  function             function object
   * \return                      event-weight factor interface
   */
  template<class JFunction_t>
  inline JFluxFunction<JFunction_t> make_fluxFunction(const JFunction_t& function) {
    return JFluxFunction<JFunction_t>(function);
  }  

  /**
   * Auxiliary method for creating an interface to a flux function.
   *
   * \param  function             function pointer
   * \return                      event-weight factor interface
   */
  inline JFluxFunction<pFlux> make_fluxFunction(pFlux function) {
    return JFluxFunction<pFlux>(function);
  }
}

#endif