/usr/include/openturns/swig/SamplingStrategyImplementation_doc.i is in libopenturns-dev 1.9-5.
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 | %define OT_SamplingStrategy_doc
"Base class for sampling strategies.
Available constructor:
SamplingStrategyImplementation()
SamplingStrategyImplementation(*samplingStratImp*)
SamplingStrategyImplementation(*dimension*)
Parameters
----------
samplingStratImp : SamplingStrategyImplementationImplementation
An implementation of the sampling strategy adopted, which is
:class:`~openturns.RandomDirection` or :class:`~openturns.OrthogonalDirection`.
dimension : int
The dimension of the standard space. By default, :math:`dimension = 0` but
automatically updated by the calling class.
See also
--------
RandomDirection, OrthogonalDirection"
%enddef
%feature("docstring") OT::SamplingStrategyImplementation
OT_SamplingStrategy_doc
// ---------------------------------------------------------------------
%define OT_SamplingStrategy_generate_doc
"Generate the sample.
Returns
-------
sample : :class:`~openturns.Sample`
The sample generated according to the sampling strategy."
%enddef
%feature("docstring") OT::SamplingStrategyImplementation::generate
OT_SamplingStrategy_generate_doc
// ---------------------------------------------------------------------
%define OT_SamplingStrategy_getDimension_doc
"Accessor to the dimension.
Returns
-------
dimension : int
Dimension of the standard space."
%enddef
%feature("docstring") OT::SamplingStrategyImplementation::getDimension
OT_SamplingStrategy_getDimension_doc
// ---------------------------------------------------------------------
%define OT_SamplingStrategy_setDimension_doc
"Accessor to the dimension.
Parameters
----------
dimension : int
Dimension of the standard space."
%enddef
%feature("docstring") OT::SamplingStrategyImplementation::setDimension
OT_SamplingStrategy_setDimension_doc
// ---------------------------------------------------------------------
%define OT_SamplingStrategy_getUniformUnitVectorRealization_doc
"Accessor to a realization according to the uniform distribution.
Parameters
----------
dimension : int
The dimension of the sphere unity (which is the dimension of the standard
space).
Returns
-------
sample : :class:`~openturns.Point`
The realization of a vector on the sphere unity, according to the uniform
distribution."
%enddef
%feature("docstring") OT::SamplingStrategyImplementation::getUniformUnitVectorRealization
OT_SamplingStrategy_getUniformUnitVectorRealization_doc
|