src/DiffEq/WrightFisher/WrightFisherCoeffPolicy.hpp file

Wright-Fisher coefficients policies.

Contents

This file defines coefficients policy classes for the Wright-Fisher SDE, defined in DiffEq/WrightFisher.h.

General requirements on the Wright-Fisher SDE coefficients policy classes:

  • Must define a constructor, which is used to initialize the SDE coefficient vector, omega. Required signature:

    CoeffPolicyName(
      tk::ctr::ncomp_type ncomp,
      const std::vector< kw::sde_omega::info::expect::type >& omega_,
      std::vector< kw::sde_omega::info::expect::type >& omega )

    where

    • ncomp denotes the number of scalar components of the system of the Wright-Fisher SDE.
    • Constant references to omega_ which denote a vector of real values used to initialize the parameter vector of the Wright-Fisher SDE. The length of the vector must be equal to the number of components given by ncomp.
    • Reference to omega which denote the parameter vector to be initialized based on omega_.
  • Must define the static function type(), returning the enum value of the policy option. Example:

    static ctr::CoeffPolicyType type() noexcept {
      return ctr::CoeffPolicyType::CONST_COEFF;
    }

    which returns the enum value of the option from the underlying option class, collecting all possible options for coefficients policies.

Namespaces

namespace walker
Walker declarations and definitions.

Classes

class walker::WrightFisherCoeffConst
Wright-Fisher constant coefficients policity: constants in time.