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

multinomial_naive_bayes_training_batch.h
1 /* file: multinomial_naive_bayes_training_batch.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 the interface for multinomial naive Bayes model-based training
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __NAIVE_BAYES_TRAINING_BATCH_H__
26 #define __NAIVE_BAYES_TRAINING_BATCH_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "data_management/data/numeric_table.h"
30 #include "services/daal_defines.h"
31 #include "multinomial_naive_bayes_training_types.h"
32 #include "algorithms/classifier/classifier_training_batch.h"
33 
34 namespace daal
35 {
36 namespace algorithms
37 {
41 namespace multinomial_naive_bayes
42 {
43 namespace training
44 {
45 
46 namespace interface1
47 {
60 template<typename algorithmFPType, Method method, CpuType cpu>
61 class BatchContainer : public TrainingContainerIface<batch>
62 {
63 public:
69  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
71  DAAL_DEPRECATED ~BatchContainer();
77  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
78 };
79 
92 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
93 class DAAL_EXPORT Batch : public classifier::training::interface1::Batch
94 {
95 public:
96  typedef classifier::training::interface1::Batch super;
97 
98  typedef typename super::InputType InputType;
99  typedef algorithms::multinomial_naive_bayes::interface1::Parameter ParameterType;
100  typedef algorithms::multinomial_naive_bayes::training::Result ResultType;
101 
102  ParameterType parameter;
103  InputType input;
109  DAAL_DEPRECATED Batch(size_t nClasses) : parameter(nClasses)
110  {
111  initialize();
112  }
113 
120  DAAL_DEPRECATED Batch(const Batch<algorithmFPType, method> &other) :
121  classifier::training::interface1::Batch(other), parameter(other.parameter), input(other.input)
122  {
123  initialize();
124  }
125 
126  DAAL_DEPRECATED_VIRTUAL virtual ~Batch() {}
127 
132  DAAL_DEPRECATED InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
133 
138  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
139 
144  DAAL_DEPRECATED ResultPtr getResult()
145  {
146  return ResultType::cast(_result);
147  }
148 
152  DAAL_DEPRECATED services::Status resetResult() DAAL_C11_OVERRIDE
153  {
154  _result.reset(new ResultType());
155  DAAL_CHECK(_result, services::ErrorNullResult);
156  _res = NULL;
157  return services::Status();
158  }
159 
165  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
166  {
167  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
168  }
169 
170 protected:
171  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
172  {
173  return new Batch<algorithmFPType, method>(*this);
174  }
175 
176  services::Status allocateResult() DAAL_C11_OVERRIDE
177  {
178  ResultPtr res = getResult();
179  DAAL_CHECK(res, services::ErrorNullResult);
180  services::Status s = res->template allocate<algorithmFPType>(&input, &parameter, (int)method);
181  _res = _result.get();
182  return s;
183  }
184 
185  void initialize()
186  {
187  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
188  _in = &input;
189  _par = &parameter;
190  _result.reset(new ResultType());
191  }
192 };
194 } // namespace interface1
195 
196 namespace interface2
197 {
210 template<typename algorithmFPType, Method method, CpuType cpu>
211 class BatchContainer : public TrainingContainerIface<batch>
212 {
213 public:
219  BatchContainer(daal::services::Environment::env *daalEnv);
221  ~BatchContainer();
227  services::Status compute() DAAL_C11_OVERRIDE;
228 };
229 
242 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
243 class DAAL_EXPORT Batch : public classifier::training::Batch
244 {
245 public:
246  typedef classifier::training::Batch super;
247 
248  typedef algorithms::multinomial_naive_bayes::training::Input InputType;
249  typedef algorithms::multinomial_naive_bayes::Parameter ParameterType;
250  typedef algorithms::multinomial_naive_bayes::training::Result ResultType;
251 
252  ParameterType parameter;
253  InputType input;
259  Batch(size_t nClasses) : parameter(nClasses)
260  {
261  initialize();
262  }
263 
270  Batch(const Batch<algorithmFPType, method> &other) :
271  classifier::training::Batch(other), parameter(other.parameter), input(other.input)
272  {
273  initialize();
274  }
275 
276  virtual ~Batch() {}
277 
282  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
283 
288  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
289 
294  ResultPtr getResult()
295  {
296  return ResultType::cast(_result);
297  }
298 
302  services::Status resetResult() DAAL_C11_OVERRIDE
303  {
304  _result.reset(new ResultType());
305  DAAL_CHECK(_result, services::ErrorNullResult);
306  _res = NULL;
307  return services::Status();
308  }
309 
315  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
316  {
317  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
318  }
319 
320 protected:
321  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
322  {
323  return new Batch<algorithmFPType, method>(*this);
324  }
325 
326  services::Status allocateResult() DAAL_C11_OVERRIDE
327  {
328  ResultPtr res = getResult();
329  DAAL_CHECK(res, services::ErrorNullResult);
330  services::Status s = res->template allocate<algorithmFPType>(&input, &parameter, (int)method);
331  _res = _result.get();
332  return s;
333  }
334 
335  void initialize()
336  {
337  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
338  _in = &input;
339  _par = &parameter;
340  _result.reset(new ResultType());
341  }
342 };
344 } // namespace interface2
345 using interface2::BatchContainer;
346 using interface2::Batch;
347 
348 } // namespace training
349 } // namespace multinomial_naive_bayes
350 } // namespace algorithms
351 } //namespace daal
352 #endif
daal::algorithms::classifier::training::interface1::Result
Provides methods to access final results obtained with the compute() method in the batch processing m...
Definition: classifier_training_types.h:198
daal::algorithms::multinomial_naive_bayes::training::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::batch
Definition: daal_defines.h:112
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::Batch
DAAL_DEPRECATED Batch(const Batch< algorithmFPType, method > &other)
Definition: multinomial_naive_bayes_training_batch.h:120
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:58
daal::algorithms::multinomial_naive_bayes::training::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:302
daal::algorithms::multinomial_naive_bayes::interface1::Parameter
Naive Bayes algorithm parameters.
Definition: multinomial_naive_bayes_model.h:60
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::multinomial_naive_bayes::training::interface2::BatchContainer::compute
services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::multinomial_naive_bayes::training::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: multinomial_naive_bayes_training_batch.h:165
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::Batch
Batch(size_t nClasses)
Definition: multinomial_naive_bayes_training_batch.h:259
daal_defines.h
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch
Algorithm class for training the naive Bayes model.
Definition: multinomial_naive_bayes_training_batch.h:243
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:138
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::parameter
ParameterType parameter
Definition: multinomial_naive_bayes_training_batch.h:252
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: multinomial_naive_bayes_training_batch.h:270
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::parameter
ParameterType parameter
Definition: multinomial_naive_bayes_training_batch.h:102
daal::algorithms::multinomial_naive_bayes::training::interface2::BatchContainer
Class containing methods to compute naive Bayes training results.
Definition: multinomial_naive_bayes_training_batch.h:211
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:282
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::getResult
ResultPtr getResult()
Definition: multinomial_naive_bayes_training_batch.h:294
daal::algorithms::multinomial_naive_bayes::training::interface2::BatchContainer::~BatchContainer
~BatchContainer()
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::Batch
DAAL_DEPRECATED Batch(size_t nClasses)
Definition: multinomial_naive_bayes_training_batch.h:109
daal::algorithms::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:69
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:288
daal::algorithms::classifier::training::interface1::Input
Base class for the input objects in the training stage of the classification algorithms.
Definition: classifier_training_types.h:110
daal::algorithms::multinomial_naive_bayes::training::interface1::BatchContainer
Class containing methods to compute naive Bayes training results.
Definition: multinomial_naive_bayes_training_batch.h:61
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::getInput
DAAL_DEPRECATED InputType * getInput() DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:132
daal::algorithms::multinomial_naive_bayes::training::interface2::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::input
InputType input
Definition: multinomial_naive_bayes_training_batch.h:103
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::getResult
DAAL_DEPRECATED ResultPtr getResult()
Definition: multinomial_naive_bayes_training_batch.h:144
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::input
InputType input
Definition: multinomial_naive_bayes_training_batch.h:253
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:52
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::resetResult
DAAL_DEPRECATED services::Status resetResult() DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:152
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch
Algorithm class for training the naive Bayes model.
Definition: multinomial_naive_bayes_training_batch.h:93
daal::algorithms::multinomial_naive_bayes::training::interface2::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: multinomial_naive_bayes_training_batch.h:315

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