C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

multinomial_naive_bayes_model.h
1 /* file: multinomial_naive_bayes_model.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of class defining Naive Bayes model.
21 //--
22 */
23 
24 #ifndef __NAIVE_BAYES_MODEL_H__
25 #define __NAIVE_BAYES_MODEL_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "data_management/data/homogen_numeric_table.h"
30 #include "algorithms/classifier/classifier_model.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
45 namespace multinomial_naive_bayes
46 {
47 
51 namespace interface1
52 {
59 /* [interface1::Parameter source code] */
60 struct DAAL_EXPORT Parameter : public classifier::interface1::Parameter
61 {
68  DAAL_DEPRECATED Parameter(size_t nClasses, const data_management::NumericTablePtr &priorClassEstimates_ = data_management::NumericTablePtr(),
69  const data_management::NumericTablePtr &alpha_ = data_management::NumericTablePtr()) :
70  classifier::interface1::Parameter(nClasses), priorClassEstimates(priorClassEstimates_), alpha(alpha_) {}
71 
72  data_management::NumericTablePtr priorClassEstimates;
73  data_management::NumericTablePtr alpha;
75  DAAL_DEPRECATED services::Status check() const DAAL_C11_OVERRIDE;
76 };
77 /* [interface1::Parameter source code] */
78 }
79 
83 namespace interface2
84 {
91 /* [Parameter source code] */
92 struct DAAL_EXPORT Parameter : public classifier::Parameter
93 {
100  Parameter(size_t nClasses, const data_management::NumericTablePtr &priorClassEstimates_ = data_management::NumericTablePtr(),
101  const data_management::NumericTablePtr &alpha_ = data_management::NumericTablePtr()) :
102  classifier::Parameter(nClasses), priorClassEstimates(priorClassEstimates_), alpha(alpha_) {}
103 
104  data_management::NumericTablePtr priorClassEstimates;
105  data_management::NumericTablePtr alpha;
107  services::Status check() const DAAL_C11_OVERRIDE;
108 };
109 /* [Parameter source code] */
110 }
111 
112 namespace interface1
113 {
114 
119 class DAAL_EXPORT Model : public classifier::Model
120 {
121 public:
122  DECLARE_MODEL(Model, classifier::Model);
123 
128  Model() {}
129 
137  template<typename modelFPType>
138  DAAL_EXPORT Model(size_t nFeatures, const interface1::Parameter &parameter, modelFPType dummy);
139 
147  template<typename modelFPType>
148  DAAL_EXPORT Model(size_t nFeatures, const interface2::Parameter &parameter, modelFPType dummy);
149 
156  template<typename modelFPType>
157  DAAL_EXPORT static services::SharedPtr<Model> create(size_t nFeatures, const interface1::Parameter &parameter,
158  services::Status *stat = NULL);
159 
166  template<typename modelFPType>
167  DAAL_EXPORT static services::SharedPtr<Model> create(size_t nFeatures, const interface2::Parameter &parameter,
168  services::Status *stat = NULL);
170  virtual ~Model() {}
171 
176  data_management::NumericTablePtr getLogP() { return _logP; }
177 
182  data_management::NumericTablePtr getLogTheta() { return _logTheta; }
183 
188  data_management::NumericTablePtr getAuxTable() { return _auxTable; }
189 
194  size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE { return (_logTheta ?_logTheta->getNumberOfColumns() : 0); }
195 
196 protected:
197  data_management::NumericTablePtr _logP;
198  data_management::NumericTablePtr _logTheta;
199  data_management::NumericTablePtr _auxTable;
200 
201  template<typename modelFPType>
202  DAAL_EXPORT Model(size_t nFeatures, const interface1::Parameter &parameter, modelFPType dummy, services::Status &st);
203 
204  template<typename modelFPType>
205  DAAL_EXPORT Model(size_t nFeatures, const interface2::Parameter &parameter, modelFPType dummy, services::Status &st);
206 
207  template<typename Archive, bool onDeserialize>
208  services::Status serialImpl(Archive *arch)
209  {
210  services::Status st = classifier::Model::serialImpl<Archive, onDeserialize>(arch);
211  if (!st)
212  return st;
213  arch->setSharedPtrObj(_logP );
214  arch->setSharedPtrObj(_logTheta);
215  arch->setSharedPtrObj(_auxTable);
216 
217  return st;
218  }
219 };
220 
221 typedef services::SharedPtr<Model> ModelPtr;
222 
227 class DAAL_EXPORT PartialModel : public classifier::Model
228 {
229 public:
230  DECLARE_SERIALIZABLE_CAST(PartialModel);
235  PartialModel();
236 
244  template<typename modelFPType>
245  DAAL_EXPORT PartialModel(size_t nFeatures, const interface1::Parameter &parameter, modelFPType dummy);
246 
254  template<typename modelFPType>
255  DAAL_EXPORT PartialModel(size_t nFeatures, const interface2::Parameter &parameter, modelFPType dummy);
256 
264  template<typename modelFPType>
265  DAAL_EXPORT static services::SharedPtr<PartialModel> create(size_t nFeatures, const interface1::Parameter &parameter,
266  services::Status *stat = NULL);
267 
275  template<typename modelFPType>
276  DAAL_EXPORT static services::SharedPtr<PartialModel> create(size_t nFeatures, const interface2::Parameter &parameter,
277  services::Status *stat = NULL);
279  virtual ~PartialModel() {}
280 
281  size_t getNObservations()
282  {
283  return _nObservations;
284  }
285 
286  void setNObservations( size_t nObservations )
287  {
288  _nObservations = nObservations;
289  }
290 
295  size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE { return (_classGroupSum ? _classGroupSum->getNumberOfColumns() : 0); }
296 
301  size_t getNFeatures() const DAAL_C11_OVERRIDE { return getNumberOfFeatures(); }
302 
307  void setNFeatures(size_t nFeatures) DAAL_C11_OVERRIDE {}
308 
309  template<typename modelFPType>
310  services::Status initialize()
311  {
312  _classSize->assign((int)0);
313  _classGroupSum->assign((int)0);
314  _nObservations = 0;
315  return services::Status();
316  }
317 
318  data_management::NumericTablePtr getClassSize() { return _classSize; }
319  data_management::NumericTablePtr getClassGroupSum() { return _classGroupSum; }
320 
321 protected:
322  data_management::NumericTablePtr _classSize;
323  data_management::NumericTablePtr _classGroupSum;
324  size_t _nObservations;
325 
326  template<typename modelFPType>
327  DAAL_EXPORT PartialModel(size_t nFeatures, const interface1::Parameter &parameter,
328  modelFPType dummy, services::Status &st);
329 
330  template<typename modelFPType>
331  DAAL_EXPORT PartialModel(size_t nFeatures, const interface2::Parameter &parameter,
332  modelFPType dummy, services::Status &st);
333 
334  template<typename Archive, bool onDeserialize>
335  services::Status serialImpl(Archive *arch)
336  {
337  services::Status st = classifier::Model::serialImpl<Archive, onDeserialize>(arch);
338  if (!st)
339  return st;
340  arch->set(_nObservations);
341  arch->setSharedPtrObj(_classSize);
342  arch->setSharedPtrObj(_classGroupSum);
343 
344  return st;
345  }
346 };
347 typedef services::SharedPtr<PartialModel> PartialModelPtr;
348 } // namespace interface1
349 using interface2::Parameter;
350 using interface1::Model;
351 using interface1::ModelPtr;
352 using interface1::PartialModel;
353 using interface1::PartialModelPtr;
354 
355 } // namespace multinomial_naive_bayes
357 } // namespace algorithms
358 } // namespace daal
359 #endif
daal::algorithms::multinomial_naive_bayes::interface1::Model::Model
Model()
Definition: multinomial_naive_bayes_model.h:128
daal::algorithms::multinomial_naive_bayes::interface1::Model
Multinomial naive Bayes model.
Definition: multinomial_naive_bayes_model.h:119
daal::algorithms::multinomial_naive_bayes::interface1::Parameter::alpha
data_management::NumericTablePtr alpha
Definition: multinomial_naive_bayes_model.h:73
daal::algorithms::covariance::nObservations
Definition: covariance_types.h:78
daal::algorithms::multinomial_naive_bayes::interface2::Parameter
Naive Bayes algorithm parameters.
Definition: multinomial_naive_bayes_model.h:92
daal::algorithms::multinomial_naive_bayes::interface1::Parameter
Naive Bayes algorithm parameters.
Definition: multinomial_naive_bayes_model.h:60
daal::algorithms::multinomial_naive_bayes::interface1::PartialModel::setNFeatures
void setNFeatures(size_t nFeatures) DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_model.h:307
daal::algorithms::multinomial_naive_bayes::interface1::Parameter::priorClassEstimates
data_management::NumericTablePtr priorClassEstimates
Definition: multinomial_naive_bayes_model.h:72
daal::algorithms::multinomial_naive_bayes::interface1::PartialModel::getNFeatures
size_t getNFeatures() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_model.h:301
daal::algorithms::multinomial_naive_bayes::interface2::Parameter::alpha
data_management::NumericTablePtr alpha
Definition: multinomial_naive_bayes_model.h:105
daal::algorithms::multinomial_naive_bayes::interface2::Parameter::priorClassEstimates
data_management::NumericTablePtr priorClassEstimates
Definition: multinomial_naive_bayes_model.h:104
daal::algorithms::multinomial_naive_bayes::interface1::Model::getLogP
data_management::NumericTablePtr getLogP()
Definition: multinomial_naive_bayes_model.h:176
daal::algorithms::multinomial_naive_bayes::interface1::Parameter::Parameter
DAAL_DEPRECATED Parameter(size_t nClasses, const data_management::NumericTablePtr &priorClassEstimates_=data_management::NumericTablePtr(), const data_management::NumericTablePtr &alpha_=data_management::NumericTablePtr())
Definition: multinomial_naive_bayes_model.h:68
daal::algorithms::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:69
daal::algorithms::multinomial_naive_bayes::interface1::PartialModel
PartialModel represents partial multinomial naive Bayes model.
Definition: multinomial_naive_bayes_model.h:227
daal::algorithms::multinomial_naive_bayes::interface2::Parameter::Parameter
Parameter(size_t nClasses, const data_management::NumericTablePtr &priorClassEstimates_=data_management::NumericTablePtr(), const data_management::NumericTablePtr &alpha_=data_management::NumericTablePtr())
Definition: multinomial_naive_bayes_model.h:100
daal::algorithms::multinomial_naive_bayes::interface1::PartialModel::getNumberOfFeatures
size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_model.h:295
daal::algorithms::multinomial_naive_bayes::interface1::Model::getLogTheta
data_management::NumericTablePtr getLogTheta()
Definition: multinomial_naive_bayes_model.h:182
daal::algorithms::multinomial_naive_bayes::interface1::Model::getAuxTable
data_management::NumericTablePtr getAuxTable()
Definition: multinomial_naive_bayes_model.h:188
daal::algorithms::multinomial_naive_bayes::interface1::Model::getNumberOfFeatures
size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_model.h:194

For more complete information about compiler optimizations, see our Optimization Notice.