Provide a generic test suite for MatrixObjects #5162
Conversation
wucas
added
gapdays2022-summer
| # change an object and therefore require it to be mutable are skipped. This | ||
| # option is intended for objects which are always immutable. | ||
|
|
||
| TestMatrixObj := function(filter, optIn) |
There was a problem hiding this comment.
What calls TestMatrixObj and where?
There was a problem hiding this comment.
That is the function one should call to execute the tests.
| # See TestMatrixObj_GenerateExample | ||
| # dimensions: | ||
| # See TestMatrixObj_GenerateExample | ||
| # dimensions_red: A list of tuples defining dimensions for matrices. If not set |
There was a problem hiding this comment.
| # dimensions_red: A list of tuples defining dimensions for matrices. If not set | |
| # dimensions_red: | |
| # A list of tuples defining dimensions for matrices. If not set |
Instead of "If not set" here and "By default this is set" elsewhere and so on, I'd suggest to settle on a uniform way to describe defaults. E.g. at the end of a description, add, in a line of its own:
# Default value: XYZ
| # domains_red: | ||
| # A list of domains in which matrices should be generated. By default | ||
| # this is set to [Integers, Rationals, GF(2), GF(5)]. These domains are used | ||
| # to generate examples for more expensive tests. |
There was a problem hiding this comment.
Based on what you write elsewhere, I assume "red" stands for "reduced" and not the color "red"? But why "reduced" ?
It might also be good to explain how this relates to domains. E.g. is this right? "If domains_red is given, then it is used instead of domains for certain expensive tests.
There was a problem hiding this comment.
I chose 'reduced' since its an option to choose a smaller set of cases to test. There might be a better name though.
| # domains and dimensions via domains_red and dimensions_red all combinations | ||
| # of the specified dimensions and domains are used. If tests are very | ||
| # expensive or just certain combinations should be tested one can use | ||
| # reduced_cases instead. |
There was a problem hiding this comment.
This option is documented but does not seem to actually exist?
This PR resolves Issue #4512.
Still missing:
At some point we should rename the file and do a rebase of course as well.