C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1
Contains a class for ridge regression model-based training. More...
References | |
Batch | |
Distributed | |
Online | |
Namespaces | |
daal::algorithms::ridge_regression::training | |
Contains a class for ridge regression model-based training. | |
daal::algorithms::ridge_regression::training::interface1 | |
Contains version 1.0 of the Intel(R) Data Analytics Acceleration Library (Intel(R) DAAL) interface. | |
Classes | |
class | InputIface |
Abstract class that specifies the interface of input objects for ridge regression model-based training. More... | |
class | Input |
Input objects for ridge regression model-based training More... | |
class | DistributedInput< step > |
Input object for ridge regression model-based training in the distributed processing mode More... | |
class | PartialResult |
Provides methods to access a partial result obtained with the compute() method of ridge regression model-based training in the online or distributed processing mode. More... | |
class | DistributedInput< step2Master > |
Input object for ridge regression model-based training in the second step of the distributed processing mode More... | |
class | Result |
Provides methods to access the result obtained with the compute() method of ridge regression model-based training. More... | |
Enumerations | |
enum | Method { defaultDense = 0, normEqDense = 0 } |
Computation methods for ridge regression model-based training. More... | |
enum | InputId { data = linear_model::training::data, dependentVariables = linear_model::training::dependentVariables } |
Available identifiers of input objects for ridge regression model-based training. More... | |
enum | Step2MasterInputId { partialModels } |
Available identifiers of input objects for ridge regression model-based training in the second step of the distributed processing mode. More... | |
enum | PartialResultID { partialModel } |
Available identifiers of a partial result of ridge regression model-based training. More... | |
enum | ResultId { model = linear_model::training::model } |
Available identifiers of the result of ridge regression model-based training. More... | |
Functions | |
virtual size_t | getNumberOfFeatures () const =0 |
virtual size_t | getNumberOfDependentVariables () const =0 |
Input () | |
data_management::NumericTablePtr | get (InputId id) const |
void | set (InputId id, const data_management::NumericTablePtr &value) |
size_t | getNumberOfFeatures () const DAAL_C11_OVERRIDE |
size_t | getNumberOfDependentVariables () const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
daal::algorithms::ridge_regression::ModelPtr | get (PartialResultID id) const |
size_t | getNumberOfFeatures () const |
size_t | getNumberOfDependentVariables () const |
void | set (PartialResultID id, const daal::algorithms::ridge_regression::ModelPtr &value) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | allocate (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | initialize (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method) |
services::Status | check (const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
data_management::DataCollectionPtr | get (Step2MasterInputId id) const |
void | set (Step2MasterInputId id, const data_management::DataCollectionPtr &ptr) |
void | add (Step2MasterInputId id, const PartialResultPtr &partialResult) |
size_t | getNumberOfFeatures () const DAAL_C11_OVERRIDE |
size_t | getNumberOfDependentVariables () const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE |
ridge_regression::ModelPtr | get (ResultId id) const |
void | set (ResultId id, const ridge_regression::ModelPtr &value) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | allocate (const daal::algorithms::Input *input, const Parameter *parameter, const int method) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | allocate (const daal::algorithms::PartialResult *partialResult, const Parameter *parameter, int method) |
services::Status | check (const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::PartialResult *pr, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
enum InputId |
void add | ( | Step2MasterInputId | id, |
const PartialResultPtr & | partialResult | ||
) |
Adds an input object for ridge regression model-based training in the second step of the distributed processing mode
[in] | id | Identifier of the input object |
[in] | partialResult | Input object |
DAAL_EXPORT services::Status allocate | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | parameter, | ||
const int | method | ||
) |
Allocates memory to store a partial result of ridge regression model-based training
[in] | input | Input object for the algorithm |
[in] | method | Method of ridge regression model-based training |
[in] | parameter | Parameter of ridge regression model-based training |
DAAL_EXPORT services::Status allocate | ( | const daal::algorithms::Input * | input, |
const Parameter * | parameter, | ||
const int | method | ||
) |
Allocates memory to store the result of ridge regression model-based training
[in] | input | Pointer to an object containing the input data |
[in] | parameter | Parameter of ridge regression model-based training |
[in] | method | Computation method for the algorithm |
DAAL_EXPORT services::Status allocate | ( | const daal::algorithms::PartialResult * | partialResult, |
const Parameter * | parameter, | ||
int | method | ||
) |
Allocates memory to store the result of ridge regression model-based training
[in] | partialResult | Pointer to an object containing the input data |
[in] | method | Computation method of the algorithm |
[in] | parameter | Parameter of ridge regression model-based training |
services::Status check | ( | const daal::algorithms::Parameter * | par, |
int | method | ||
) | const |
Checks an input object for the ridge regression algorithm
[in] | par | Algorithm parameter |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | par, | ||
int | method | ||
) | const |
Checks a partial result of the ridge regression algorithm
[in] | input | Input object for the algorithm |
[in] | par | Parameter of the algorithm |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Parameter * | par, |
int | method | ||
) | const |
Checks a partial result of the ridge regression algorithm
[in] | par | Parameter of the algorithm |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Parameter * | parameter, |
int | method | ||
) | const |
Checks an input object for ridge regression model-based training in the second step of the distributed processing mode
services::Status check | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | par, | ||
int | method | ||
) | const |
Checks the result of ridge regression model-based training
[in] | input | Input object for the algorithm |
[in] | par | Parameter of the algorithm |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::PartialResult * | pr, |
const daal::algorithms::Parameter * | par, | ||
int | method | ||
) | const |
Checks the result of the ridge regression model-based training
[in] | pr | PartialResult of the algorithm |
[in] | par | Parameter of the algorithm |
[in] | method | Computation method |
data_management::NumericTablePtr get | ( | InputId | id | ) | const |
Returns an input object for ridge regression model-based training
[in] | id | Identifier of the input object |
daal::algorithms::ridge_regression::ModelPtr get | ( | PartialResultID | id | ) | const |
Returns a partial result of ridge regression model-based training
[in] | id | Identifier of the partial result |
data_management::DataCollectionPtr get | ( | Step2MasterInputId | id | ) | const |
Gets an input object for ridge regression model-based training in the second step of the distributed processing mode
[in] | id | Identifier of the input object |
ridge_regression::ModelPtr get | ( | ResultId | id | ) | const |
Returns the result of ridge regression model-based training
[in] | id | Identifier of the result |
|
pure virtual |
Returns the number of dependent variables
Implemented in DistributedInput< step2Master >, and Input.
|
virtual |
Returns the number of dependent variables
Implements InputIface.
size_t getNumberOfDependentVariables | ( | ) | const |
Returns the number of dependent variables
|
virtual |
Returns the number of dependent variables
Implements InputIface.
|
pure virtual |
Returns the number of columns in the input data set
Implemented in DistributedInput< step2Master >, and Input.
|
virtual |
Returns the number of columns in the input data set
Implements InputIface.
size_t getNumberOfFeatures | ( | ) | const |
Returns the number of columns in the input data set
|
virtual |
Returns the number of columns in the input data set
Implements InputIface.
DAAL_EXPORT services::Status initialize | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | parameter, | ||
const int | method | ||
) |
Initializes memory to store a partial result of ridge regression model-based training
[in] | input | Input object for the algorithm |
[in] | method | Method of ridge regression model-based training |
[in] | parameter | Parameter of ridge regression model-based training |
Input | ( | ) |
Default constructor
void set | ( | InputId | id, |
const data_management::NumericTablePtr & | value | ||
) |
Sets an input object for ridge regression model-based training
[in] | id | Identifier of the input object |
[in] | value | Pointer to the object |
void set | ( | PartialResultID | id, |
const daal::algorithms::ridge_regression::ModelPtr & | value | ||
) |
Sets an argument of the partial result
[in] | id | Identifier of the argument |
[in] | value | Pointer to the argument |
void set | ( | Step2MasterInputId | id, |
const data_management::DataCollectionPtr & | ptr | ||
) |
Sets an input object for ridge regression model-based training in the second step of the distributed processing mode
[in] | id | Identifier of the input object |
[in] | ptr | Input object |
For more complete information about compiler optimizations, see our Optimization Notice.