vose.h

Go to the documentation of this file.

/*
 *  vose.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST 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.
 *
 *  NEST 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 NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef VOSE_H
#define VOSE_H

#include <vector>

#include "nest.h"
#include "randomgen.h"

namespace nest
{

  class Vose {
    struct BiasedCoin {
      index heads, tails;
      double_t probability; 
      BiasedCoin() : heads(0), tails(0), probability(0) {};
      BiasedCoin(index h, index t, double_t p) : heads(h), tails(t), probability(p) {};
    };

  public:
    Vose(std::vector<double_t> dist);

    index get_random_id(librandom::RngPtr rng) const;

  private:
    std::vector<BiasedCoin> dist_;

  };


} // namespace nest

#endif