uniform_kernel.hpp

Go to the documentation of this file.

/*
 * PoPS model - random uniform dispersal kernel
 *
 * Copyright (C) 2015-2020 by the authors.
 *
 * Authors: Vaclav Petras (wenzeslaus gmail com)
 *
 * The code contained herein is licensed under the GNU General Public
 * License. You may obtain a copy of the GNU General Public License
 * Version 2 or later at the following locations:
 *
 * http://www.opensource.org/licenses/gpl-license.html
 * http://www.gnu.org/copyleft/gpl.html
 */
 
#ifndef POPS_UNIFORM_KERNEL_HPP
#define POPS_UNIFORM_KERNEL_HPP
 
#include "kernel_types.hpp"
 
#include <random>
 
namespace pops {
 
class UniformDispersalKernel
{
protected:
    int row_max_;
    int col_max_;
    std::uniform_int_distribution<> row_distribution;
    std::uniform_int_distribution<> col_distribution;
 
public:
    UniformDispersalKernel(int row_max, int col_max)
        : row_max_(row_max),
          col_max_(col_max),
          row_distribution(0, row_max),
          col_distribution(0, col_max)
    {}
 
    template<typename Generator>
    std::tuple<int, int> operator()(Generator& generator, int row, int col)
    {
        row = row_distribution(generator);
        col = col_distribution(generator);
 
        return std::make_tuple(row, col);
    }
 
    static bool supports_kernel(const DispersalKernelType type)
    {
        return type == DispersalKernelType::Uniform;
    }
};
 
}  // namespace pops
 
#endif  // POPS_UNIFORM_KERNEL_HPP