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

outlier_detection_bacon_types.h
1 /* file: outlier_detection_bacon_types.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 // Outlier Detection algorithm parameter structure
45 //--
46 */
47 
48 #ifndef __OUTLIERDETECTION_BACON_TYPES_H__
49 #define __OUTLIERDETECTION_BACON_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 bacon_outlier_detection
68 {
73 enum Method
74 {
75  defaultDense = 0
76 };
77 
82 enum InitializationMethod
83 {
84  baconMedian = 0,
85  baconMahalanobis = 1
86 };
87 
92 enum InputId
93 {
94  data = 0
95 };
96 
101 enum ResultId
102 {
103  weights = 0
104 };
105 
109 namespace interface1
110 {
111 
118 /* [ParameterBacon source code] */
119 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
120 {
121  Parameter(InitializationMethod initMethod = baconMedian,
122  double alpha = 0.05, double toleranceToConverge = 0.005);
123 
124  InitializationMethod initMethod;
125  double alpha;
128  double toleranceToConverge;
130  virtual services::Status check() const DAAL_C11_OVERRIDE;
131 };
132 /* [ParameterBacon source code] */
133 
138 class DAAL_EXPORT Input : public daal::algorithms::Input
139 {
140 public:
141  Input();
142  Input(const Input& other);
143 
144  virtual ~Input() {}
145 
151  data_management::NumericTablePtr get(InputId id) const;
152 
158  void set(InputId id, const data_management::NumericTablePtr &ptr);
159 
167  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
168 };
169 
174 class DAAL_EXPORT Result : public daal::algorithms::Result
175 {
176 public:
177  DECLARE_SERIALIZABLE_CAST(Result);
178  Result();
179 
180  virtual ~Result() {};
181 
191  template <typename algorithmFPType>
192  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
193 
199  data_management::NumericTablePtr get(ResultId id) const;
200 
206  void set(ResultId id, const data_management::NumericTablePtr &ptr);
207 
216  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
217 
218 protected:
220  template<typename Archive, bool onDeserialize>
221  services::Status serialImpl(Archive *arch)
222  {
223  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
224  }
225 };
226 typedef services::SharedPtr<Result> ResultPtr;
227 
229 } // namespace interface1
230 using interface1::Parameter;
231 using interface1::Input;
232 using interface1::Result;
233 using interface1::ResultPtr;
234 
235 } // namespace bacon_outlier_detection
236 } // namespace algorithm
237 } // namespace daal
238 #endif
daal::algorithms::bacon_outlier_detection::weights
Definition: outlier_detection_bacon_types.h:103
daal::algorithms::bacon_outlier_detection::interface1::Input
Input objects for the BACON outlier detection algorithm
Definition: outlier_detection_bacon_types.h:138
daal
Definition: algorithm_base_common.h:57
daal::algorithms::bacon_outlier_detection::baconMahalanobis
Definition: outlier_detection_bacon_types.h:85
daal::algorithms::bacon_outlier_detection::interface1::Parameter::alpha
double alpha
Definition: outlier_detection_bacon_types.h:125
daal::algorithms::bacon_outlier_detection::ResultId
ResultId
Definition: outlier_detection_bacon_types.h:101
daal::algorithms::bacon_outlier_detection::defaultDense
Definition: outlier_detection_bacon_types.h:75
daal::algorithms::bacon_outlier_detection::InputId
InputId
Definition: outlier_detection_bacon_types.h:92
daal::algorithms::bacon_outlier_detection::baconMedian
Definition: outlier_detection_bacon_types.h:84
daal::algorithms::bacon_outlier_detection::interface1::Parameter
Parameters of the outlier detection computation using the baconDense method.
Definition: outlier_detection_bacon_types.h:119
daal::algorithms::bacon_outlier_detection::Method
Method
Definition: outlier_detection_bacon_types.h:73
daal::algorithms::bacon_outlier_detection::interface1::Parameter::initMethod
InitializationMethod initMethod
Definition: outlier_detection_bacon_types.h:124
daal::algorithms::bacon_outlier_detection::interface1::Result
Results obtained with the compute() method of the BACON outlier detection algorithm in the batch proc...
Definition: outlier_detection_bacon_types.h:174
daal::algorithms::bacon_outlier_detection::data
Definition: outlier_detection_bacon_types.h:94
daal::algorithms::bacon_outlier_detection::InitializationMethod
InitializationMethod
Definition: outlier_detection_bacon_types.h:82
daal::algorithms::bacon_outlier_detection::interface1::Parameter::toleranceToConverge
double toleranceToConverge
Definition: outlier_detection_bacon_types.h:128

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