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

zscore.h
1 /* file: zscore.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 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:
109  typedef algorithms::normalization::zscore::Input InputType;
110  typedef algorithms::normalization::zscore::Result ResultType;
111 
113  BatchImpl()
114  {
115  initialize();
116  };
117 
125  BatchImpl(const BatchImpl &other) : input(other.input)
126  {
127  initialize();
128  }
129 
134  ResultPtr getResult()
135  {
136  return _result;
137  };
138 
143  virtual BaseParameter* getParameter() = 0;
144 
149  virtual services::Status setResult(const ResultPtr &result)
150  {
151  DAAL_CHECK(result, services::ErrorNullResult)
152  _result = result;
153  _res = _result.get();
154  return services::Status();
155  }
156 
163  services::SharedPtr<BatchImpl> clone() const
164  {
165  return services::SharedPtr<BatchImpl>(cloneImpl());
166  }
167 
168  virtual ~BatchImpl() {}
169 
170  InputType input;
172 protected:
173  ResultPtr _result;
174 
175  void initialize()
176  {
177  _result = ResultPtr(new ResultType());
178  _in = &input;
179  }
180  virtual BatchImpl * cloneImpl() const DAAL_C11_OVERRIDE = 0;
181 };
182 
197 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
198 class DAAL_EXPORT Batch : public BatchImpl
199 {
200 public:
201  typedef BatchImpl super;
202 
203  typedef typename super::InputType InputType;
204  typedef algorithms::normalization::zscore::Parameter<algorithmFPType, method> ParameterType;
205  typedef typename super::ResultType ResultType;
206 
207  Parameter<algorithmFPType, method> parameter;
208 
210  Batch()
211  {
212  initialize();
213  }
214 
220  Batch(const Batch<algorithmFPType, method> &other) : BatchImpl(other), parameter(other.parameter)
221  {
222  initialize();
223  }
224 
225  virtual ~Batch() {}
226 
231  virtual BaseParameter* getParameter() DAAL_C11_OVERRIDE { return &parameter; }
232 
233 
238  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
239 
245  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
246  {
247  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
248  }
249 
250 protected:
251  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
252  {
253  return new Batch<algorithmFPType, method>(*this);
254  }
255 
256  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
257  {
258  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, method);
259  _res = _result.get();
260  return s;
261  }
262 
263  void initialize()
264  {
265  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
266  _par = &parameter;
267  }
268 
269 };
271 } // namespace interface2
272 using interface2::BatchContainer;
273 using interface2::BatchImpl;
274 using interface2::Batch;
275 
276 } // namespace zscore
277 } // namespace normalization
278 } // namespace algorithms
279 } // namespace daal
280 #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::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::normalization::zscore::interface1::Input
Input objects for the z-score normalization algorithm
Definition: zscore_types.h:144
daal::algorithms::normalization::zscore::interface2::BatchImpl::BatchImpl
BatchImpl()
Definition: zscore.h:113
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::interface2::BatchImpl::setResult
virtual services::Status setResult(const ResultPtr &result)
Definition: zscore.h:149
daal::algorithms::normalization::zscore::interface2::Batch::getParameter
virtual BaseParameter * getParameter() DAAL_C11_OVERRIDE
Definition: zscore.h:231
daal::algorithms::normalization::zscore::interface2::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: zscore.h:220
daal_defines.h
daal::batch
Definition: daal_defines.h:132
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::normalization::zscore::interface2::Parameter
Class that specifies the parameters of the algorithm in the batch computing mode. ...
Definition: zscore_types.h:195
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
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::BatchImpl::input
InputType input
Definition: zscore.h:170
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::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: zscore.h:238
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:134
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::clone
services::SharedPtr< BatchImpl > clone() const
Definition: zscore.h:163
daal::algorithms::normalization::zscore::interface2::BatchImpl::BatchImpl
BatchImpl(const BatchImpl &other)
Definition: zscore.h:125
daal::algorithms::normalization::zscore::interface2::Batch::Batch
Batch()
Definition: zscore.h:210
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::normalization::zscore::interface2::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: zscore.h:245
daal::algorithms::normalization::zscore::interface2::Batch
Normalizes datasets in the batch processing mode.
Definition: zscore.h:198

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