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

sgd_batch.h
1 /* file: sgd_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the interface for the stochastic gradient descent (SGD) algorithm
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __SGD_BATCH_H__
50 #define __SGD_BATCH_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/optimization_solver/iterative_solver/iterative_solver_batch.h"
56 #include "sgd_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace optimization_solver
63 {
64 namespace sgd
65 {
66 namespace interface1
67 {
81 template<typename algorithmFPType, Method method, CpuType cpu>
82 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
83 {
84 public:
90  BatchContainer(daal::services::Environment::env *daalEnv);
92  ~BatchContainer();
98  virtual services::Status compute() DAAL_C11_OVERRIDE;
99 };
100 
118 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
119 class DAAL_EXPORT Batch : public iterative_solver::Batch
120 {
121 public:
122  Input input;
123  Parameter<method> parameter;
129  Batch(const sum_of_functions::BatchPtr& objectiveFunction = sum_of_functions::BatchPtr()) :
130  input(),
131  parameter(objectiveFunction)
132  {
133  initialize();
134  }
135 
142  Batch(const Batch<algorithmFPType, method> &other) :
143  iterative_solver::Batch(other),
144  input(other.input),
145  parameter(other.parameter)
146  {
147  initialize();
148  }
149 
154  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
155 
160  virtual iterative_solver::Input * getInput() DAAL_C11_OVERRIDE { return &input; }
161 
166  virtual iterative_solver::Parameter * getParameter() DAAL_C11_OVERRIDE { return &parameter; }
167 
173  virtual services::Status createResult() DAAL_C11_OVERRIDE
174  {
175  _result = iterative_solver::ResultPtr(new sgd::Result());
176  _res = NULL;
177  return services::Status();
178  }
179 
185  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
186  {
187  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
188  }
189 
190 protected:
191  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
192  {
193  return new Batch<algorithmFPType, method>(*this);
194  }
195 
196  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
197  {
198  services::Status s = static_cast<Result*>(_result.get())->allocate<algorithmFPType>(&input, &parameter, (int)method);
199  _res = _result.get();
200  return s;
201  }
202 
203  void initialize()
204  {
205  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
206  _par = &parameter;
207  _in = &input;
208  _result = iterative_solver::ResultPtr(new sgd::Result());
209  }
210 };
212 } // namespace interface1
213 using interface1::BatchContainer;
214 using interface1::Batch;
215 
216 } // namespace sgd
217 } // namespace optimization_solver
218 } // namespace algorithm
219 } // namespace daal
220 #endif
daal::algorithms::optimization_solver::sgd::interface1::Batch::Batch
Batch(const sum_of_functions::BatchPtr &objectiveFunction=sum_of_functions::BatchPtr())
Definition: sgd_batch.h:129
daal
Definition: algorithm_base_common.h:57
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::optimization_solver::sgd::interface1::Parameter
Definition: sgd_types.h:156
daal::algorithms::optimization_solver::sgd::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: sgd_batch.h:154
daal::algorithms::optimization_solver::sgd::interface1::Input
Input for the Stochastic gradient descent algorithm
Definition: sgd_types.h:310
daal::algorithms::optimization_solver::sgd::interface1::Batch::getParameter
virtual iterative_solver::Parameter * getParameter() DAAL_C11_OVERRIDE
Definition: sgd_batch.h:166
daal_defines.h
daal::batch
Definition: daal_defines.h:131
daal::algorithms::optimization_solver::sgd::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: sgd_batch.h:142
daal::algorithms::optimization_solver::sgd::interface1::BatchContainer
Provides methods to run implementations of the stochastic gradient descent algorithm. This class is associated with daal::algorithms::optimization_solver::sgd::BatchContainer class.
Definition: sgd_batch.h:82
daal::algorithms::optimization_solver::sgd::interface1::Batch::parameter
Parameter< method > parameter
Definition: sgd_batch.h:123
daal::algorithms::optimization_solver::sgd::interface1::Batch::input
Input input
Definition: sgd_batch.h:122
daal::algorithms::optimization_solver::sgd::interface1::Batch
Computes Stochastic gradient descent in the batch processing mode.
Definition: sgd_batch.h:119
daal::algorithms::optimization_solver::sgd::interface1::Batch::getInput
virtual iterative_solver::Input * getInput() DAAL_C11_OVERRIDE
Definition: sgd_batch.h:160
daal::algorithms::optimization_solver::sgd::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: sgd_batch.h:185
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::optimization_solver::sgd::interface1::Batch::createResult
virtual services::Status createResult() DAAL_C11_OVERRIDE
Definition: sgd_batch.h:173
daal::algorithms::optimization_solver::iterative_solver::interface1::Batch
Interface for computing the iterative solver in the batch processing mode.
Definition: iterative_solver_batch.h:78
daal::algorithms::kmeans::objectiveFunction
Definition: kmeans_types.h:133

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