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

covariance_online.h
1 /* file: covariance_online.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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 correlation or variance-covariance
45 // matrix algorithm in the online processing mode
46 //--
47 */
48 
49 #ifndef __COVARIANCE_ONLINE_H__
50 #define __COVARIANCE_ONLINE_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/covariance/covariance_types.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace covariance
62 {
63 
64 namespace interface1
65 {
79 class OnlineContainerIface : public daal::algorithms::AnalysisContainerIface<online>
80 {
81 public:
82  OnlineContainerIface() {};
83  virtual ~OnlineContainerIface() {}
84 
89  virtual services::Status compute() = 0;
90 
95  virtual services::Status finalizeCompute() = 0;
96 };
97 
106 template<typename algorithmFPType, Method method, CpuType cpu>
107 class DAAL_EXPORT OnlineContainer
108 {};
109 
118 template<typename algorithmFPType, CpuType cpu>
119 class DAAL_EXPORT OnlineContainer<algorithmFPType, defaultDense, cpu> : public OnlineContainerIface
120 {
121 public:
127  OnlineContainer(daal::services::Environment::env *daalEnv);
129  virtual ~OnlineContainer();
130 
135  virtual services::Status compute() DAAL_C11_OVERRIDE;
140  virtual services::Status finalizeCompute() DAAL_C11_OVERRIDE;
141 };
142 
151 template<typename algorithmFPType, CpuType cpu>
152 class DAAL_EXPORT OnlineContainer<algorithmFPType, singlePassDense, cpu> : public OnlineContainerIface
153 {
154 public:
160  OnlineContainer(daal::services::Environment::env *daalEnv);
162  virtual ~OnlineContainer();
163 
168  virtual services::Status compute() DAAL_C11_OVERRIDE;
173  virtual services::Status finalizeCompute() DAAL_C11_OVERRIDE;
174 };
175 
184 template<typename algorithmFPType, CpuType cpu>
185 class DAAL_EXPORT OnlineContainer<algorithmFPType, sumDense, cpu> : public OnlineContainerIface
186 {
187 public:
193  OnlineContainer(daal::services::Environment::env *daalEnv);
195  virtual ~OnlineContainer();
196 
201  virtual services::Status compute() DAAL_C11_OVERRIDE;
206  virtual services::Status finalizeCompute() DAAL_C11_OVERRIDE;
207 };
208 
217 template<typename algorithmFPType, CpuType cpu>
218 class DAAL_EXPORT OnlineContainer<algorithmFPType, fastCSR, cpu> : public OnlineContainerIface
219 {
220 public:
226  OnlineContainer(daal::services::Environment::env *daalEnv);
228  virtual ~OnlineContainer();
229 
234  virtual services::Status compute() DAAL_C11_OVERRIDE;
239  virtual services::Status finalizeCompute() DAAL_C11_OVERRIDE;
240 };
241 
250 template<typename algorithmFPType, CpuType cpu>
251 class DAAL_EXPORT OnlineContainer<algorithmFPType, singlePassCSR, cpu> : public OnlineContainerIface
252 {
253 public:
259  OnlineContainer(daal::services::Environment::env *daalEnv);
261  virtual ~OnlineContainer();
262 
267  virtual services::Status compute() DAAL_C11_OVERRIDE;
272  virtual services::Status finalizeCompute() DAAL_C11_OVERRIDE;
273 };
274 
283 template<typename algorithmFPType, CpuType cpu>
284 class DAAL_EXPORT OnlineContainer<algorithmFPType, sumCSR, cpu> : public OnlineContainerIface
285 {
286 public:
292  OnlineContainer(daal::services::Environment::env *daalEnv);
294  virtual ~OnlineContainer();
295 
300  virtual services::Status compute() DAAL_C11_OVERRIDE;
305  virtual services::Status finalizeCompute() DAAL_C11_OVERRIDE;
306 };
307 
313 class DAAL_EXPORT OnlineImpl : public daal::algorithms::Analysis<online>
314 {
315 public:
317  OnlineImpl()
318  {
319  initialize();
320  }
321 
329  OnlineImpl(const OnlineImpl &other) : input(other.input), parameter(other.parameter)
330  {
331  initialize();
332  }
333 
334  virtual ~OnlineImpl() {}
335 
340  ResultPtr getResult()
341  {
342  return _result;
343  }
344 
349  virtual services::Status setResult(const ResultPtr &result)
350  {
351  DAAL_CHECK(result, services::ErrorNullResult)
352  _result = result;
353  _res = _result.get();
354  return services::Status();
355  }
356 
361  PartialResultPtr getPartialResult()
362  {
363  return _partialResult;
364  }
365 
371  virtual services::Status setPartialResult(const PartialResultPtr &partialResult, bool initFlag = false)
372  {
373  DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
374  _partialResult = partialResult;
375  _pres = _partialResult.get();
376  setInitFlag(initFlag);
377  return services::Status();
378  }
379 
386  services::SharedPtr<OnlineImpl> clone() const
387  {
388  return services::SharedPtr<OnlineImpl>(cloneImpl());
389  }
390 
391  Input input;
392  OnlineParameter parameter;
394 protected:
395  void initialize()
396  {
397  _in = &input;
398  _par = &parameter;
399  _result.reset(new Result());
400  _partialResult.reset(new PartialResult());
401  }
402 
403  virtual OnlineImpl * cloneImpl() const DAAL_C11_OVERRIDE = 0;
404 
405  PartialResultPtr _partialResult;
406  ResultPtr _result;
407 };
408 
409 
430 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
431 class DAAL_EXPORT Online : public OnlineImpl
432 {
433 public:
435  Online()
436  {
437  initialize();
438  }
439 
447  Online(const Online<algorithmFPType, method> &other) : OnlineImpl(other)
448  {
449  initialize();
450  }
451 
452  virtual ~Online() {}
453 
458  virtual int getMethod() const DAAL_C11_OVERRIDE { return (int)method; }
459 
466  services::SharedPtr<Online<algorithmFPType, method> > clone() const
467  {
468  return services::SharedPtr<Online<algorithmFPType, method> >(cloneImpl());
469  }
470 
471 protected:
472  virtual Online<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
473  {
474  return new Online<algorithmFPType, method>(*this);
475  }
476 
477  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
478  {
479  services::Status s = _result->allocate<algorithmFPType>(_partialResult.get(), _par, (int)method);
480  _res = _result.get();
481  _pres = _partialResult.get();
482  return services::Status();
483  }
484 
485  virtual services::Status allocatePartialResult() DAAL_C11_OVERRIDE
486  {
487  services::Status s = _partialResult->allocate<algorithmFPType>(&input, _par, (int)method);
488  _pres = _partialResult.get();
489  return s;
490  }
491 
492  virtual services::Status initializePartialResult() DAAL_C11_OVERRIDE
493  {
494  services::Status s = _partialResult->initialize<algorithmFPType>(&input, _par, (int)method);
495  _pres = _partialResult.get();
496  return services::Status();
497  }
498 
499  void initialize()
500  {
501  this->_ac = new __DAAL_ALGORITHM_CONTAINER(online, OnlineContainer, algorithmFPType, method)(&_env);
502  }
503 };
505 } // namespace interface1
506 using interface1::OnlineContainerIface;
507 using interface1::OnlineContainer;
508 using interface1::OnlineImpl;
509 using interface1::Online;
510 
511 } // namespace daal::algorithms::covariance
512 } // namespace daal::algorithms
513 } // namespace daal
514 #endif
daal::algorithms::covariance::singlePassCSR
Definition: covariance_types.h:80
daal::algorithms::covariance::interface1::OnlineParameter
Parameters of the correlation or variance-covariance matrix algorithm in the online processing mode...
Definition: covariance_types.h:295
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::covariance::interface1::OnlineContainer
Provides methods to run implementations of the correlation or variance-covariance matrix algorithm...
Definition: covariance_online.h:107
daal::algorithms::covariance::interface1::OnlineImpl::parameter
OnlineParameter parameter
Definition: covariance_online.h:392
daal::algorithms::covariance::interface1::OnlineImpl::setPartialResult
virtual services::Status setPartialResult(const PartialResultPtr &partialResult, bool initFlag=false)
Definition: covariance_online.h:371
daal::services::ErrorNullPartialResult
Definition: error_indexes.h:131
daal::algorithms::covariance::interface1::OnlineImpl::setResult
virtual services::Status setResult(const ResultPtr &result)
Definition: covariance_online.h:349
daal::algorithms::covariance::interface1::OnlineImpl::OnlineImpl
OnlineImpl(const OnlineImpl &other)
Definition: covariance_online.h:329
daal::algorithms::covariance::interface1::OnlineContainerIface
Class that spcifies interfaces of implementations of the correlation or variance-covariance matrix al...
Definition: covariance_online.h:79
daal::algorithms::covariance::interface1::OnlineImpl
Abstract class that specifies interface of the algorithms for computing correlation or variance-covar...
Definition: covariance_online.h:313
daal::algorithms::covariance::interface1::Online::Online
Online(const Online< algorithmFPType, method > &other)
Definition: covariance_online.h:447
daal::algorithms::covariance::Method
Method
Definition: covariance_types.h:72
daal::algorithms::covariance::interface1::Online::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: covariance_online.h:458
daal::algorithms::covariance::interface1::Online
Computes correlation or variance-covariance matrix in the online processing mode. ...
Definition: covariance_online.h:431
daal::algorithms::covariance::interface1::OnlineContainerIface::compute
virtual services::Status compute()=0
daal::algorithms::covariance::interface1::Input
Input objects of the correlation or variance-covariance matrix algorithm
Definition: covariance_types.h:162
daal_defines.h
daal::algorithms::covariance::sumDense
Definition: covariance_types.h:77
daal::algorithms::covariance::fastCSR
Definition: covariance_types.h:79
daal::algorithms::covariance::interface1::Result
Provides methods to access final results obtained with the compute() method of the correlation or var...
Definition: covariance_types.h:317
daal::algorithms::covariance::sumCSR
Definition: covariance_types.h:82
daal::algorithms::covariance::interface1::PartialResult
Provides methods to access partial results obtained with the compute() method of the correlation or v...
Definition: covariance_types.h:204
daal::algorithms::covariance::interface1::Online::Online
Online()
Definition: covariance_online.h:435
daal::algorithms::covariance::interface1::OnlineImpl::input
Input input
Definition: covariance_online.h:391
daal::algorithms::covariance::interface1::OnlineImpl::OnlineImpl
OnlineImpl()
Definition: covariance_online.h:317
daal::algorithms::covariance::interface1::OnlineImpl::getPartialResult
PartialResultPtr getPartialResult()
Definition: covariance_online.h:361
daal::algorithms::covariance::interface1::OnlineContainerIface::finalizeCompute
virtual services::Status finalizeCompute()=0
daal::algorithms::covariance::interface1::OnlineImpl::clone
services::SharedPtr< OnlineImpl > clone() const
Definition: covariance_online.h:386
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::covariance::covariance
Definition: covariance_types.h:114
daal::online
Definition: daal_defines.h:133
daal::algorithms::covariance::defaultDense
Definition: covariance_types.h:74
daal::algorithms::covariance::interface1::Online::clone
services::SharedPtr< Online< algorithmFPType, method > > clone() const
Definition: covariance_online.h:466
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::covariance::singlePassDense
Definition: covariance_types.h:75
daal::algorithms::covariance::interface1::OnlineImpl::getResult
ResultPtr getResult()
Definition: covariance_online.h:340

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