1%feature("docstring") OT::MixedHistogramUserDefined
2"Mixed Histogram/UserDefined distribution.
3
4Defines a distribution with Histogram (continuous) or UserDefined (discrete) marginals,
5it is meant to be used as a specialization of the Mixture for efficient sampling.
6
7Each marginal is defined from a list of float that either define the intervals on which
8the marginal is uniform (equivalent to a :class:`~openturns.Histogram` distribution),
9or the set of points that define the support of the discrete marginal
10(equivalent to an :class:`~openturns.UserDefined` distribution).
11
12Weights are required for each combination of intervals or discrete points,
13ie for a dimension 2, with an Histogram component with 3 intervals (defined from 4 ticks) and
14a discrete component with 3 values (3 ticks), 9 probability values are required, see example below.
15
16Parameters
17----------
18ticksCollection : sequence of sequence of float
19    List of ticks for each component
20kind : sequence of int
21    Either MixedHistogramUserDefined.DISCRETE or MixedHistogramUserDefined.CONTINUOUS
22probabilityTable : sequence of float
23    List of probabilities
24
25See also
26--------
27Mixture, Histogram, UserDefined
28
29Examples
30--------
31>>> import openturns as ot
32>>> ticksCollection = [[0.0, 1.0, 3.0, 6.0], [1.0, 2.0, 3.0]]
33>>> kind = [ot.MixedHistogramUserDefined.CONTINUOUS, ot.MixedHistogramUserDefined.DISCRETE]
34>>> probabilityTable = [0.05,0.1,0.15,0.2,0.25,0.3,0.35,0.4,0.45]
35>>> distribution = ot.MixedHistogramUserDefined(ticksCollection, kind, probabilityTable)
36>>> distribution.setDescription(['A', 'B'])
37>>> sample = distribution.getSample(5)"
38
39// ----------------------------------------------------------------------------
40
41%feature("docstring") OT::MixedHistogramUserDefined::asMixture
42"Conversion as a Mixture.
43
44Returns
45-------
46mixture : :class:`~openturns.Mixture`
47    Mixture distribution"
48
49// ----------------------------------------------------------------------------
50
51%feature("docstring") OT::MixedHistogramUserDefined::setKind
52"Kind accessor.
53
54Parameters
55----------
56kind : sequence of int
57    0=discrete, 1=continuous"
58
59// ----------------------------------------------------------------------------
60
61%feature("docstring") OT::MixedHistogramUserDefined::getKind
62"Kind accessor.
63
64Returns
65-------
66kind : sequence of int
67    0=discrete, 1=continuous"
68
69// ----------------------------------------------------------------------------
70
71%feature("docstring") OT::MixedHistogramUserDefined::setProbabilityTable
72"Probability table accessor.
73
74Parameters
75----------
76probabilityTable : sequence of float
77    List of probabilities"
78
79// ----------------------------------------------------------------------------
80
81%feature("docstring") OT::MixedHistogramUserDefined::getProbabilityTable
82"Probability table accessor.
83
84Returns
85-------
86probabilityTable : sequence of float
87    List of probabilities"
88
89// ----------------------------------------------------------------------------
90
91%feature("docstring") OT::MixedHistogramUserDefined::setTicksCollection
92"Ticks accessor.
93
94Parameters
95----------
96ticksCollection : sequence of sequence of float
97    ticksCollection"
98
99// ----------------------------------------------------------------------------
100
101%feature("docstring") OT::MixedHistogramUserDefined::getTicksCollection
102"Ticks accessor.
103
104Returns
105-------
106ticksCollection : sequence of sequence of float
107    ticksCollection"
108