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

multinomial_naive_bayes_training_batch.h
1 /* file: multinomial_naive_bayes_training_batch.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 batch processing mode
46 //--
47 */
48 
49 #ifndef __NAIVE_BAYES_TRAINING_BATCH_H__
50 #define __NAIVE_BAYES_TRAINING_BATCH_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "multinomial_naive_bayes_training_types.h"
56 #include "algorithms/classifier/classifier_training_batch.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
65 namespace multinomial_naive_bayes
66 {
67 namespace training
68 {
69 
70 namespace interface1
71 {
84 template<typename algorithmFPType, Method method, CpuType cpu>
85 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
86 {
87 public:
93  BatchContainer(daal::services::Environment::env *daalEnv);
95  ~BatchContainer();
101  services::Status compute() DAAL_C11_OVERRIDE;
102 };
103 
116 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
117 class DAAL_EXPORT Batch : public classifier::training::Batch
118 {
119 public:
120  typedef classifier::training::Batch super;
121 
122  typedef typename super::InputType InputType;
123  typedef algorithms::multinomial_naive_bayes::Parameter ParameterType;
124  typedef algorithms::multinomial_naive_bayes::training::Result ResultType;
125 
126  ParameterType parameter;
127  InputType input;
133  Batch(size_t nClasses) : parameter(nClasses)
134  {
135  initialize();
136  }
137 
144  Batch(const Batch<algorithmFPType, method> &other) :
145  classifier::training::Batch(other), parameter(other.parameter), input(other.input)
146  {
147  initialize();
148  }
149 
150  virtual ~Batch() {}
151 
156  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
157 
162  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
163 
168  ResultPtr getResult()
169  {
170  return ResultType::cast(_result);
171  }
172 
176  services::Status resetResult() DAAL_C11_OVERRIDE
177  {
178  _result.reset(new ResultType());
179  DAAL_CHECK(_result, services::ErrorNullResult);
180  _res = NULL;
181  return services::Status();
182  }
183 
189  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
190  {
191  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
192  }
193 
194 protected:
195  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
196  {
197  return new Batch<algorithmFPType, method>(*this);
198  }
199 
200  services::Status allocateResult() DAAL_C11_OVERRIDE
201  {
202  ResultPtr res = getResult();
203  DAAL_CHECK(res, services::ErrorNullResult);
204  services::Status s = res->template allocate<algorithmFPType>(&input, &parameter, (int)method);
205  _res = _result.get();
206  return s;
207  }
208 
209  void initialize()
210  {
211  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
212  _in = &input;
213  _par = &parameter;
214  _result.reset(new ResultType());
215  }
216 };
218 } // namespace interface1
219 using interface1::BatchContainer;
220 using interface1::Batch;
221 
222 } // namespace training
223 } // namespace multinomial_naive_bayes
224 } // namespace algorithms
225 } //namespace daal
226 #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::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::multinomial_naive_bayes::training::interface1::Batch::parameter
ParameterType parameter
Definition: multinomial_naive_bayes_training_batch.h:126
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: multinomial_naive_bayes_training_batch.h:144
daal_defines.h
daal::batch
Definition: daal_defines.h:132
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:156
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::Batch::getResult
ResultPtr getResult()
Definition: multinomial_naive_bayes_training_batch.h:168
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::multinomial_naive_bayes::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:176
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:82
daal::algorithms::multinomial_naive_bayes::interface1::Parameter
Naive Bayes algorithm parameters.
Definition: multinomial_naive_bayes_model.h:84
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch
Algorithm class for training the naive Bayes model.
Definition: multinomial_naive_bayes_training_batch.h:117
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::BatchContainer
Class containing methods to compute naive Bayes training results.
Definition: multinomial_naive_bayes_training_batch.h:85
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_batch.h:162
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: multinomial_naive_bayes_training_batch.h:189
daal::algorithms::multinomial_naive_bayes::training::interface1::Batch::input
InputType input
Definition: multinomial_naive_bayes_training_batch.h:127
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::Batch::Batch
Batch(size_t nClasses)
Definition: multinomial_naive_bayes_training_batch.h:133

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