multiDimLogit.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {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_MULTI_DIM_LOGIT_H
#define GUM_MULTI_DIM_LOGIT_H

#include <agrum/multidim/ICIModels/multiDimICIModel.h>

namespace gum {

  template < typename GUM_SCALAR >
  class MultiDimLogit : public MultiDimICIModel< GUM_SCALAR > {
    public:
    // ============================================================================
    // ============================================================================

    MultiDimLogit(GUM_SCALAR external_weight,
                  GUM_SCALAR default_weight = (GUM_SCALAR)0.0);

    MultiDimLogit(const MultiDimLogit< GUM_SCALAR >& from);

    MultiDimLogit(
       const Bijection< const DiscreteVariable*, const DiscreteVariable* >& bij,
       const MultiDimLogit< GUM_SCALAR >&                                   from);

    virtual ~MultiDimLogit();


    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const;

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

    public:
    virtual GUM_SCALAR get(const Instantiation& i) const;

    const std::string toString() const;

    virtual const std::string& name() const;

  };


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class MultiDimLogit< double >;
#endif

  template < typename GUM_SCALAR >
  std::ostream& operator<<(std::ostream& s, const MultiDimLogit< GUM_SCALAR >& ag);

} /* namespace gum */

#include <agrum/multidim/ICIModels/multiDimLogit_tpl.h>

#endif /* GUM_MULTI_DIM_LOGIT_H */