kernel_types.hpp

Go to the documentation of this file.

/*
 * PoPS model - disperal kernel types
 *
 * Copyright (C) 2015-2020 by the authors.
 *
 * Authors: Vaclav Petras (wenzeslaus gmail com)
 *          Chris Jones (cjones1688 gmail com)
 *          Anna Petrasova (kratochanna gmail com)
 *          Zexi Chen (zchen22 ncsu edu)
 *
 * 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_KERNEL_TYPES_HPP
#define POPS_KERNEL_TYPES_HPP
 
#include <string>
#include <stdexcept>
 
namespace pops {
 
enum class DispersalKernelType
{
    Cauchy,  
    Exponential,  
    Uniform,  
    DeterministicNeighbor,  
    PowerLaw,  
    HyperbolicSecant,  
    Gamma,  
    ExponentialPower,  
    Weibull,  
    Normal,  
    LogNormal,  
    Logistic,  
    Network,  
    None,  
};
 
inline DispersalKernelType kernel_type_from_string(const std::string& text)
{
    if (text == "cauchy" || text == "Cauchy")
        return DispersalKernelType::Cauchy;
    else if (text == "exponential" || text == "Exponential")
        return DispersalKernelType::Exponential;
    else if (text == "uniform" || text == "Uniform")
        return DispersalKernelType::Uniform;
    else if (
        text == "deterministic neighbor" || text == "deterministic-neighbor"
        || text == "Deterministic-neighbor" || text == "Deterministic-Neighbor"
        || text == "Deterministic neighbor" || text == "Deterministic Neighbor")
        return DispersalKernelType::DeterministicNeighbor;
    else if (
        text == "power law" || text == "power-law" || text == "Power-law"
        || text == "Power-Law" || text == "Power Law" || text == "Power law")
        return DispersalKernelType::PowerLaw;
    else if (
        text == "hyperbolic secant" || text == "hyperbolic-secant"
        || text == "Hyperbolic-secant" || text == "Hyperbolic-Secant"
        || text == "Hyperbolic secant" || text == "Hyperbolic Secant")
        return DispersalKernelType::HyperbolicSecant;
    else if (text == "gamma" || text == "Gamma")
        return DispersalKernelType::Gamma;
    else if (
        text == "exponential power" || text == "exponential-power"
        || text == "Exponential-power" || text == "Exponential-Power"
        || text == "Exponential power" || text == "Exponential Power")
        return DispersalKernelType::ExponentialPower;
    else if (text == "weibull" || text == "Weibull")
        return DispersalKernelType::Weibull;
    else if (text == "normal" || text == "Normal")
        return DispersalKernelType::Normal;
    else if (
        text == "log normal" || text == "log-normal" || text == "Log-normal"
        || text == "Log-Normal" || text == "Log normal" || text == "Log Normal")
        return DispersalKernelType::LogNormal;
    else if (text == "logistic" || text == "Logistic")
        return DispersalKernelType::Logistic;
    else if (text == "network" || text == "Network")
        return DispersalKernelType::Network;
    else if (text == "none" || text == "None" || text == "NONE" || text.empty())
        return DispersalKernelType::None;
    else
        throw std::invalid_argument(
            "kernel_type_from_string: Invalid"
            " value '"
            + text + "' provided");
}
 
inline DispersalKernelType kernel_type_from_string(const char* text)
{
    // call the string version
    return kernel_type_from_string(text ? std::string(text) : std::string());
}
 
}  // namespace pops
 
#endif  // POPS_KERNEL_TYPES_HPP