.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation .. .. SPDX-License-Identifier: CC-BY-4.0 .. _onemkl_rng_multinomial: multinomial =========== Class is used for generation of multinomially distributed integer types random numbers. .. _onemkl_rng_multinomial_description: .. rubric:: Description The class object is used in the :ref:oneapi::mkl::rng::generate() function to provide n random numbers multinomially distributed, with independent trials :math:(ntrial, m) and possible mutually exclusive outcomes :math:k, with corresponding probabilities :math:p_i, where :math:p_i \in R; 0 \leq p_i \leq 1; m, k \in N. The probability distribution is given by: .. math:: P(X_1 = x_1, ..., X_k = x_k) = \frac{m!}{\Pi^k_{i = 1}x_i!}\Pi^k_{i = 1}p_i^{x_i}, 0 \leq x_i \leq m, \sum^{k}_{i = 1}x_i = m .. _onemkl_rng_multinomial_syntax: class multinomial ----------------- .. rubric:: Syntax .. code-block:: cpp namespace oneapi::mkl::rng { template class multinomial { public: using method_type = Method; using result_type = IntType; explicit multinomial(double ntrial, std::vector p); std::int32_t ntrial() const; std::vector p() const; }; } .. container:: section .. rubric:: Template parameters .. container:: section typename IntType Type of the produced values. Supported types: * std::int32_t * std::uint32_t .. container:: section typename Method = oneapi::mkl::rng::multinomial_method::by_default Transformation method, which will be used for generation. Supported types: * oneapi::mkl::rng::multinomial_method::by_default * oneapi::mkl::rng::multinomial_method::poisson_icdf_based See description of the methods in :ref:Distributions methods template parameter. .. container:: section .. rubric:: Class Members .. list-table:: :header-rows: 1 * - Routine - Description * - explicit multinomial(double ntrial, std::vector p)_ - Constructor with parameters * - std::int32_t ntrial() const_ - Method to obtain number of independent trials * - std::vector p() const_ - Method to obtain probability vector of possible outcomes .. container:: section .. rubric:: Member types .. container:: section .. code-block:: cpp multinomial::method_type = Method .. container:: section .. rubric:: Description The type which defines the transformation method for generation. .. container:: section .. code-block:: cpp multinomial::result_type = IntType .. container:: section .. rubric:: Description The type which defines the type of generated random numbers. .. container:: section .. rubric:: Constructors .. container:: section .. _explicit multinomial(double ntrial, std::vector p): .. code-block:: cpp explicit multinomial::multinomial(double ntrial, std::vector p) .. container:: section .. rubric:: Description Constructor with parameters. ntrial is a number of independent trials, p is a probability vector. .. container:: section .. rubric:: Throws oneapi::mkl::invalid_argument Exception is thrown when :math:ntrial < 0, or :math:p.size() < 1 .. container:: section .. rubric:: Characteristics .. container:: section .. _std::int32_t ntrial() const: .. code-block:: cpp std::int32_t multinomial::ntrial() const .. container:: section .. rubric:: Return Value Returns the distribution parameter ntrial. .. container:: section .. _std::vector p() const: .. code-block:: cpp std::vector multinomial::p() const .. container:: section .. rubric:: Return Value Returns the distribution parameter p. **Parent topic:** :ref:onemkl_rng_distributions