/usr/include/openturns/swig/SpaceFillingPhiP_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 | %define OT_SpaceFillingPhiP_doc
"Space filling PhiP.
Parameters
----------
p : int
Parameter for parametrizing the criterion
Notes
-----
Computes the criterion:
.. math::
:nowrap:
\\\\begin{equation*}
\\\\phi_p(X) = \\\\sum_{i=1}^{j} \\\\sum_{j=1}^{n} \\\\left( |x^{(i)} - x^{(j)}|^{-p} \\\\right)^{\\\\frac{1}{p}}
\\\\end{equation*}
This criterion is knwon to converge to mindist (minimal distance between two distinct elements of the design) criterion when p tends to infinity.
"
%enddef
%feature("docstring") OT::SpaceFillingPhiP
OT_SpaceFillingPhiP_doc
// ---------------------------------------------------------------------
%define OT_SpaceFillingPhiP_evaluate_doc
"Compute the PhiP criterion for a specific design.
Parameters
----------
design : :class:`~openturns.Sample` or 2d array like
The design
Returns
-------
crit : float
The phiP criterion
Examples
--------
>>> import openturns as ot
>>> # Build an LHS using openturns class
>>> lhs = ot.LHSExperiment(ot.Uniform(), 100)
>>> design = lhs.generate()
>>> # Compute the PhiP criterion
>>> crit = ot.SpaceFillingPhiP(50).evaluate(design)"
%enddef
%feature("docstring") OT::SpaceFillingPhiP::evaluate
OT_SpaceFillingPhiP_evaluate_doc
// ---------------------------------------------------------------------
|