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

low_order_moments_online.h
1 /* file: low_order_moments_online.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 low order moments algorithm in the
45 // online processing mode
46 //--
47 */
48 
49 #ifndef __LOW_ORDER_MOMENTS_ONLINE_H__
50 #define __LOW_ORDER_MOMENTS_ONLINE_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "services/daal_defines.h"
54 #include "algorithms/moments/low_order_moments_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace low_order_moments
61 {
62 
63 namespace interface1
64 {
79 template<typename algorithmFPType, Method method, CpuType cpu>
80 class DAAL_EXPORT OnlineContainer : public daal::algorithms::AnalysisContainerIface<online>
81 {
82 public:
88  OnlineContainer(daal::services::Environment::env *daalEnv);
90  virtual ~OnlineContainer();
95  virtual services::Status compute() DAAL_C11_OVERRIDE;
100  virtual services::Status finalizeCompute() DAAL_C11_OVERRIDE;
101 };
102 
117 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
118 class DAAL_EXPORT Online : public daal::algorithms::Analysis<online>
119 {
120 public:
121  typedef algorithms::low_order_moments::Input InputType;
122  typedef algorithms::low_order_moments::Parameter ParameterType;
123  typedef algorithms::low_order_moments::Result ResultType;
124  typedef algorithms::low_order_moments::PartialResult PartialResultType;
125 
126  InputType input;
127  ParameterType parameter;
130  Online()
131  {
132  initialize();
133  }
134 
141  Online(const Online<algorithmFPType, method> &other) : parameter(other.parameter), input(other.input)
142  {
143  initialize();
144  }
145 
150  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
151 
156  ResultPtr getResult()
157  {
158  return _result;
159  }
160 
165  services::Status setResult(const ResultPtr &result)
166  {
167  DAAL_CHECK(result, services::ErrorNullResult)
168  _result = result;
169  _res = _result.get();
170  return services::Status();
171  }
172 
177  PartialResultPtr getPartialResult()
178  {
179  return _partialResult;
180  }
181 
187  services::Status setPartialResult(const PartialResultPtr &partialResult, bool initFlag = false)
188  {
189  _partialResult = partialResult;
190  _pres = _partialResult.get();
191  setInitFlag(initFlag);
192  return services::Status();
193  }
194 
200  services::SharedPtr<Online<algorithmFPType, method> > clone() const
201  {
202  return services::SharedPtr<Online<algorithmFPType, method> >(cloneImpl());
203  }
204 
205 protected:
206  virtual Online<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
207  {
208  return new Online<algorithmFPType, method>(*this);
209  }
210 
211  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
212  {
213  services::Status s = _result->allocate<algorithmFPType>(_in, 0, 0);
214  _res = _result.get();
215  _pres = _partialResult.get();
216  return s;
217  }
218 
219  virtual services::Status allocatePartialResult() DAAL_C11_OVERRIDE
220  {
221  services::Status s = _partialResult->allocate<algorithmFPType>(_in, 0, 0);
222  _pres = _partialResult.get();
223  return s;
224  }
225 
226  virtual services::Status initializePartialResult() DAAL_C11_OVERRIDE
227  {
228  services::Status s = _partialResult->initialize<algorithmFPType>(_in, 0, 0);
229  _pres = _partialResult.get();
230  return s;
231  }
232 
233  void initialize()
234  {
235  Analysis<online>::_ac = new __DAAL_ALGORITHM_CONTAINER(online, OnlineContainer, algorithmFPType, method)(&_env);
236  _in = &input;
237  _par = &parameter;
238  _result.reset(new ResultType());
239  _partialResult.reset(new PartialResultType());
240  }
241 
242 private:
243  PartialResultPtr _partialResult;
244  ResultPtr _result;
245 };
247 } // namespace interface1
248 using interface1::OnlineContainer;
249 using interface1::Online;
250 
251 } // namespace daal::algorithms::low_order_moments
252 }
253 }
254 #endif
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::low_order_moments::interface1::Online::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: low_order_moments_online.h:150
daal::algorithms::low_order_moments::interface1::Online::setPartialResult
services::Status setPartialResult(const PartialResultPtr &partialResult, bool initFlag=false)
Definition: low_order_moments_online.h:187
daal::algorithms::low_order_moments::interface1::Online::setResult
services::Status setResult(const ResultPtr &result)
Definition: low_order_moments_online.h:165
daal::algorithms::low_order_moments::interface1::Online::input
InputType input
Definition: low_order_moments_online.h:126
daal::algorithms::low_order_moments::interface1::Online
Computes moments of low order in the online processing mode.
Definition: low_order_moments_online.h:118
daal::algorithms::low_order_moments::interface1::OnlineContainer
Provides methods to run implementations of the low order moments algorithm. This class is associated ...
Definition: low_order_moments_online.h:80
daal::algorithms::low_order_moments::interface1::Result
Provides methods to access final results obtained with the compute() method of the low order moments ...
Definition: low_order_moments_types.h:308
daal::algorithms::low_order_moments::interface1::Online::getPartialResult
PartialResultPtr getPartialResult()
Definition: low_order_moments_online.h:177
daal::algorithms::low_order_moments::interface1::Online::getResult
ResultPtr getResult()
Definition: low_order_moments_online.h:156
daal_defines.h
daal::algorithms::low_order_moments::interface1::Online::Online
Online(const Online< algorithmFPType, method > &other)
Definition: low_order_moments_online.h:141
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::low_order_moments::interface1::Online::clone
services::SharedPtr< Online< algorithmFPType, method > > clone() const
Definition: low_order_moments_online.h:200
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::low_order_moments::interface1::Parameter
Low order moments algorithm parameters.
Definition: low_order_moments_types.h:293
daal::algorithms::low_order_moments::interface1::Online::Online
Online()
Definition: low_order_moments_online.h:130
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::low_order_moments::interface1::Online::parameter
ParameterType parameter
Definition: low_order_moments_online.h:127
daal::online
Definition: daal_defines.h:134
daal::algorithms::low_order_moments::interface1::Input
Input objects for the low order moments algorithm
Definition: low_order_moments_types.h:173
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::low_order_moments::interface1::PartialResult
Provides methods to access partial results obtained with the compute() method of the low order moment...
Definition: low_order_moments_types.h:211

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