/usr/include/openturns/swig/KernelMixture_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 | %feature("docstring") OT::KernelMixture
"Build a particular linear combination of probability density functions.
Parameters
----------
kernel : :class:`~openturns.Distribution`
Univariate distribution of the kernel that will be used, :math:`K`.
bandwidth : sequence of float
Contains the bandwith in each direction, :math:`(h_1, \\\\dots, h_d)`.
sample : 2-d sequence of float
The data on wich each kernel is centered,
:math:`(\\\\vect{X}_1, \\\\dots, \\\\vect{X}_N) \\\\in \\\\Rset^d`.
Notes
-----
A *KernelMixture* is a particular *Mixture*: all the weights are identical and
the all the probability density functions of the combination are of the same
family. They are centered on :math:`N` points. The treatment is optimized.
The pdf of a *KernelMixture* is defined by:
..math::
f(\\\\vect{x}) = \\\\sum_{i=1}^N \\\\dfrac{1}{N} \\\\Pi_{j=1}^d \\\\dfrac{1}{h_j}K(\\\\frac{x^j-X^j_i}{h})
where :math:`N` is the number of points in the sample
:math:`(\\\\vect{X}_1, \\\\dots, \\\\vect{X}_N) \\\\in \\\\Rset^d` and :math:`K` a univariate
distribution.
Examples
--------
Create a *KernelMixture*:
>>> import openturns as ot
>>> kernel = ot.Uniform()
>>> sample = ot.Normal().getSample(5)
>>> bandwith = [1.0]
>>> myKernelMixture = ot.KernelMixture(kernel, bandwith, sample)
See the pdf:
>>> graph = myKernelMixture.drawPDF(64)
>>> graph.setLegends(['KernelMixture'])"
// ---------------------------------------------------------------------
%feature("docstring") OT::KernelMixture::getKernel
"Accessor to kernel used in the linear combination.
Returns
-------
kernel : :class:`~openturns.Distribution`
Univariate distribution used to build the kernel."
// ---------------------------------------------------------------------
%feature("docstring") OT::KernelMixture::setKernel
"Set the kernel used in the linear combination.
Parameters
----------
kernel : :class:`~openturns.Distribution`
Univariate distribution used to build the kernel."
// ---------------------------------------------------------------------
%feature("docstring") OT::KernelMixture::getBandwidth
"Accessor to the bandwith used in the linear combination.
Returns
-------
bandwidth : :class:`~openturns.Point`
Bandwith used in each direction."
// ---------------------------------------------------------------------
%feature("docstring") OT::KernelMixture::setBandwidth
"Set the bandwith used in the linear combination.
Parameters
----------
bandwidth : sequence of float
Bandwith used in each direction."
// ---------------------------------------------------------------------
%feature("docstring") OT::KernelMixture::setInternalSample
"Set the sample used in the linear combination.
Parameters
----------
sample : 2-d sequence of float
Sample on wich the kernels are centered."
|