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

implicit_als_training_init_batch.h
1 /* file: implicit_als_training_init_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 the implicit ALS initialization algorithm
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __IMPLICIT_ALS_TRAINING_INIT_BATCH_H__
26 #define __IMPLICIT_ALS_TRAINING_INIT_BATCH_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "algorithms/implicit_als/implicit_als_training_init_types.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace implicit_als
36 {
37 namespace training
38 {
39 namespace init
40 {
41 
42 namespace interface1
43 {
53 template<typename algorithmFPType, Method method, CpuType cpu>
54 class BatchContainer : public TrainingContainerIface<batch>
55 {
56 public:
62  BatchContainer(daal::services::Environment::env *daalEnv);
64  ~BatchContainer();
68  services::Status compute() DAAL_C11_OVERRIDE;
69 };
70 
83 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
84 class DAAL_EXPORT Batch : public daal::algorithms::Training<batch>
85 {
86 public:
87  typedef algorithms::implicit_als::training::init::Input InputType;
88  typedef algorithms::implicit_als::training::init::Parameter ParameterType;
89  typedef algorithms::implicit_als::training::init::Result ResultType;
90 
91  InputType input;
92  ParameterType parameter;
95  Batch()
96  {
97  initialize();
98  }
99 
106  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
107  {
108  initialize();
109  }
110 
115  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
116 
121  ResultPtr getResult()
122  {
123  return _result;
124  }
125 
130  services::Status setResult(const ResultPtr& res)
131  {
132  DAAL_CHECK(res, services::ErrorNullResult)
133  _result = res;
134  _res = _result.get();
135  return services::Status();
136  }
137 
143  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
144  {
145  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
146  }
147 
148 protected:
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.reset(new ResultType());
167  }
168 
169 private:
170  ResultPtr _result;
171 };
173 } // namespace interface1
174 using interface1::BatchContainer;
175 using interface1::Batch;
176 
177 }
178 }
179 }
180 }
181 }
182 
183 #endif
daal::algorithms::implicit_als::training::init::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_init_batch.h:115
daal::algorithms::implicit_als::training::init::interface1::Batch::parameter
ParameterType parameter
Definition: implicit_als_training_init_batch.h:92
daal::batch
Definition: daal_defines.h:112
daal::algorithms::implicit_als::training::init::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
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:54
daal::algorithms::implicit_als::training::init::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: implicit_als_training_init_batch.h:130
daal::algorithms::implicit_als::training::init::interface1::BatchContainer::~BatchContainer
~BatchContainer()
daal::algorithms::implicit_als::training::init::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: implicit_als_training_init_batch.h:143
daal::algorithms::implicit_als::training::init::interface1::Batch::input
InputType input
Definition: implicit_als_training_init_batch.h:91
daal::algorithms::implicit_als::training::init::interface1::Batch::getResult
ResultPtr getResult()
Definition: implicit_als_training_init_batch.h:121
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::implicit_als::training::init::interface1::BatchContainer::compute
services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::implicit_als::training::init::interface1::Batch::Batch
Batch()
Definition: implicit_als_training_init_batch.h:95
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::init::interface1::Batch
Algorithm class for initializing the implicit ALS model.
Definition: implicit_als_training_init_batch.h:84
daal::algorithms::implicit_als::training::init::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: implicit_als_training_init_batch.h:106
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:52

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