Visible to Intel only — GUID: GUID-D4614532-1B94-43CB-80F5-39AA84004495
Visible to Intel only — GUID: GUID-D4614532-1B94-43CB-80F5-39AA84004495
Covariance
Covariance algorithm computes the following set of quantitative dataset characteristics:
means
covariance
correlation
Operation |
Computational methods |
Programming Interface |
||
Mathematical formulation
Refer to Developer Guide: Covariance.
Programming Interface
All types and functions in this section are declared in the oneapi::dal::covariance namespace and are available via inclusion of the oneapi/dal/algo/covariance.hpp header file.
Descriptor
template<typenameFloat=float,typenameMethod=method::by_default,typenameTask=task::by_default>classdescriptor
- Template Parameters
Constructors
descriptor()=default
Creates a new instance of the class with the default property values.
Properties
result_option_idresult_options
Choose which results should be computed and returned.
- Getter & Setter
-
result_option_id get_result_options() const
auto & set_result_options(const result_option_id &value)
Method tags
structdense
Tag-type that denotes dense computational method.
usingby_default=dense
Alias tag-type for the dense computational method.
Task tags
structcompute
Tag-type that parameterizes entities that are used to compute statistics.
usingby_default=compute
Alias tag-type for the compute task.
Training compute(...)
Input
template<typenameTask=task::by_default>classcompute_input
- Template Parameters
-
Task – Tag-type that specifies the type of the problem to solve. Can be task::compute.
Constructors
compute_input(consttable&data)
Creates a new instance of the class with the given data property value.
Properties
consttable&data
An table with the training data, where each row stores one feature vector. Default value: table{}.
- Getter & Setter
-
const table & get_data() const
auto & set_data(const table &value)
Result
template<typenameTask=task::by_default>classcompute_result
- Template Parameters
-
Task – Tag-type that specifies the type of the problem to solve. Can be task::compute.
Constructors
compute_result()
Creates a new instance of the class with the default property values.
Properties
consttable&cor_matrix
The correlation matrix. Default value: table{}.
- Getter & Setter
-
const table & get_cor_matrix() const
auto & set_cor_matrix(const table &value)
consttable&cov_matrix
The covariance matrix. Default value: table{}.
- Getter & Setter
-
const table & get_cov_matrix() const
auto & set_cov_matrix(const table &value)
consttable&means
Means. Default value: table{}.
- Getter & Setter
-
const table & get_means() const
auto & set_means(const table &value)
constresult_option_id&result_options
Result options that indicates availability of the properties. Default value: default_result_options<Task>.
- Getter & Setter
-
const result_option_id & get_result_options() const
auto & set_result_options(const result_option_id &value)
Operation
template<typenameDescriptor>covariance::compute_resultcompute(constDescriptor&desc, constcovariance::compute_input&input)
- Parameters
-
desc – Covariance algorithm descriptor covariance::descriptor
input – Input data for the computing operation
- Preconditions
-
input.data.is_empty == false