C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 4

implicit_als_training_batch.h
1 /* file: implicit_als_training_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of the interface for implicit ALS model-based training in the
19 // batch processing mode
20 //--
21 */
22 
23 #ifndef __IMPLICIT_ALS_TRAINING_BATCH_H__
24 #define __IMPLICIT_ALS_TRAINING_BATCH_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "algorithms/implicit_als/implicit_als_training_types.h"
28 
29 namespace daal
30 {
31 namespace algorithms
32 {
33 namespace implicit_als
34 {
35 namespace training
36 {
37 
38 namespace interface1
39 {
49 template<typename algorithmFPType, Method method, CpuType cpu>
50 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
51 {
52 public:
58  BatchContainer(daal::services::Environment::env *daalEnv);
60  ~BatchContainer();
64  services::Status compute() DAAL_C11_OVERRIDE;
65 };
66 
79 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
80 class DAAL_EXPORT Batch : public daal::algorithms::Training<batch>
81 {
82 public:
83  typedef algorithms::implicit_als::training::Input InputType;
84  typedef algorithms::implicit_als::Parameter ParameterType;
85  typedef algorithms::implicit_als::training::Result ResultType;
86 
87  InputType input;
88  ParameterType parameter;
91  Batch()
92  {
93  initialize();
94  }
95 
102  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
103  {
104  initialize();
105  }
106 
111  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
112 
117  ResultPtr getResult()
118  {
119  return _result;
120  }
121 
126  services::Status setResult(const ResultPtr& res)
127  {
128  DAAL_CHECK(res, services::ErrorNullResult)
129  _result = res;
130  _res = _result.get();
131  return services::Status();
132  }
133 
139  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
140  {
141  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
142  }
143 
144 protected:
145  training::ResultPtr _result;
146 
147  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
148  {
149  return new Batch<algorithmFPType, method>(*this);
150  }
151 
152  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
153  {
154  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int) method);
155  _res = _result.get();
156  return s;
157  }
158 
159  void initialize()
160  {
161  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
162  _in = &input;
163  _par = &parameter;
164  _result = training::ResultPtr(new ResultType());
165  }
166 };
168 } // namespace interface1
169 using interface1::BatchContainer;
170 using interface1::Batch;
171 
172 }
173 }
174 }
175 }
176 
177 #endif
daal
Definition: algorithm_base_common.h:31
daal::algorithms::implicit_als::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: implicit_als_training_batch.h:102
daal::algorithms::implicit_als::training::interface1::BatchContainer
Provides methods to run implementations of implicit ALS model-based training.
Definition: implicit_als_training_batch.h:50
daal::algorithms::implicit_als::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: implicit_als_training_batch.h:139
daal::algorithms::implicit_als::training::interface1::Batch::Batch
Batch()
Definition: implicit_als_training_batch.h:91
daal::algorithms::implicit_als::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: implicit_als_training_batch.h:117
daal::batch
Definition: daal_defines.h:110
daal::algorithms::implicit_als::training::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: implicit_als_training_batch.h:126
daal::algorithms::implicit_als::training::interface1::Batch
Algorithm class for training the implicit ALS model.
Definition: implicit_als_training_batch.h:80
daal::algorithms::implicit_als::training::interface1::Batch::input
InputType input
Definition: implicit_als_training_batch.h:87
daal::algorithms::implicit_als::training::interface1::Batch::parameter
ParameterType parameter
Definition: implicit_als_training_batch.h:88
daal::algorithms::implicit_als::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_batch.h:111
daal::services::ErrorNullResult
Definition: error_indexes.h:96
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:50
daal::algorithms::Training
Provides methods to train models that depend on the data provided. For example, these methods enable ...
Definition: training.h:60

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