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

pca_quality_metric_set_types.h
1 /* file: pca_quality_metric_set_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 // Interface for the pca algorithm quality metrics
45 //--
46 */
47 
48 #ifndef __PCA_QUALITY_METRIC_SET_TYPES_H__
49 #define __PCA_QUALITY_METRIC_SET_TYPES_H__
50 
51 #include "services/daal_shared_ptr.h"
52 #include "algorithms/algorithm.h"
53 #include "algorithms/algorithm_quality_metric_set_types.h"
54 
55 namespace daal
56 {
57 namespace algorithms
58 {
59 namespace pca
60 {
67 namespace quality_metric_set
68 {
73 enum QualityMetricId
74 {
75  explainedVariancesMetrics,
76  lastQualityMetricId = explainedVariancesMetrics
77 };
78 
82 namespace interface1
83 {
84 
91 /* [Parameter source code] */
92 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
93 {
94  Parameter(size_t nComponents = 0, size_t nFeatures = 0);
95 
96  virtual ~Parameter() {}
97 
98  size_t nComponents;
99  size_t nFeatures;
106  virtual services::Status check() const;
107 };
108 /* [Parameter source code] */
109 
115 class DAAL_EXPORT ResultCollection: public algorithms::quality_metric_set::ResultCollection
116 {
117 public:
118  ResultCollection() {}
119  virtual ~ResultCollection() {}
120 
126  algorithms::ResultPtr getResult(QualityMetricId id) const;
127 };
128 typedef services::SharedPtr<ResultCollection> ResultCollectionPtr;
129 
135 class DAAL_EXPORT InputDataCollection: public algorithms::quality_metric_set::InputDataCollection
136 {
137 public:
138  InputDataCollection() {}
139  virtual ~InputDataCollection() {}
140 
146  algorithms::InputPtr getInput(QualityMetricId id) const;
147 };
148 typedef services::SharedPtr<InputDataCollection> InputDataCollectionPtr;
149 
150 }
151 using interface1::Parameter;
152 using interface1::ResultCollection;
153 using interface1::InputDataCollection;
154 using interface1::ResultCollectionPtr;
155 using interface1::InputDataCollectionPtr;
156 
157 }
159 }
160 }
161 }
162 
163 #endif // __PCA_QUALITY_METRIC_SET_TYPES_H__
daal::algorithms::pca::quality_metric_set::QualityMetricId
QualityMetricId
Definition: pca_quality_metric_set_types.h:73
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::pca::quality_metric_set::interface1::Parameter::nComponents
size_t nComponents
Definition: pca_quality_metric_set_types.h:98
daal::algorithms::pca::quality_metric_set::interface1::InputDataCollection
Class that implements functionality of the collection of input objects of the quality metrics algorit...
Definition: pca_quality_metric_set_types.h:135
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
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::quality_metric_set::interface1::InputDataCollection
Class that implements functionality of the collection of input objects of the quality metrics algorit...
Definition: algorithm_quality_metric_set_types.h:128
daal::algorithms::pca::quality_metric_set::interface1::Parameter::nFeatures
size_t nFeatures
Definition: pca_quality_metric_set_types.h:99
daal::algorithms::quality_metric_set::interface1::ResultCollection
Class that implements functionality of the collection of result objects of the quality metrics algori...
Definition: algorithm_quality_metric_set_types.h:155
daal::algorithms::pca::quality_metric_set::interface1::Parameter
Parameters for the quality metrics set compute() method.
Definition: pca_quality_metric_set_types.h:92
daal::algorithms::pca::quality_metric_set::explainedVariancesMetrics
Definition: pca_quality_metric_set_types.h:75
daal::algorithms::pca::quality_metric_set::interface1::ResultCollection
Class that implements functionality of the collection of result objects of the quality metrics algori...
Definition: pca_quality_metric_set_types.h:115

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