I opened this issue as a documentation issue, because there is no direct impact on the correctness of the code itself.
Report incorrect documentation
There is a small typo in the definition of termination status codes: TERIMINATION instead of TERMINATION (extra I after the R).
Location of incorrect documentation
See, e.g.,
|
#define CUOPT_TERIMINATION_STATUS_NO_TERMINATION 0 |
|
#define CUOPT_TERIMINATION_STATUS_OPTIMAL 1 |
|
#define CUOPT_TERIMINATION_STATUS_INFEASIBLE 2 |
|
#define CUOPT_TERIMINATION_STATUS_UNBOUNDED 3 |
|
#define CUOPT_TERIMINATION_STATUS_ITERATION_LIMIT 4 |
|
#define CUOPT_TERIMINATION_STATUS_TIME_LIMIT 5 |
|
#define CUOPT_TERIMINATION_STATUS_NUMERICAL_ERROR 6 |
|
#define CUOPT_TERIMINATION_STATUS_PRIMAL_FEASIBLE 7 |
|
#define CUOPT_TERIMINATION_STATUS_FEASIBLE_FOUND 8 |
|
#define CUOPT_TERIMINATION_STATUS_CONCURRENT_LIMIT 9 |
|
#define CUOPT_TERIMINATION_STATUS_WORK_LIMIT 10 |
AFAICT, this spelling is consistent throughout the code.
Describe the problems or issues found in the documentation
The code is functional, it's just that there's a typo in the symbol definition.
This could increase the likelihood of downstream users running into issues.
Steps taken to verify documentation is incorrect
I checked the spelling of "termination" :)
Suggested fix for documentation
Fixing the typo throughout the code, though this would be a breaking change given that these symbols are exported in, e.g., the C API.
I opened this issue as a documentation issue, because there is no direct impact on the correctness of the code itself.
Report incorrect documentation
There is a small typo in the definition of termination status codes:
TERIMINATIONinstead ofTERMINATION(extraIafter theR).Location of incorrect documentation
See, e.g.,
cuopt/cpp/include/cuopt/linear_programming/constants.h
Lines 83 to 93 in b3bb21e
AFAICT, this spelling is consistent throughout the code.
Describe the problems or issues found in the documentation
The code is functional, it's just that there's a typo in the symbol definition.
This could increase the likelihood of downstream users running into issues.
Steps taken to verify documentation is incorrect
I checked the spelling of "termination" :)
Suggested fix for documentation
Fixing the typo throughout the code, though this would be a breaking change given that these symbols are exported in, e.g., the C API.