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

implicit_als_training_init_batch.h
1 /* file: implicit_als_training_init_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 the implicit ALS initialization algorithm
19 // in the batch processing mode
20 //--
21 */
22 
23 #ifndef __IMPLICIT_ALS_TRAINING_INIT_BATCH_H__
24 #define __IMPLICIT_ALS_TRAINING_INIT_BATCH_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "algorithms/implicit_als/implicit_als_training_init_types.h"
28 
29 namespace daal
30 {
31 namespace algorithms
32 {
33 namespace implicit_als
34 {
35 namespace training
36 {
37 namespace init
38 {
39 
40 namespace interface1
41 {
51 template<typename algorithmFPType, Method method, CpuType cpu>
52 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
53 {
54 public:
60  BatchContainer(daal::services::Environment::env *daalEnv);
62  ~BatchContainer();
66  services::Status compute() DAAL_C11_OVERRIDE;
67 };
68 
81 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
82 class DAAL_EXPORT Batch : public daal::algorithms::Training<batch>
83 {
84 public:
85  typedef algorithms::implicit_als::training::init::Input InputType;
86  typedef algorithms::implicit_als::training::init::Parameter ParameterType;
87  typedef algorithms::implicit_als::training::init::Result ResultType;
88 
89  InputType input;
90  ParameterType parameter;
93  Batch()
94  {
95  initialize();
96  }
97 
104  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
105  {
106  initialize();
107  }
108 
113  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
114 
119  ResultPtr getResult()
120  {
121  return _result;
122  }
123 
128  services::Status setResult(const ResultPtr& res)
129  {
130  DAAL_CHECK(res, services::ErrorNullResult)
131  _result = res;
132  _res = _result.get();
133  return services::Status();
134  }
135 
141  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
142  {
143  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
144  }
145 
146 protected:
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.reset(new ResultType());
165  }
166 
167 private:
168  ResultPtr _result;
169 };
171 } // namespace interface1
172 using interface1::BatchContainer;
173 using interface1::Batch;
174 
175 }
176 }
177 }
178 }
179 }
180 
181 #endif
daal
Definition: algorithm_base_common.h:31
daal::algorithms::implicit_als::training::init::interface1::Batch::Batch
Batch()
Definition: implicit_als_training_init_batch.h:93
daal::algorithms::implicit_als::training::init::interface1::Batch::getResult
ResultPtr getResult()
Definition: implicit_als_training_init_batch.h:119
daal::algorithms::implicit_als::training::init::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_init_batch.h:113
daal::algorithms::implicit_als::training::init::interface1::Batch::parameter
ParameterType parameter
Definition: implicit_als_training_init_batch.h:90
daal::algorithms::implicit_als::training::init::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: implicit_als_training_init_batch.h:141
daal::batch
Definition: daal_defines.h:110
daal::algorithms::implicit_als::training::init::interface1::BatchContainer
Provides methods to run implementations of the implicit ALS initialization algorithm.
Definition: implicit_als_training_init_batch.h:52
daal::algorithms::implicit_als::training::init::interface1::Batch
Algorithm class for initializing the implicit ALS model.
Definition: implicit_als_training_init_batch.h:82
daal::algorithms::implicit_als::training::init::interface1::Batch::input
InputType input
Definition: implicit_als_training_init_batch.h:89
daal::algorithms::implicit_als::training::init::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: implicit_als_training_init_batch.h:128
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::implicit_als::training::init::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: implicit_als_training_init_batch.h:104
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.