LArDiscreteProbabilityHelper.h

Go to the documentation of this file.

#ifndef LAR_DISCRETE_PROBABILITY_HELPER_HELPER_H
#define LAR_DISCRETE_PROBABILITY_HELPER_HELPER_H 1

#include "larpandoracontent/LArObjects/LArDiscreteProbabilityVector.h"

#include <algorithm>
#include <random>

namespace lar_content
{

class LArDiscreteProbabilityHelper
{
public:
    template <typename T>
    static float CalculateCorrelationCoefficientPValueFromPermutationTest(
        const T &t1, const T &t2, std::mt19937 &randomNumberGenerator, const unsigned int nPermutations);

    template <typename T>
    static float CalculateCorrelationCoefficientPValueFromStudentTDistribution(
        const T &t1, const T &t2, const unsigned int nIntegrationSteps, const float upperLimit);

    template <typename T>
    static float CalculateCorrelationCoefficient(const T &t1, const T &t2);

    template <typename T>
    static float CalculateMean(const T &t);

private:
    template <typename T>
    static T MakeRandomisedSample(const T &t, std::mt19937 &randomNumberGenerator);

    template <typename T>
    static std::vector<T> MakeRandomisedSample(const std::vector<T> &t, std::mt19937 &randomNumberGenerator);

    template <typename T>
    static unsigned int GetSize(const T &t);

    template <typename T>
    static unsigned int GetSize(const std::vector<T> &t);

    template <typename T>
    static float GetElement(const T &t, const unsigned int index);

    template <typename T>
    static float GetElement(const std::vector<T> &t, const unsigned int index);
};

//------------------------------------------------------------------------------------------------------------------------------------------

template <typename T>
inline std::vector<T> LArDiscreteProbabilityHelper::MakeRandomisedSample(const std::vector<T> &t, std::mt19937 &randomNumberGenerator)
{
    std::vector<T> randomisedVector(t);
    std::shuffle(randomisedVector.begin(), randomisedVector.end(), randomNumberGenerator);

    return randomisedVector;
}

template <>
inline DiscreteProbabilityVector LArDiscreteProbabilityHelper::MakeRandomisedSample(const DiscreteProbabilityVector &t, std::mt19937 &randomNumberGenerator)
{
    return DiscreteProbabilityVector(t, randomNumberGenerator);
}

//------------------------------------------------------------------------------------------------------------------------------------------

template <typename T>
inline unsigned int LArDiscreteProbabilityHelper::GetSize(const std::vector<T> &t)
{
    return t.size();
}

template <>
inline unsigned int LArDiscreteProbabilityHelper::GetSize(const DiscreteProbabilityVector &t)
{
    return t.GetSize();
}

//------------------------------------------------------------------------------------------------------------------------------------------

template <typename T>
inline float LArDiscreteProbabilityHelper::GetElement(const std::vector<T> &t, const unsigned int index)
{
    return static_cast<float>(t.at(index));
}

template <>
inline float LArDiscreteProbabilityHelper::GetElement(const DiscreteProbabilityVector &t, const unsigned int index)
{
    return static_cast<float>(t.GetProbability(index));
}

} // namespace lar_content

#endif // #ifndef LAR_DISCRETE_PROBABILITY_HELPER_H