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

lbfgs_batch.h
1 /* file: lbfgs_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 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 limited-memory Broyden-Fletcher-Goldfarb-Shanno
45 // (BFGS) algorithm in the batch processing mode
46 //--
47 */
48 
49 #ifndef __LBFGS_BATCH_H__
50 #define __LBFGS_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 "lbfgs_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace optimization_solver
63 {
64 namespace lbfgs
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  typedef algorithms::optimization_solver::lbfgs::Input InputType;
123  typedef algorithms::optimization_solver::lbfgs::Parameter ParameterType;
124  typedef algorithms::optimization_solver::lbfgs::Result ResultType;
125 
126  InputType input;
127  ParameterType parameter;
133  Batch(const sum_of_functions::BatchPtr& objectiveFunction = sum_of_functions::BatchPtr()) :
134  input(),
135  parameter(objectiveFunction)
136  {
137  initialize();
138  }
139 
145  Batch(const Batch<algorithmFPType, method> &other) :
146  iterative_solver::Batch(other),
147  input(other.input),
148  parameter(other.parameter)
149  {
150  initialize();
151  }
152 
157  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
158 
163  virtual iterative_solver::Input * getInput() DAAL_C11_OVERRIDE { return &input; }
164 
169  virtual iterative_solver::Parameter * getParameter() DAAL_C11_OVERRIDE { return &parameter; }
170 
176  virtual services::Status createResult() DAAL_C11_OVERRIDE
177  {
178  _result = iterative_solver::ResultPtr(new ResultType());
179  _res = NULL;
180  return services::Status();
181  }
182 
188  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
189  {
190  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
191  }
192 
193 protected:
194  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
195  {
196  return new Batch<algorithmFPType, method>(*this);
197  }
198 
199  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
200  {
201  services::Status s = static_cast<ResultType*>(_result.get())->allocate<algorithmFPType>(&input, &parameter, (int)method);
202  _res = _result.get();
203  return s;
204  }
205 
206  void initialize()
207  {
208  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
209  _par = &parameter;
210  _in = &input;
211  _result.reset(new ResultType());
212  }
213 };
215 } // namespace interface1
216 using interface1::BatchContainer;
217 using interface1::Batch;
218 
219 } // namespace lbfgs
220 } // namespace optimization_solver
221 } // namespace algorithm
222 } // namespace daal
223 
224 #endif
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::getParameter
virtual iterative_solver::Parameter * getParameter() DAAL_C11_OVERRIDE
Definition: lbfgs_batch.h:169
daal::algorithms::optimization_solver::lbfgs::interface1::Batch
Computes LBFGS in the batch processing mode.
Definition: lbfgs_batch.h:119
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::algorithms::optimization_solver::iterative_solver::interface1::Result
Results obtained with the compute() method of the iterative solver algorithm in the batch processing ...
Definition: iterative_solver_types.h:247
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::lbfgs::interface1::Batch::getInput
virtual iterative_solver::Input * getInput() DAAL_C11_OVERRIDE
Definition: lbfgs_batch.h:163
daal::algorithms::optimization_solver::lbfgs::interface1::Input
Input class for LBFGS algorithm
Definition: lbfgs_types.h:182
daal::algorithms::optimization_solver::iterative_solver::interface1::Parameter
Parameter base class for the iterative solver algorithm
Definition: iterative_solver_types.h:139
daal::algorithms::optimization_solver::iterative_solver::interface1::Input
Input parameters for the iterative solver algorithm
Definition: iterative_solver_types.h:184
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: lbfgs_batch.h:145
daal::algorithms::optimization_solver::lbfgs::interface1::BatchContainer
Provides methods to run implementations of the LBFGS algorithm. This class is associated with daal::a...
Definition: lbfgs_batch.h:82
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::parameter
ParameterType parameter
Definition: lbfgs_batch.h:127
daal_defines.h
daal::batch
Definition: daal_defines.h:132
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: lbfgs_batch.h:157
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::createResult
virtual services::Status createResult() DAAL_C11_OVERRIDE
Definition: lbfgs_batch.h:176
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::Batch
Batch(const sum_of_functions::BatchPtr &objectiveFunction=sum_of_functions::BatchPtr())
Definition: lbfgs_batch.h:133
daal::algorithms::optimization_solver::lbfgs::interface1::Result
Results obtained with the compute() method of the LBFGS algorithm in the batch processing mode...
Definition: lbfgs_types.h:220
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::iterative_solver::interface1::Batch
Interface for computing the iterative solver in the batch processing mode.
Definition: iterative_solver_batch.h:78
daal::algorithms::optimization_solver::lbfgs::interface1::Parameter
Parameter class for LBFGS algorithm
Definition: lbfgs_types.h:128
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::input
InputType input
Definition: lbfgs_batch.h:126
daal::algorithms::optimization_solver::lbfgs::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: lbfgs_batch.h:188

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