/usr/include/openturns/swig/Box_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 | %feature("docstring") OT::Box
"Box design of experiments.
Available constructor:
Box(*levels*)
Parameters
----------
levels : sequence of int or float
Sequence specifying the number of intermediate points on each direction
which regularly discretize :math:`[0,1]`. In direction :math:`i`, the
points number is :math:`levels[i]+2`: the extreme bounds 0 and 1 are
always taken.
Notes
-----
Box is a stratified design of experiments enabling to create
a points grid by regularly discretizing the unit pavement :math:`[0,1]^n` with
the number of intermediate points specified for each direction. The number of
points generated is :math:`\\\\prod_{i=1}^n (2+levels[i])`.
In order to scale each direction and translate the grid structure onto the
proper center, use the operator :math:`*=` and :math:`+=` of
:class:`~openturns.NumericalSample`.
See also
--------
StratifiedExperiment
Examples
--------
>>> import openturns as ot
>>> levels = [4., 2.]
>>> # Here : direction 1 will be discretized with 4 intermediate points
>>> # and direction 2 with 2 intermediate points
>>> myCenteredReductedGrid = ot.Box(levels)
>>> mySample = myCenteredReductedGrid.generate()
>>> # Translate the grid
>>> mySample+=4
>>> # Scale each direction
>>> mySample*=2"
|