Dirichlet.h

Go to the documentation of this file.

#ifndef GUM_LEARNING_DIRICHLET_H
#define GUM_LEARNING_DIRICHLET_H

#include <random>
#include <vector>

#include <agrum/agrum.h>
#include <agrum/core/utils_random.h>

namespace gum {

  // =========================================================================
  // ===                          DIRICHLET CLASS                          ===
  // =========================================================================

  class Dirichlet {
    public:
    using param_type = std::vector< float >;

    using result_type = std::vector< float >;

    // ==========================================================================
    // ==========================================================================

    Dirichlet(const param_type& params, unsigned int seed = GUM_RANDOMSEED);

    Dirichlet(const Dirichlet& from);

    Dirichlet(Dirichlet&& from);

    ~Dirichlet();

    // ==========================================================================
    // ==========================================================================

    Dirichlet& operator=(const Dirichlet& from);

    Dirichlet& operator=(Dirichlet&& from);

    result_type operator()();

    result_type operator()(const param_type& p);

    template < class URNG >
    result_type operator()(URNG& generator, const param_type& p);

    // ==========================================================================
    // ==========================================================================

    const param_type& param() const noexcept;

    void param(const param_type& p);

    float min() const noexcept;

    float max() const noexcept;


    private:
    std::default_random_engine __generator;

    std::gamma_distribution< float > __gamma;

    param_type __params;
  };

} /* namespace gum */

// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/core/math/Dirichlet_inl.h>
#endif /* GUM_NO_INLINE */

// always include templates
#include <agrum/core/math/Dirichlet_tpl.h>

#endif /* GUM_LEARNING_DIRICHLET_H */