C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

multinomial_naive_bayes_training_online.h
1 /* file: multinomial_naive_bayes_training_online.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the interface for multinomial naive Bayes model-based training
45 // in the online processing mode
46 //--
47 */
48 
49 #ifndef __NAIVE_BAYES_TRAINING_ONLINE_H__
50 #define __NAIVE_BAYES_TRAINING_ONLINE_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "multinomial_naive_bayes_training_types.h"
54 #include "algorithms/classifier/classifier_training_online.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace multinomial_naive_bayes
61 {
62 namespace training
63 {
64 
65 namespace interface1
66 {
79 template<typename algorithmFPType, Method method, CpuType cpu>
80 class DAAL_EXPORT OnlineContainer : public TrainingContainerIface<online>
81 {
82 public:
88  OnlineContainer(daal::services::Environment::env *daalEnv);
90  ~OnlineContainer();
91 
98  services::Status compute() DAAL_C11_OVERRIDE;
105  services::Status finalizeCompute() DAAL_C11_OVERRIDE;
106 };
107 
121 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
122 class DAAL_EXPORT Online : public classifier::training::Online
123 {
124 public:
125  typedef classifier::training::Online super;
126 
127  typedef typename super::InputType InputType;
128  typedef algorithms::multinomial_naive_bayes::Parameter ParameterType;
129  typedef algorithms::multinomial_naive_bayes::training::Result ResultType;
130  typedef algorithms::multinomial_naive_bayes::training::PartialResult PartialResultType;
131 
136  Online(size_t nClasses) : parameter(nClasses)
137  {
138  initialize();
139  }
140 
147  Online(const Online<algorithmFPType, method> &other) :
148  classifier::training::Online(other), parameter(other.parameter)
149  {
150  initialize();
151  }
152 
153  virtual ~Online() {}
154 
159  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
160 
165  ResultPtr getResult()
166  {
167  return services::staticPointerCast<ResultType, classifier::training::Result>(_result);
168  }
169 
176  services::Status setResult(const ResultPtr& result)
177  {
178  DAAL_CHECK(result, services::ErrorNullResult)
179  _result = result;
180  _res = _result.get();
181  return services::Status();
182  }
183 
187  void resetResult()
188  {
189  _result.reset(new ResultType());
190  _res = NULL;
191  }
192 
197  PartialResultPtr getPartialResult() { return PartialResultType::cast(_partialResult); }
198 
204  services::SharedPtr<Online<algorithmFPType, method> > clone() const
205  {
206  return services::SharedPtr<Online<algorithmFPType, method> >(cloneImpl());
207  }
208 
209  ParameterType parameter;
211 protected:
212 
213  virtual Online<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
214  {
215  return new Online<algorithmFPType, method>(*this);
216  }
217 
218  services::Status allocateResult() DAAL_C11_OVERRIDE
219  {
220  PartialResultPtr pres = getPartialResult();
221  ResultPtr res = services::staticPointerCast<ResultType, classifier::training::Result>(_result);
222  services::Status s = res->template allocate<algorithmFPType>(pres.get(), &parameter, (int)method);
223  _res = _result.get();
224  return s;
225  }
226 
227  services::Status allocatePartialResult() DAAL_C11_OVERRIDE
228  {
229  PartialResultPtr pres = getPartialResult();
230  services::Status s = pres->template allocate<algorithmFPType>((classifier::training::InputIface *)(&input), &parameter, (int)method);
231  _pres = _partialResult.get();
232  return s;
233  }
234 
235  services::Status initializePartialResult() DAAL_C11_OVERRIDE
236  {
237  PartialResultPtr pres = getPartialResult();
238  services::Status s = pres->template initialize<algorithmFPType>((classifier::training::InputIface *)(&input), &parameter, (int)method);
239  _pres = _partialResult.get();
240  return s;
241  }
242 
243  void initialize()
244  {
245  _ac = new __DAAL_ALGORITHM_CONTAINER(online, OnlineContainer, algorithmFPType, method)(&_env);
246  _par = &parameter;
247  _result.reset(new ResultType());
248  _partialResult.reset(new PartialResultType());
249  }
250 };
252 } // namespace interface1
253 using interface1::OnlineContainer;
254 using interface1::Online;
255 
256 } // namespace training
257 } // namespace multinomial_naive_bayes
258 } // namespace algorithms
259 } // namespace daal
260 #endif
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:134
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::parameter
ParameterType parameter
Definition: multinomial_naive_bayes_training_online.h:209
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::algorithms::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:81
daal::algorithms::classifier::training::interface1::InputIface
Abstract class that specifies the interface of the classes of the classification algorithm input obje...
Definition: classifier_training_types.h:121
daal::algorithms::multinomial_naive_bayes::training::interface1::OnlineContainer
Class containing computation methods for naive Bayes training in the online processing mode...
Definition: multinomial_naive_bayes_training_online.h:80
daal::algorithms::classifier::training::interface1::Online
Algorithm class for training the classifier model in the online processing mode.
Definition: classifier_training_online.h:81
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::Online
Online(const Online< algorithmFPType, method > &other)
Definition: multinomial_naive_bayes_training_online.h:147
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::Online
Online(size_t nClasses)
Definition: multinomial_naive_bayes_training_online.h:136
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::multinomial_naive_bayes::training::interface1::PartialResult
Provides methods to access partial results obtained with the compute() method of the naive Bayes trai...
Definition: multinomial_naive_bayes_training_types.h:104
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::resetResult
void resetResult()
Definition: multinomial_naive_bayes_training_online.h:187
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::getPartialResult
PartialResultPtr getPartialResult()
Definition: multinomial_naive_bayes_training_online.h:197
daal::algorithms::multinomial_naive_bayes::training::interface1::Result
Provides methods to access final results obtained with the compute() method of the naive Bayes traini...
Definition: multinomial_naive_bayes_training_types.h:185
daal::algorithms::classifier::training::interface1::PartialResult
Provides methods to access partial results obtained with the compute() method of the classifier train...
Definition: classifier_training_types.h:175
daal::algorithms::multinomial_naive_bayes::interface1::Parameter
Naive Bayes algorithm parameters.
Definition: multinomial_naive_bayes_model.h:84
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:222
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::clone
services::SharedPtr< Online< algorithmFPType, method > > clone() const
Definition: multinomial_naive_bayes_training_online.h:204
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_online.h:159
daal::online
Definition: daal_defines.h:134
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::getResult
ResultPtr getResult()
Definition: multinomial_naive_bayes_training_online.h:165
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:76
daal::algorithms::multinomial_naive_bayes::training::interface1::Online
Algorithm class for training naive Bayes model.
Definition: multinomial_naive_bayes_training_online.h:122
daal::algorithms::multinomial_naive_bayes::training::interface1::Online::setResult
services::Status setResult(const ResultPtr &result)
Definition: multinomial_naive_bayes_training_online.h:176

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