Intel® oneAPI Data Analytics Library Developer Guide and Reference
A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-68D0D136-B025-48CE-A161-25DCB2666AA2
Visible to Intel only — GUID: GUID-68D0D136-B025-48CE-A161-25DCB2666AA2
Computation
Algorithm Input
The iterative solver algorithm accepts the input described below. Pass the Input ID as a parameter to the methods that provide input for your algorithm. For more details, see Algorithms.
Input ID |
Input |
---|---|
inputArgument |
A numeric table of size |
optionalArgument |
Object of the OptionalArgument class that contains a set of algorithm-specific intrinsic parameters. For a detailed definition of the set, see the problem statement above and the description of a specific algorithm. |
Algorithm Parameters
The iterative solver algorithm has the following parameters:
Parameter |
Default Value |
Description |
---|---|---|
function |
Not applicable |
Objective function represented as a sum of functions. |
nIterations |
100 |
Maximum number of iterations of the algorithm. |
accuracyThreshold |
Accuracy of the algorithm. The algorithm terminates when this accuracy is achieved. |
|
optionalResultRequired |
false |
Indicates whether the set of the intrinsic parameters should be returned by the solver. |
Algorithm Output
The iterative solver algorithm calculates the result described below. Pass the Result ID as a parameter to the methods that access the results of your algorithm. For more details, see Algorithms.
Result ID |
Result |
---|---|
minimum |
A numeric table of size |
nIterations |
A numeric table of size |
optionalResult |
Object of the OptionalArgument class that contains a set of algorithm-specific intrinsic parameters. For a detailed definition of the set, see the problem statement above and the description of a specific algorithm. |