/usr/include/openturns/swig/Compact_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 | %feature("docstring") OT::Compact
"Compact history storage strategy.
Available constructors:
Compact(*N*)
Parameters
----------
N : integer
minimum number of points to store.
See also
--------
HistoryStrategy, Null, Full, Last
Notes
-----
The compact strategy stores a regularly spaced sub-sample where the minimum size
of the stored numerical sample is :math:`N`. OpenTURNS proceeds as follows :
1. it stores the first :math:`2N` simulations : the size of the stored
sample is :math:`2N`,
2. it selects only 1 out of 2 of the stored simulations : then the size of
the stored sample decreases to :math:`N` (this is the *compact* step),
3. it stores the next :math:`N` simulations when selecting 1 out of 2 of the
next simulations : the size of the stored sample is :math:`2N`,
4. it selects only 1 out of 2 of the stored simulations : then the size of
the stored sample decreases to :math:`N`,
5. it stores the next :math:`N` simulations when selecting 1 out of 4 of the
next simulations : the size of the stored sample is :math:`2N`,
6. then it keeps on until reaching the stopping criteria.
The stored numerical sample will have a size within :math:`N` and :math:`2N` if at least one cycle has been done, else it will be at most :math:`N`."
// ---------------------------------------------------------------------
%feature("docstring") OT::Compact::getHalfMaximumSize
"Accessor to the half maximum number of points to store.
Returns
-------
N : integer
The half maximum number of points to store."
// ---------------------------------------------------------------------
%feature("docstring") OT::Compact::getIndex
"Accessor to the index.
Returns
-------
index : integer
The number of the stored points."
|