Ticket #9153 (assigned)
Review Algorithm Property Defaults
Reported by: | Peter Parker | Owned by: | Nick Draper |
---|---|---|---|
Priority: | minor | Milestone: | Release 3.5 |
Component: | Framework | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: |
Description
The "Properties" tables generated by WikiMaker expose the fact that for some algorithms we are using rather user-unfriendly conventions to denote various default values.
Examples:
- There are 78 algorithms that use -1. Presumably, there will be some fraction of these where -1 is an acceptable value that can be used by the algorithm, but in most cases they are associated with a "must-be-positive" validator. Andrei has suggested that using -DBL_MAX in such cases might be a viable alternative.
- -1.0 is used by an algorithm to denote an unspecified, default stop time.
- There are 5 algorithms that use -0 as a default.
This problem has become more visible since #2480, which populates algorithm dialogs with default values.
A solution to this problem would make documentation a lot clearer, and would hopefully make algorithms easier to understand and use.
Change History
comment:2 Changed 7 years ago by Nick Draper
- Status changed from new to assigned
- Owner set to Nick Draper
- Milestone changed from Backlog to Release 3.2
Note: See
TracTickets for help on using
tickets.
I offer up the following script to the eventual owner of this ticket, as a quick way to see which algorithms use which default values: