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

minmax.h
1 /* file: minmax.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 min-max normalization algorithm
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __MINMAX_BATCH_H__
50 #define __MINMAX_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/minmax_types.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace normalization
62 {
63 namespace minmax
64 {
65 
66 namespace interface1
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);
91 
92  virtual ~BatchContainer();
93 
99  virtual services::Status compute() DAAL_C11_OVERRIDE;
100 };
101 
115 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
116 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
117 {
118 public:
119  typedef algorithms::normalization::minmax::Input InputType;
120  typedef algorithms::normalization::minmax::Parameter<algorithmFPType> ParameterType;
121  typedef algorithms::normalization::minmax::Result ResultType;
122 
123  InputType input;
124  Parameter<algorithmFPType> parameter;
127  Batch()
128  {
129  initialize();
130  }
131 
137  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
138  {
139  initialize();
140  }
141 
142  virtual ~Batch() {}
143 
148  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
149 
154  ResultPtr getResult()
155  {
156  return _result;
157  }
158 
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 
178  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
179  {
180  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
181  }
182 
183 protected:
184  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
185  {
186  return new Batch<algorithmFPType, method>(*this);
187  }
188 
189  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
190  {
191  services::Status s = _result->allocate<algorithmFPType>(&input, method);
192  _res = _result.get();
193  return s;
194  }
195 
196  void initialize()
197  {
198  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
199  _in = &input;
200  _par = &parameter;
201  _result.reset(new ResultType());
202  }
203 
204  ResultPtr _result;
205 
206 };
208 } // namespace interface1
209 using interface1::BatchContainer;
210 using interface1::Batch;
211 
212 } // namespace minmax
213 } // namespace normalization
214 } // namespace algorithms
215 } // namespace daal
216 #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::normalization::minmax::interface1::Parameter
Class that specifies the parameters of the algorithm in the batch computing mode. ...
Definition: minmax_types.h:149
daal::algorithms::normalization::minmax::interface1::Input
Input objects for the min-max normalization algorithm
Definition: minmax_types.h:163
daal_defines.h
daal::algorithms::normalization::minmax::interface1::Batch::parameter
Parameter< algorithmFPType > parameter
Definition: minmax.h:124
daal::batch
Definition: daal_defines.h:132
daal::algorithms::normalization::minmax::interface1::Result
Provides methods to access final results obtained with the compute() method of the min-max normalizat...
Definition: minmax_types.h:203
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::minmax::interface1::Batch::input
InputType input
Definition: minmax.h:123
daal::algorithms::normalization::minmax::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: minmax.h:165
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::normalization::minmax::interface1::BatchContainer
Provides methods to run implementations of the min-max normalization algorithm. It is associated with...
Definition: minmax.h:82
daal::algorithms::normalization::minmax::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: minmax.h:137
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::minmax::interface1::Batch::Batch
Batch()
Definition: minmax.h:127
daal::algorithms::normalization::minmax::interface1::Batch::getResult
ResultPtr getResult()
Definition: minmax.h:154
daal::algorithms::normalization::minmax::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: minmax.h:148
daal::algorithms::normalization::minmax::interface1::Batch
Normalizes datasets in the batch processing mode.
Definition: minmax.h:116
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::normalization::minmax::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: minmax.h:178

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