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

mcg59.h
1 /* file: mcg59.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 Mersenne Twister engine in the batch processing mode
45 //--
46 */
47 
48 #ifndef __MCG59_H__
49 #define __MCG59_H__
50 
51 #include "algorithms/engines/mcg59/mcg59_types.h"
52 #include "algorithms/engines/engine.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace engines
59 {
60 namespace mcg59
61 {
67 namespace interface1
68 {
79 template<typename algorithmFPType, Method method, CpuType cpu>
80 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
81 {
82 public:
88  BatchContainer(daal::services::Environment::env *daalEnv);
89  ~BatchContainer();
95  services::Status compute() DAAL_C11_OVERRIDE;
96 };
97 
112 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
113 class DAAL_EXPORT Batch : public engines::BatchBase
114 {
115 public:
116  typedef engines::BatchBase super;
117 
118  typedef typename super::InputType InputType;
119  typedef typename super::ResultType ResultType;
120 
127  static services::SharedPtr<Batch<algorithmFPType, method> > create(size_t seed = 777);
128 
133  virtual int getMethod() const DAAL_C11_OVERRIDE { return (int)method; }
134 
139  ResultPtr getResult() { return _result; }
140 
147  services::Status setResult(const ResultPtr& result)
148  {
149  DAAL_CHECK(result, services::ErrorNullResult)
150  _result = result;
151  _res = _result.get();
152  return services::Status();
153  }
154 
160  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
161  {
162  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
163  }
164 
170  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
171  {
172  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), NULL, (int) method);
173  this->_res = this->_result.get();
174  return s;
175  }
176 
177 protected:
178  Batch(size_t seed = 777)
179  {
180  initialize();
181  }
182 
183  Batch(const Batch<algorithmFPType, method> &other): super(other)
184  {
185  initialize();
186  }
187 
188  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
189  {
190  return new Batch<algorithmFPType, method>(*this);
191  }
192 
193  void initialize()
194  {
195  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
196  _in = &input;
197  _result.reset(new ResultType());
198  }
199 
200 private:
201  ResultPtr _result;
202 };
203 typedef services::SharedPtr<Batch<> > mcg59Ptr;
204 typedef services::SharedPtr<const Batch<> > mcg59ConstPtr;
205 
206 } // namespace interface1
207 using interface1::BatchContainer;
208 using interface1::Batch;
209 using interface1::mcg59Ptr;
210 using interface1::mcg59ConstPtr;
212 } // namespace mcg59
213 } // namespace engines
214 } // namespace algorithms
215 } // namespace daal
216 #endif
daal::algorithms::engines::mcg59::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: mcg59.h:170
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::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::engines::interface1::Input
Input objects for engines
Definition: engine_types.h:98
daal::batch
Definition: daal_defines.h:132
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::mcg59::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: mcg59.h:147
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::mcg59::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: mcg59.h:133
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::mcg59::interface1::Batch
Provides methods for mcg59 engine computations in the batch processing mode.
Definition: mcg59.h:113
daal::algorithms::engines::mcg59::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: mcg59.h:160
daal::algorithms::engines::mcg59::interface1::BatchContainer
Provides methods to run implementations of the mcg59 engine. This class is associated with the mcg59:...
Definition: mcg59.h:80
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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