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

adagrad_batch.h
1 /* file: adagrad_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 adaptive gradient descent (Adagrad) algorithm
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __ADAGRAD_BATCH_H__
26 #define __ADAGRAD_BATCH_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "data_management/data/numeric_table.h"
30 #include "services/daal_defines.h"
31 #include "algorithms/optimization_solver/iterative_solver/iterative_solver_batch.h"
32 #include "adagrad_types.h"
33 
34 namespace daal
35 {
36 namespace algorithms
37 {
38 namespace optimization_solver
39 {
40 namespace adagrad
41 {
42 namespace interface1
43 {
57 template<typename algorithmFPType, Method method, CpuType cpu>
58 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
59 {
60 public:
66  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
68  DAAL_DEPRECATED ~BatchContainer();
74  DAAL_DEPRECATED_VIRTUAL virtual services::Status compute() DAAL_C11_OVERRIDE;
75 };
76 
91 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
92 class DAAL_EXPORT Batch : public iterative_solver::interface1::Batch
93 {
94 public:
95  typedef algorithms::optimization_solver::adagrad::interface1::Input InputType;
96  typedef algorithms::optimization_solver::adagrad::interface1::Parameter ParameterType;
97  typedef algorithms::optimization_solver::adagrad::interface1::Result ResultType;
98 
99  InputType input;
100  ParameterType parameter;
103  DAAL_DEPRECATED Batch(sum_of_functions::interface1::BatchPtr objectiveFunction = sum_of_functions::interface1::BatchPtr()) :
104  parameter(objectiveFunction)
105  {
106  initialize();
107  }
108 
115  DAAL_DEPRECATED Batch(const Batch<algorithmFPType, method> &other) :
116  iterative_solver::interface1::Batch(other),
117  input(other.input),
118  parameter(other.parameter)
119  {
120  initialize();
121  }
122 
127  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
128 
133  DAAL_DEPRECATED_VIRTUAL virtual iterative_solver::interface1::Input * getInput() DAAL_C11_OVERRIDE { return &input; }
134 
139  DAAL_DEPRECATED_VIRTUAL virtual iterative_solver::interface1::Parameter * getParameter() DAAL_C11_OVERRIDE { return &parameter; }
140 
146  DAAL_DEPRECATED_VIRTUAL virtual services::Status createResult() DAAL_C11_OVERRIDE
147  {
148  _result = iterative_solver::interface1::ResultPtr(new ResultType());
149  _res = NULL;
150  return services::Status();
151  }
152 
158  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
159  {
160  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
161  }
162 
167  DAAL_DEPRECATED static services::SharedPtr<Batch<algorithmFPType, method> > create();
168 
169 protected:
170  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
171  {
172  return new Batch<algorithmFPType, method>(*this);
173  }
174 
175  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
176  {
177  services::Status s = static_cast<ResultType*>(_result.get())->allocate<algorithmFPType>(&input, &parameter, (int)method);
178  _res = _result.get();
179  return s;
180  }
181 
182  void initialize()
183  {
184  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
185  _par = &parameter;
186  _in = &input;
187  _result.reset(new ResultType());
188  }
189 };
191 } // namespace interface1
192 
193 namespace interface2
194 {
208 template<typename algorithmFPType, Method method, CpuType cpu>
209 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
210 {
211 public:
217  BatchContainer(daal::services::Environment::env *daalEnv);
219  ~BatchContainer();
225  virtual services::Status compute() DAAL_C11_OVERRIDE;
226 };
227 
242 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
243 class DAAL_EXPORT Batch : public iterative_solver::Batch
244 {
245 public:
246  typedef algorithms::optimization_solver::adagrad::Input InputType;
247  typedef algorithms::optimization_solver::adagrad::Parameter ParameterType;
248  typedef algorithms::optimization_solver::adagrad::Result ResultType;
249 
250  InputType input;
251  ParameterType parameter;
254  Batch(sum_of_functions::BatchPtr objectiveFunction = sum_of_functions::BatchPtr()) :
255  parameter(objectiveFunction)
256  {
257  initialize();
258  }
259 
266  Batch(const Batch<algorithmFPType, method> &other) :
267  iterative_solver::Batch(other),
268  input(other.input),
269  parameter(other.parameter)
270  {
271  initialize();
272  }
273 
278  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
279 
284  virtual iterative_solver::Input * getInput() DAAL_C11_OVERRIDE { return &input; }
285 
290  virtual iterative_solver::Parameter * getParameter() DAAL_C11_OVERRIDE { return &parameter; }
291 
297  virtual services::Status createResult() DAAL_C11_OVERRIDE
298  {
299  _result = iterative_solver::ResultPtr(new ResultType());
300  _res = NULL;
301  return services::Status();
302  }
303 
309  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
310  {
311  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
312  }
313 
318  static services::SharedPtr<Batch<algorithmFPType, method> > create();
319 
320 protected:
321  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
322  {
323  return new Batch<algorithmFPType, method>(*this);
324  }
325 
326  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
327  {
328  services::Status s = static_cast<ResultType*>(_result.get())->allocate<algorithmFPType>(&input, &parameter, (int)method);
329  _res = _result.get();
330  return s;
331  }
332 
333  void initialize()
334  {
335  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
336  _par = &parameter;
337  _in = &input;
338  _result.reset(new ResultType());
339  }
340 };
342 } // namespace interface2
343 using interface2::BatchContainer;
344 using interface2::Batch;
345 
346 } // namespace adagrad
347 } // namespace optimization_solver
348 } // namespace algorithm
349 } // namespace daal
350 #endif
daal::algorithms::optimization_solver::adagrad::interface2::Batch::input
InputType input
Definition: adagrad_batch.h:250
daal::algorithms::optimization_solver::adagrad::interface1::Parameter
Parameter base class for the Adaptive gradient descent algorithm
Definition: adagrad_types.h:86
daal::algorithms::optimization_solver::adagrad::interface2::Batch::createResult
virtual services::Status createResult() DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:297
daal::algorithms::optimization_solver::adagrad::interface2::BatchContainer::~BatchContainer
~BatchContainer()
daal::batch
Definition: daal_defines.h:112
daal::algorithms::optimization_solver::adagrad::interface1::Batch::input
InputType input
Definition: adagrad_batch.h:99
daal::algorithms::optimization_solver::iterative_solver::interface1::Batch
Interface for computing the iterative solver in the batch processing mode.
Definition: iterative_solver_batch.h:54
daal::algorithms::optimization_solver::adagrad::interface2::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: adagrad_batch.h:266
daal::algorithms::optimization_solver::adagrad::interface1::Batch::Batch
DAAL_DEPRECATED Batch(const Batch< algorithmFPType, method > &other)
Definition: adagrad_batch.h:115
daal::algorithms::optimization_solver::adagrad::interface1::Batch::getParameter
virtual DAAL_DEPRECATED_VIRTUAL iterative_solver::interface1::Parameter * getParameter() DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:139
daal::algorithms::optimization_solver::adagrad::interface2::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: adagrad_batch.h:309
daal::algorithms::optimization_solver::adagrad::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: adagrad_batch.h:158
daal::algorithms::optimization_solver::adagrad::interface2::Batch::Batch
Batch(sum_of_functions::BatchPtr objectiveFunction=sum_of_functions::BatchPtr())
Definition: adagrad_batch.h:254
daal::algorithms::optimization_solver::adagrad::interface2::Batch::parameter
ParameterType parameter
Definition: adagrad_batch.h:251
daal::algorithms::optimization_solver::adagrad::interface2::Batch::getParameter
virtual iterative_solver::Parameter * getParameter() DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:290
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal_defines.h
daal::algorithms::optimization_solver::adagrad::interface1::BatchContainer::compute
virtual DAAL_DEPRECATED_VIRTUAL services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::optimization_solver::adagrad::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::optimization_solver::adagrad::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:127
daal::algorithms::optimization_solver::adagrad::interface2::Batch
Computes Adaptive gradient descent in the batch processing mode.
Definition: adagrad_batch.h:243
daal::algorithms::optimization_solver::adagrad::interface1::Batch::getInput
virtual DAAL_DEPRECATED_VIRTUAL iterative_solver::interface1::Input * getInput() DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:133
daal::algorithms::optimization_solver::iterative_solver::interface1::Input
Input parameters for the iterative solver algorithm
Definition: iterative_solver_types.h:160
daal::algorithms::optimization_solver::adagrad::interface2::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:278
daal::algorithms::optimization_solver::adagrad::interface2::BatchContainer
Provides methods to run implementations of the adaptive gradient descent algorithm. This class is associated with daal::algorithms::optimization_solver::adagrad::BatchContainer class.
Definition: adagrad_batch.h:209
daal::algorithms::optimization_solver::adagrad::interface2::Batch::getInput
virtual iterative_solver::Input * getInput() DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:284
daal::algorithms::optimization_solver::adagrad::interface1::Batch
Computes Adaptive gradient descent in the batch processing mode.
Definition: adagrad_batch.h:92
daal::algorithms::optimization_solver::adagrad::interface2::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::optimization_solver::adagrad::interface1::Batch::parameter
ParameterType parameter
Definition: adagrad_batch.h:100
daal::algorithms::optimization_solver::adagrad::interface1::Batch::createResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status createResult() DAAL_C11_OVERRIDE
Definition: adagrad_batch.h:146
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::optimization_solver::adagrad::interface1::Batch::Batch
DAAL_DEPRECATED Batch(sum_of_functions::interface1::BatchPtr objectiveFunction=sum_of_functions::interface1::BatchPtr())
Definition: adagrad_batch.h:103
daal::algorithms::optimization_solver::adagrad::interface2::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::optimization_solver::adagrad::interface1::BatchContainer
Provides methods to run implementations of the adaptive gradient descent algorithm.
Definition: adagrad_batch.h:58
daal::algorithms::optimization_solver::adagrad::interface1::Input
Input class for the Adaptive gradient descent algorithm
Definition: adagrad_types.h:141
daal::algorithms::optimization_solver::iterative_solver::interface1::Parameter
Parameter base class for the iterative solver algorithm
Definition: iterative_solver_types.h:115
daal::algorithms::optimization_solver::adagrad::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::optimization_solver::adagrad::interface1::Result
Results obtained with the compute() method of the adagrad algorithm in the batch processing mode...
Definition: adagrad_types.h:180

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