Dirichlet.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#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 */