/usr/include/openturns/swig/SamplerImplementation_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | %define OT_Sampler_doc
"Sampler.
Available constructors:
Sampler(*aSampler*)
Parameters
----------
aSampler : :class:`~openturns.Sampler`
Particular sampler. By default it is a
:class:`~openturns.RandomWalkMetropolisHastings`.
Notes
-----
A Sampler is an object whose fundamental ability is to produce samples
according to a certain distribution.
See also
--------
MCMC, RandomWalkMetropolisHastings
Examples
--------
>>> import openturns as ot
>>> sampler = ot.Sampler()"
%enddef
%feature("docstring") OT::SamplerImplementation
OT_Sampler_doc
// ---------------------------------------------------------------------
%define OT_Sampler_getDimension_doc
"Get the dimension of the samples generated.
Returns
-------
dimension : int
Dimension of the samples that the Sampler can generate."
%enddef
%feature("docstring") OT::SamplerImplementation::getDimension
OT_Sampler_getDimension_doc
// ---------------------------------------------------------------------
%define OT_Sampler_getRealization_doc
"Return a realization.
Returns
-------
realization : :class:`~openturns.NumericalPoint`
A new realization."
%enddef
%feature("docstring") OT::SamplerImplementation::getRealization
OT_Sampler_getRealization_doc
// ---------------------------------------------------------------------
%define OT_Sampler_getSample_doc
"Return several realizations.
Parameters
----------
size : int, :math:`size \\\\leq 0`
Number of realizations needed.
Returns
-------
realizations : :class:`~openturns.NumericalSample`
Sequence composed of *size* new realizations."
%enddef
%feature("docstring") OT::SamplerImplementation::getSample
OT_Sampler_getSample_doc
// ---------------------------------------------------------------------
%define OT_Sampler_getVerbose_doc
"Tell whether the verbose mode is activated or not.
Returns
-------
isVerbose : bool
The verbose mode is activated if it is *True*, desactivated otherwise."
%enddef
%feature("docstring") OT::SamplerImplementation::getVerbose
OT_Sampler_getVerbose_doc
// ---------------------------------------------------------------------
%define OT_Sampler_setVerbose_doc
"Set the verbose mode.
Parameters
----------
isVerbose : bool
The verbose mode is activated if it is *True*, desactivated otherwise."
%enddef
%feature("docstring") OT::SamplerImplementation::setVerbose
OT_Sampler_setVerbose_doc
|