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

iterative_solver_batch.h
1 /* file: iterative_solver_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 iterative solver interface interface.
45 //--
46 */
47 
48 #ifndef __ITERATIVE_SOLVER_BATCH_H__
49 #define __ITERATIVE_SOLVER_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "services/daal_defines.h"
54 #include "algorithms/optimization_solver/optimization_solver_batch.h"
55 #include "algorithms/optimization_solver/iterative_solver/iterative_solver_types.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace optimization_solver
62 {
63 namespace iterative_solver
64 {
68 namespace interface1
69 {
78 class DAAL_EXPORT Batch : public optimization_solver::BatchIface
79 {
80 public:
81  typedef algorithms::optimization_solver::iterative_solver::Input InputType;
82  typedef algorithms::optimization_solver::iterative_solver::Parameter ParameterType;
83  typedef algorithms::optimization_solver::iterative_solver::Result ResultType;
84 
85  Batch()
86  {
87  }
88 
95  Batch(const Batch &other)
96  {
97  }
98 
99  virtual ~Batch() {}
100 
105  virtual InputType * getInput() = 0;
106 
111  virtual ParameterType * getParameter() = 0;
112 
117  ResultPtr getResult()
118  {
119  return _result;
120  }
121 
127  virtual services::Status createResult() = 0;
128 
134  services::SharedPtr<Batch> clone() const
135  {
136  return services::SharedPtr<Batch>(cloneImpl());
137  }
138 
139 protected:
140  virtual Batch *cloneImpl() const DAAL_C11_OVERRIDE = 0;
141 
142  ResultPtr _result;
143 };
145 } // namespace interface1
146 typedef interface1::Batch Batch;
147 
148 } // namespace optimization_solver
149 } // namespace iterative_solver
150 } // namespace algorithm
151 } // namespace daal
152 #endif
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::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::iterative_solver::interface1::Batch::getResult
ResultPtr getResult()
Definition: iterative_solver_batch.h:117
daal_defines.h
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::interface1::BatchIface
Interface for computing the Optimization solver in the batch processing mode.
Definition: optimization_solver_batch.h:74
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::iterative_solver::interface1::Batch::clone
services::SharedPtr< Batch > clone() const
Definition: iterative_solver_batch.h:134
daal::algorithms::optimization_solver::iterative_solver::interface1::Batch::Batch
Batch(const Batch &other)
Definition: iterative_solver_batch.h:95

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