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

outlier_detection_univariate_types.h
1 /* file: outlier_detection_univariate_types.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 // univariate outlier detection algorithm types
45 //--
46 */
47 
48 #ifndef __OUTLIERDETECTION_UNIVARIATE_TYPES_H__
49 #define __OUTLIERDETECTION_UNIVARIATE_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/homogen_numeric_table.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
67 namespace univariate_outlier_detection
68 {
73 enum Method
74 {
75  defaultDense = 0
76 };
77 
82 enum InputId
83 {
84  data ,
85  location ,
86  scatter ,
87  threshold ,
88  lastInputId = threshold
89 };
90 
95 enum ResultId
96 {
97  weights,
98  lastResultId = weights
99 };
100 
104 namespace interface1
105 {
110 struct InitIface
111 {
119  virtual void operator()(data_management::NumericTable *data,
120  data_management::NumericTable *location,
121  data_management::NumericTable *scatter,
122  data_management::NumericTable *threshold) = 0;
123  virtual ~InitIface() {}
124 };
125 
130 struct DAAL_EXPORT DefaultInit : public InitIface
131 {
139  virtual void operator()(data_management::NumericTable *data,
140  data_management::NumericTable *location,
141  data_management::NumericTable *scatter,
142  data_management::NumericTable *threshold) {}
143 };
144 
151 /* [Parameter source code] */
152 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
153 {
154  Parameter() {}
155  services::SharedPtr<InitIface> initializationProcedure;
162  virtual services::Status check() const DAAL_C11_OVERRIDE {return services::Status();}
163 };
164 /* [Parameter source code] */
165 
170 class DAAL_EXPORT Input : public daal::algorithms::Input
171 {
172 public:
173  Input();
174  Input(const Input& other);
175 
176  virtual ~Input() {}
177 
183  data_management::NumericTablePtr get(InputId id) const;
184 
190  void set(InputId id, const data_management::NumericTablePtr &ptr);
191 
199  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
200 };
201 
206 class DAAL_EXPORT Result : public daal::algorithms::Result
207 {
208 public:
209  DECLARE_SERIALIZABLE_CAST(Result);
210  Result();
211 
212  virtual ~Result() {};
213 
222  template <typename algorithmFPType>
223  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
224 
230  data_management::NumericTablePtr get(ResultId id) const;
231 
237  void set(ResultId id, const data_management::NumericTablePtr &ptr);
238 
247  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
248 
249 protected:
251  template<typename Archive, bool onDeserialize>
252  services::Status serialImpl(Archive *arch)
253  {
254  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
255  }
256 };
257 typedef services::SharedPtr<Result> ResultPtr;
258 
260 } // namespace interface1
261 using interface1::InitIface;
262 using interface1::DefaultInit;
263 using interface1::Parameter;
264 using interface1::Input;
265 using interface1::Result;
266 using interface1::ResultPtr;
267 
268 } // namespace univariate_outlier_detection
269 } // namespace algorithm
270 } // namespace daal
271 #endif
daal::algorithms::univariate_outlier_detection::threshold
Definition: outlier_detection_univariate_types.h:87
daal::algorithms::univariate_outlier_detection::interface1::Parameter::initializationProcedure
services::SharedPtr< InitIface > initializationProcedure
Definition: outlier_detection_univariate_types.h:155
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::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::algorithms::univariate_outlier_detection::interface1::Parameter
Parameters of the univariate outlier detection algorithm.
Definition: outlier_detection_univariate_types.h:152
daal::algorithms::univariate_outlier_detection::data
Definition: outlier_detection_univariate_types.h:84
daal::algorithms::univariate_outlier_detection::interface1::Parameter::check
virtual services::Status check() const DAAL_C11_OVERRIDE
Definition: outlier_detection_univariate_types.h:162
daal::algorithms::univariate_outlier_detection::interface1::InitIface
Abstract class that provides a functor for the initial procedure.
Definition: outlier_detection_univariate_types.h:110
daal::algorithms::univariate_outlier_detection::defaultDense
Definition: outlier_detection_univariate_types.h:75
daal::algorithms::univariate_outlier_detection::location
Definition: outlier_detection_univariate_types.h:85
daal::algorithms::univariate_outlier_detection::interface1::DefaultInit
Class that specifies the default method for initialization.
Definition: outlier_detection_univariate_types.h:130
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
daal::algorithms::univariate_outlier_detection::interface1::InitIface::operator()
virtual void operator()(data_management::NumericTable *data, data_management::NumericTable *location, data_management::NumericTable *scatter, data_management::NumericTable *threshold)=0
daal::algorithms::univariate_outlier_detection::ResultId
ResultId
Definition: outlier_detection_univariate_types.h:95
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::univariate_outlier_detection::interface1::DefaultInit::operator()
virtual void operator()(data_management::NumericTable *data, data_management::NumericTable *location, data_management::NumericTable *scatter, data_management::NumericTable *threshold)
Definition: outlier_detection_univariate_types.h:139
daal::data_management::interface1::NumericTable
Class for a data management component responsible for representation of data in the numeric format...
Definition: numeric_table.h:600
daal::algorithms::univariate_outlier_detection::InputId
InputId
Definition: outlier_detection_univariate_types.h:82
daal::algorithms::univariate_outlier_detection::weights
Definition: outlier_detection_univariate_types.h:97
daal::algorithms::univariate_outlier_detection::scatter
Definition: outlier_detection_univariate_types.h:86
daal::algorithms::univariate_outlier_detection::interface1::Input
Input objects for the univariate outlier detection algorithm
Definition: outlier_detection_univariate_types.h:170
daal::algorithms::univariate_outlier_detection::interface1::Result
Results obtained with the compute() method of the univariate outlier detection algorithm in the batch...
Definition: outlier_detection_univariate_types.h:206
daal::algorithms::univariate_outlier_detection::Method
Method
Definition: outlier_detection_univariate_types.h:73
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217

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