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

pca_quality_metric_set_types.h
1 /* file: pca_quality_metric_set_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Interface for the pca algorithm quality metrics
19 //--
20 */
21 
22 #ifndef __PCA_QUALITY_METRIC_SET_TYPES_H__
23 #define __PCA_QUALITY_METRIC_SET_TYPES_H__
24 
25 #include "services/daal_shared_ptr.h"
26 #include "algorithms/algorithm.h"
27 #include "algorithms/algorithm_quality_metric_set_types.h"
28 
29 namespace daal
30 {
31 namespace algorithms
32 {
33 namespace pca
34 {
41 namespace quality_metric_set
42 {
47 enum QualityMetricId
48 {
49  explainedVariancesMetrics,
50  lastQualityMetricId = explainedVariancesMetrics
51 };
52 
56 namespace interface1
57 {
58 
65 /* [Parameter source code] */
66 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
67 {
68  Parameter(size_t nComponents = 0, size_t nFeatures = 0);
69 
70  virtual ~Parameter() {}
71 
72  size_t nComponents;
73  size_t nFeatures;
80  virtual services::Status check() const;
81 };
82 /* [Parameter source code] */
83 
89 class DAAL_EXPORT ResultCollection: public algorithms::quality_metric_set::ResultCollection
90 {
91 public:
92  ResultCollection() {}
93  virtual ~ResultCollection() {}
94 
100  algorithms::ResultPtr getResult(QualityMetricId id) const;
101 };
102 typedef services::SharedPtr<ResultCollection> ResultCollectionPtr;
103 
109 class DAAL_EXPORT InputDataCollection: public algorithms::quality_metric_set::InputDataCollection
110 {
111 public:
112  InputDataCollection() {}
113  virtual ~InputDataCollection() {}
114 
120  algorithms::InputPtr getInput(QualityMetricId id) const;
121 };
122 typedef services::SharedPtr<InputDataCollection> InputDataCollectionPtr;
123 
124 }
125 using interface1::Parameter;
126 using interface1::ResultCollection;
127 using interface1::InputDataCollection;
128 using interface1::ResultCollectionPtr;
129 using interface1::InputDataCollectionPtr;
130 
131 }
133 }
134 }
135 }
136 
137 #endif // __PCA_QUALITY_METRIC_SET_TYPES_H__
daal
Definition: algorithm_base_common.h:31
daal::algorithms::pca::quality_metric_set::interface1::Parameter::nComponents
size_t nComponents
Definition: pca_quality_metric_set_types.h:72
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:109
daal::algorithms::pca::quality_metric_set::QualityMetricId
QualityMetricId
Definition: pca_quality_metric_set_types.h:47
daal::algorithms::pca::quality_metric_set::interface1::Parameter::nFeatures
size_t nFeatures
Definition: pca_quality_metric_set_types.h:73
daal::algorithms::pca::quality_metric_set::interface1::Parameter
Parameters for the quality metrics set compute() method.
Definition: pca_quality_metric_set_types.h:66
daal::algorithms::pca::quality_metric_set::explainedVariancesMetrics
Definition: pca_quality_metric_set_types.h:49
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:89

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