1%define OT_Classifier_doc
2"Classifier.
3
4Available constructors:
5    Classifier(*classifierImp*)
6
7Parameters
8----------
9classifierImp : classifier implementation
10    A classifier implementation. It can be a :class:`~openturns.MixtureClassifier`.
11
12See also
13--------
14MixtureClassifier, ExpertMixture
15
16Notes
17-----
18The classifier enables to define rules that assign a vector to a particular
19class."
20%enddef
21%feature("docstring") OT::ClassifierImplementation
22OT_Classifier_doc
23
24// ---------------------------------------------------------------------
25
26%define OT_Classifier_getNumberOfClasses_doc
27"Accessor to the number of classes.
28
29Returns
30-------
31n_classes : int
32    The number of classes"
33%enddef
34%feature("docstring") OT::ClassifierImplementation::getNumberOfClasses
35OT_Classifier_getNumberOfClasses_doc
36
37
38// ---------------------------------------------------------------------
39
40%define OT_Classifier_classify_doc
41"Classify points according to the classifier.
42
43Parameters
44----------
45input : sequence of float or 2-d a sequence of float
46    A point or set of points to classify.
47
48Returns
49-------
50cls : int or :class:`~openturns.Indices`
51    The class index of the input points, or indices of the classes of each points."
52%enddef
53%feature("docstring") OT::ClassifierImplementation::classify
54OT_Classifier_classify_doc
55
56// ---------------------------------------------------------------------
57
58%define OT_Classifier_grade_doc
59"Grade points according to the classifier.
60
61Parameters
62----------
63inputPoint : sequence of float or 2-d a sequence of float
64    A point or set of points to grade.
65k : int or sequence of int
66    The class index, or class indices.
67
68Returns
69-------
70grade : float or :class:`~openturns.Point`
71    Grade or list of grades of each input point with respect to each class index"
72%enddef
73%feature("docstring") OT::ClassifierImplementation::grade
74OT_Classifier_grade_doc
75
76// ---------------------------------------------------------------------
77
78%define OT_Classifier_getDimension_doc
79"Accessor to the dimension.
80
81Returns
82-------
83dim : int
84    The dimension of the classifier."
85%enddef
86%feature("docstring") OT::ClassifierImplementation::getDimension
87OT_Classifier_getDimension_doc
88
89// ---------------------------------------------------------------------
90
91%define OT_Classifier_getVerbose_doc
92"Accessor to the verbosity.
93
94Returns
95-------
96verb : bool
97    Logical value telling if the verbose mode has been activated."
98%enddef
99%feature("docstring") OT::ClassifierImplementation::getVerbose
100OT_Classifier_getVerbose_doc
101
102// ---------------------------------------------------------------------
103
104%define OT_Classifier_setVerbose_doc
105"Accessor to the verbosity.
106
107Parameters
108----------
109verb : bool
110    Logical value telling if the verbose mode has been activated."
111%enddef
112%feature("docstring") OT::ClassifierImplementation::setVerbose
113OT_Classifier_setVerbose_doc
114
115// ---------------------------------------------------------------------
116
117%define OT_Classifier_setParallel_doc
118"Accessor to the parallel flag.
119
120Parameters
121----------
122flag : bool
123    Logical value telling if the classification and grading are done in parallel.
124"
125%enddef
126%feature("docstring") OT::ClassifierImplementation::setParallel
127OT_Classifier_setParallel_doc
128
129// ---------------------------------------------------------------------
130
131%define OT_Classifier_isParallel_doc
132"Accessor to the parallel flag.
133
134Returns
135-------
136flag : bool
137    Logical value telling if the parallel mode has been activated.
138"
139%enddef
140%feature("docstring") OT::ClassifierImplementation::isParallel
141OT_Classifier_isParallel_doc
142