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

zscore.h
1 /* file: zscore.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 z-score normalization algorithm
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __ZSCORE_BATCH_H__
50 #define __ZSCORE_BATCH_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/normalization/zscore_types.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace normalization
62 {
63 namespace zscore
64 {
65 
66 namespace interface2
67 {
81 template<typename algorithmFPType, Method method, CpuType cpu>
82 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
83 {
84 public:
90  BatchContainer(daal::services::Environment::env *daalEnv);
92  virtual ~BatchContainer();
98  virtual services::Status compute() DAAL_C11_OVERRIDE;
99 };
100 
106 class DAAL_EXPORT BatchImpl : public daal::algorithms::Analysis<batch>
107 {
108 public:
110  BatchImpl()
111  {
112  initialize();
113  };
114 
122  BatchImpl(const BatchImpl &other) : input(other.input)
123  {
124  initialize();
125  }
126 
131  ResultPtr getResult()
132  {
133  return _result;
134  };
135 
140  virtual BaseParameter* getParameter() = 0;
141 
146  virtual services::Status setResult(const ResultPtr &result)
147  {
148  DAAL_CHECK(result, services::ErrorNullResult)
149  _result = result;
150  _res = _result.get();
151  return services::Status();
152  }
153 
160  services::SharedPtr<BatchImpl> clone() const
161  {
162  return services::SharedPtr<BatchImpl>(cloneImpl());
163  }
164 
165  virtual ~BatchImpl() {}
166 
167  Input input;
169 protected:
170  ResultPtr _result;
171 
172  void initialize()
173  {
174  _result = ResultPtr(new Result());
175  _in = &input;
176  }
177  virtual BatchImpl * cloneImpl() const DAAL_C11_OVERRIDE = 0;
178 };
179 
194 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
195 class DAAL_EXPORT Batch : public BatchImpl
196 {
197 public:
198  Parameter<algorithmFPType, method> parameter;
199 
201  Batch()
202  {
203  initialize();
204  }
205 
211  Batch(const Batch<algorithmFPType, method> &other) : BatchImpl(other), parameter(other.parameter)
212  {
213  initialize();
214  }
215 
216  virtual ~Batch() {}
217 
222  virtual BaseParameter* getParameter() DAAL_C11_OVERRIDE { return &parameter; }
223 
224 
229  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
230 
236  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
237  {
238  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
239  }
240 
241 protected:
242  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
243  {
244  return new Batch<algorithmFPType, method>(*this);
245  }
246 
247  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
248  {
249  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, method);
250  _res = _result.get();
251  return s;
252  }
253 
254  void initialize()
255  {
256  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
257  _par = &parameter;
258  }
259 
260 };
262 } // namespace interface2
263 using interface2::BatchContainer;
264 using interface2::BatchImpl;
265 using interface2::Batch;
266 
267 } // namespace zscore
268 } // namespace normalization
269 } // namespace algorithms
270 } // namespace daal
271 #endif
daal::algorithms::normalization::zscore::interface2::BaseParameter
Class that specifies the base parameters of the algorithm in the batch computing mode.
Definition: zscore_types.h:201
daal
Definition: algorithm_base_common.h:57
daal::algorithms::normalization::zscore::interface2::BatchImpl::BatchImpl
BatchImpl()
Definition: zscore.h:110
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::normalization::zscore::defaultDense
Definition: zscore_types.h:90
daal::algorithms::normalization::zscore::Method
Method
Definition: zscore_types.h:88
daal::algorithms::normalization::zscore::interface2::BatchImpl::setResult
virtual services::Status setResult(const ResultPtr &result)
Definition: zscore.h:146
daal::algorithms::normalization::zscore::interface2::Batch::getParameter
virtual BaseParameter * getParameter() DAAL_C11_OVERRIDE
Definition: zscore.h:222
daal::algorithms::normalization::zscore::interface2::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: zscore.h:211
daal_defines.h
daal::batch
Definition: daal_defines.h:131
daal::algorithms::normalization::zscore::interface2::BatchImpl::input
Input input
Definition: zscore.h:167
daal::algorithms::normalization::zscore::interface2::Parameter
Class that specifies the parameters of the algorithm in the batch computing mode. ...
Definition: zscore_types.h:195
daal::algorithms::normalization::zscore::interface2::BatchImpl::clone
services::SharedPtr< BatchImpl > clone() const
Definition: zscore.h:160
daal::algorithms::normalization::zscore::interface2::BatchImpl
Abstract class that specifies interface of the algorithms for computing correlation or variance-covar...
Definition: zscore.h:106
daal::algorithms::normalization::zscore::interface2::Result
Provides methods to access final results obtained with the compute() method of the z-score normalizat...
Definition: zscore_types.h:247
daal::algorithms::normalization::zscore::interface2::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: zscore.h:236
daal::algorithms::normalization::zscore::interface2::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: zscore.h:229
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::normalization::zscore::interface2::BatchImpl::getResult
ResultPtr getResult()
Definition: zscore.h:131
daal::algorithms::normalization::zscore::interface2::BatchContainer
Provides methods to run implementations of the z-score normalization algorithm. It is associated with...
Definition: zscore.h:82
daal::algorithms::normalization::zscore::interface2::BatchImpl::BatchImpl
BatchImpl(const BatchImpl &other)
Definition: zscore.h:122
daal::algorithms::normalization::zscore::interface2::Batch::Batch
Batch()
Definition: zscore.h:201
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::normalization::zscore::interface2::Batch
Normalizes datasets in the batch processing mode.
Definition: zscore.h:195

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