std::binomial_distribution<IntType>::param

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Numerics library

Common mathematical functions

Mathematical special functions (C++17)

Mathematical constants (C++20)

Floating-point environment (C++11)

Complex numbers

Numeric arrays

Pseudo-random number generation

Factor operations

gcd (C++17)

lcm (C++17)

Interpolations

midpoint (C++20)

lerp (C++20)

Generic numeric operations

iota (C++11)

ranges::iota (C++23)

accumulate

inner_product

adjacent_difference

partial_sum

reduce (C++17)

transform_reduce (C++17)

inclusive_scan (C++17)

exclusive_scan (C++17)

transform_inclusive_scan (C++17)

transform_exclusive_scan (C++17)

Bit operations

bit_cast (C++20)

byteswap (C++23)

has_single_bit (C++20)

bit_ceil (C++20)

bit_floor (C++20)

bit_width (C++20)

rotl (C++20)

rotr (C++20)

countl_zero (C++20)

countl_one (C++20)

countr_zero (C++20)

countr_one (C++20)

popcount (C++20)

endian (C++20)

 

Pseudo-random number generation

Uniform random bit generators

uniform_random_bit_generator (C++20)

Engines and engine adaptors

linear_congruential_engine (C++11)

mersenne_twister_engine (C++11)

subtract_with_carry_engine (C++11)

discard_block_engine (C++11)

independent_bits_engine (C++11)

shuffle_order_engine (C++11)

Non-deterministic generator

random_device (C++11)

Distributions

Uniform distributions

uniform_int_distribution (C++11)

uniform_real_distribution (C++11)

generate_canonical (C++11)

Bernoulli distributions

bernoulli_distribution (C++11)

binomial_distribution (C++11)

negative_binomial_distribution (C++11)

geometric_distribution (C++11)

Poisson distributions

poisson_distribution (C++11)

exponential_distribution (C++11)

gamma_distribution (C++11)

weibull_distribution (C++11)

extreme_value_distribution (C++11)

Normal distributions

normal_distribution (C++11)

lognormal_distribution (C++11)

chi_squared_distribution (C++11)

cauchy_distribution (C++11)

fisher_f_distribution (C++11)

student_t_distribution (C++11)

Sampling distributions

discrete_distribution (C++11)

piecewise_constant_distribution (C++11)

piecewise_linear_distribution (C++11)

Seed Sequences

seed_seq (C++11)

C library

rand

srand

RAND_MAX

 

std::binomial_distribution

Member functions

binomial_distribution::binomial_distribution (C++11)

binomial_distribution::reset (C++11)

Generation

binomial_distribution::operator() (C++11)

Characteristics

binomial_distribution::pbinomial_distribution::t (C++11)(C++11)

binomial_distribution::param (C++11)

binomial_distribution::min (C++11)

binomial_distribution::max (C++11)

Non-member functions

operator==operator!= (C++11)(C++11)(until C++20)

operator<<operator>> (C++11)(C++11)

 

param_type param() const;	(1)	(since C++11)
void param( const param_type& params );	(2)	(since C++11)

Manages the associated distribution parameter set.

1) Returns the associated parameter set.

2) Sets the associated parameter set to params.

Parameters

params

-

new contents of the associated parameter set

Return value

1) The associated parameter set.

2) (none)

Complexity

Constant.

Example

Run this code

#include <iostream>
#include <random>
 
int main()
{
    std::random_device rd;
    std::mt19937 gen(rd());
    using BinomialDist = std::binomial_distribution<>;
    BinomialDist bino_dis(1, 0.5);
 
    std::cout << "A sample of Binomial(  1, 0.5): " << bino_dis(gen) << '\n';
 
    // Use another parameter set
    bino_dis.param(BinomialDist::param_type(100,0.9));
    std::cout << "A sample of Binomial(100, 0.9): " << bino_dis(gen) << '\n';
}

Possible output:

A sample of Binomial(  1, 0.5): 0
A sample of Binomial(100, 0.9): 94