C++

Reference

<random>

student_t_distribution

public member function
<random>

std::student_t_distribution::param

(1)
param_type param() const;
(2)
void param (const param_type& parm);
Distribution parameters
The first version (1) returns an object with the parameters currently associated with the distribution object.
The second version (2) associates the parameters in object parm to the distribution object.

A student_t_distribution is defined by a single parameter: n (its degrees of freedom). An object of type param_type carries this information, but it is meant to be used only to construct or specify the parameters for a student_t_distribution object, not to inspect the individual parameters.

To inspect the individual parameter associated to the distribution object you can use: student_t_distribution::n.

Parameters

parm
An object representing the distribution's parameters, obtained by a call to member function param.
param_type is a member type.

Return value

An object representing the distribution's parameters.
param_type is a member type.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
// student_t_distribution::param
#include <iostream>
#include <random>

int main()
{
  std::default_random_engine generator;
  std::student_t_distribution<double> d1(5.0);
  std::student_t_distribution<double> d2(d1.param());

  // print two independent values:
  std::cout << d1(generator) << std::endl;
  std::cout << d2(generator) << std::endl;

  return 0;
}

Possible output:
-0.105551
0.619588


Complexity

No worse than the complexity of param_type's constructor.

See also

student_t_distribution::(constructor)
Construct Student T-distribution (public member function)
student_t_distribution::reset
Reset distribution (public member function)