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

implicit_als_training_batch.h
1 /* file: implicit_als_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 implicit ALS model-based training in the
21 // batch processing mode
22 //--
23 */
24 
25 #ifndef __IMPLICIT_ALS_TRAINING_BATCH_H__
26 #define __IMPLICIT_ALS_TRAINING_BATCH_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "algorithms/implicit_als/implicit_als_training_types.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace implicit_als
36 {
37 namespace training
38 {
39 
40 namespace interface1
41 {
51 template<typename algorithmFPType, Method method, CpuType cpu>
52 class 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::Input InputType;
86  typedef algorithms::implicit_als::Parameter ParameterType;
87  typedef algorithms::implicit_als::training::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  training::ResultPtr _result;
148 
149  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
150  {
151  return new Batch<algorithmFPType, method>(*this);
152  }
153 
154  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
155  {
156  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int) method);
157  _res = _result.get();
158  return s;
159  }
160 
161  void initialize()
162  {
163  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
164  _in = &input;
165  _par = &parameter;
166  _result = training::ResultPtr(new ResultType());
167  }
168 };
170 } // namespace interface1
171 using interface1::BatchContainer;
172 using interface1::Batch;
173 
174 }
175 }
176 }
177 }
178 
179 #endif
daal::algorithms::implicit_als::training::interface1::Batch::input
InputType input
Definition: implicit_als_training_batch.h:89
daal::algorithms::implicit_als::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: implicit_als_training_batch.h:141
daal::batch
Definition: daal_defines.h:112
daal::algorithms::implicit_als::training::interface1::Batch::parameter
ParameterType parameter
Definition: implicit_als_training_batch.h:90
daal::algorithms::implicit_als::training::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::implicit_als::training::interface1::BatchContainer::~BatchContainer
~BatchContainer()
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::implicit_als::training::interface1::BatchContainer::compute
services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::implicit_als::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: implicit_als_training_batch.h:104
daal::algorithms::implicit_als::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: implicit_als_training_batch.h:119
daal::algorithms::implicit_als::training::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: implicit_als_training_batch.h:128
daal::algorithms::Training
Provides methods to train models that depend on the data provided. For example, these methods enable ...
Definition: training.h:62
daal::algorithms::implicit_als::training::interface1::BatchContainer
Provides methods to run implementations of implicit ALS model-based training.
Definition: implicit_als_training_batch.h:52
daal::algorithms::implicit_als::training::interface1::Batch
Algorithm class for training the implicit ALS model.
Definition: implicit_als_training_batch.h:82
daal::algorithms::implicit_als::training::interface1::Batch::Batch
Batch()
Definition: implicit_als_training_batch.h:93
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:52
daal::algorithms::implicit_als::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_batch.h:113

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