/usr/include/openturns/swig/Box_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 | %feature("docstring") OT::Box
"Box design of experiments.
Available constructor:
Box(*levels*)
Box(*levels, bounds*)
Parameters
----------
levels : sequence of int or float
Sequence specifying the number of intermediate points in each direction
which regularly discretizes a pavement. In direction :math:`i`, the
points number is :math:`levels[i]+2`.
bounds : :class:`~openturns.Interval`
The bounds of the pavement
If not specified, the bounds are set to the unit pavement :math:`[0,1]^n`.
Notes
-----
Box is a stratified design of experiments enabling to create
a points grid by regularly discretizing a pavement with
the number of intermediate points specified in each direction. The number of
points generated is :math:`\\\\prod_{i=1}^n (2+levels[i])`.
See also
--------
StratifiedExperiment
Examples
--------
>>> import openturns as ot
>>> # direction 1 will be discretized in with 4 intermediate points
>>> # and direction 2 with 2 intermediate points
>>> levels = [4, 2]
>>> # first component in [5,7], second in [6,9]
>>> bounds = ot.Interval([5.0, 6.0], [7.0, 9.0])
>>> myGrid = ot.Box(levels, bounds)
>>> mySample = myGrid.generate()"
|