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

engine.h
1 /* file: engine.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 engine.
45 //--
46 */
47 
48 #ifndef __ENGINE_H__
49 #define __ENGINE_H__
50 
51 #include "algorithms/engines/engine_types.h"
52 
53 namespace daal
54 {
55 namespace algorithms
56 {
57 namespace engines
58 {
63 namespace interface1
64 {
69 class DAAL_EXPORT BatchBase : public daal::algorithms::Analysis<batch>
70 {
71 public:
72  typedef algorithms::engines::Input InputType;
73  typedef algorithms::engines::Result ResultType;
74 
75  InputType input;
77  BatchBase() {}
78  virtual ~BatchBase() {}
79 
86  services::Status saveState(byte* dest) const
87  {
88  return saveStateImpl(dest);
89  }
90 
97  services::Status loadState(const byte* src)
98  {
99  return loadStateImpl(src);
100  }
101 
109  services::Status leapfrog(size_t threadIdx, size_t nThreads)
110  {
111  return leapfrogImpl(threadIdx, nThreads);
112  }
113 
120  services::Status skipAhead(size_t nSkip)
121  {
122  return skipAheadImpl(nSkip);
123  }
124 
130  services::SharedPtr<BatchBase> clone() const
131  {
132  return services::SharedPtr<BatchBase>(cloneImpl());
133  }
134 
135 protected:
136  virtual services::Status saveStateImpl(byte* dest) const { return services::Status(); }
137  virtual services::Status loadStateImpl(const byte* src) { return services::Status(); }
138  virtual services::Status leapfrogImpl(size_t threadNum, size_t nThreads) { return services::Status(services::ErrorMethodNotSupported); }
139  virtual services::Status skipAheadImpl(size_t nSkip) { return services::Status(); }
140  virtual BatchBase *cloneImpl() const = 0;
141 };
142 typedef services::SharedPtr<BatchBase> EnginePtr;
143 
144 } // namespace interface1
145 using interface1::BatchBase;
146 using interface1::EnginePtr;
148 } // namespace engines
149 } // namespace algorithms
150 } // namespace daal
151 #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::engines::interface1::BatchBase::clone
services::SharedPtr< BatchBase > clone() const
Definition: engine.h:130
daal::algorithms::engines::interface1::Input
Input objects for engines
Definition: engine_types.h:98
daal::algorithms::engines::interface1::BatchBase::loadState
services::Status loadState(const byte *src)
Definition: engine.h:97
daal::algorithms::engines::interface1::BatchBase
Class representing an engine.
Definition: engine.h:69
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::engines::interface1::BatchBase::leapfrog
services::Status leapfrog(size_t threadIdx, size_t nThreads)
Definition: engine.h:109
daal::algorithms::engines::interface1::Result
Provides methods to access the result obtained with the compute() method of the engine.
Definition: engine_types.h:138
daal::algorithms::engines::interface1::BatchBase::skipAhead
services::Status skipAhead(size_t nSkip)
Definition: engine.h:120
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::engines::interface1::BatchBase::input
InputType input
Definition: engine.h:75
daal::algorithms::engines::interface1::BatchBase::saveState
services::Status saveState(byte *dest) const
Definition: engine.h:86
daal::services::ErrorMethodNotSupported
Definition: error_indexes.h:95

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