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

pca_quality_metric_set_types.h
1 /* file: pca_quality_metric_set_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Interface for the pca algorithm quality metrics
21 //--
22 */
23 
24 #ifndef __PCA_QUALITY_METRIC_SET_TYPES_H__
25 #define __PCA_QUALITY_METRIC_SET_TYPES_H__
26 
27 #include "services/daal_shared_ptr.h"
28 #include "algorithms/algorithm.h"
29 #include "algorithms/algorithm_quality_metric_set_types.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace pca
36 {
43 namespace quality_metric_set
44 {
49 enum QualityMetricId
50 {
51  explainedVariancesMetrics,
52  lastQualityMetricId = explainedVariancesMetrics
53 };
54 
58 namespace interface1
59 {
60 
67 /* [Parameter source code] */
68 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
69 {
70  Parameter(size_t nComponents = 0, size_t nFeatures = 0);
71 
72  virtual ~Parameter() {}
73 
74  size_t nComponents;
75  size_t nFeatures;
82  virtual services::Status check() const;
83 };
84 /* [Parameter source code] */
85 
91 class DAAL_EXPORT ResultCollection: public algorithms::quality_metric_set::ResultCollection
92 {
93 public:
94  ResultCollection() {}
95  virtual ~ResultCollection() {}
96 
102  algorithms::ResultPtr getResult(QualityMetricId id) const;
103 };
104 typedef services::SharedPtr<ResultCollection> ResultCollectionPtr;
105 
111 class DAAL_EXPORT InputDataCollection: public algorithms::quality_metric_set::InputDataCollection
112 {
113 public:
114  InputDataCollection() {}
115  virtual ~InputDataCollection() {}
116 
122  algorithms::InputPtr getInput(QualityMetricId id) const;
123 };
124 typedef services::SharedPtr<InputDataCollection> InputDataCollectionPtr;
125 
126 }
127 using interface1::Parameter;
128 using interface1::ResultCollection;
129 using interface1::InputDataCollection;
130 using interface1::ResultCollectionPtr;
131 using interface1::InputDataCollectionPtr;
132 
133 }
135 }
136 }
137 }
138 
139 #endif // __PCA_QUALITY_METRIC_SET_TYPES_H__
daal::algorithms::pca::quality_metric_set::explainedVariancesMetrics
Definition: pca_quality_metric_set_types.h:51
daal::algorithms::pca::quality_metric_set::interface1::Parameter
Parameters for the quality metrics set compute() method.
Definition: pca_quality_metric_set_types.h:68
daal::algorithms::pca::quality_metric_set::interface1::Parameter::nFeatures
size_t nFeatures
Definition: pca_quality_metric_set_types.h:75
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:111
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:91
daal::algorithms::pca::quality_metric_set::QualityMetricId
QualityMetricId
Definition: pca_quality_metric_set_types.h:49
daal::algorithms::pca::quality_metric_set::interface1::Parameter::nComponents
size_t nComponents
Definition: pca_quality_metric_set_types.h:74

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