Good practices for numerical array constants in tests

General Usage
,
1

I have isolated a tricky numerical corner case for a package using randomly generated values. I tracked down the problem and fixed it, but want to add it to the tests too so that it does not happen again even if I refactor etc.

What are the best practices for adding array constants, eg a Float64 matrix, to the tests?

I could just add it on a single line, eg a 20x20 matrix becomes 8k character beast, but otherwise it is fine. Then it is local, but it is still clutter.

I could write to a dlm file and read it back, DelimitedFiles is a lightweight dependency.

Anything else? What would you recommend?

2

Honestly, I would just copy/paste the matrix directly to the file, it is not too big.

You just need to make sure that the decimals match exactly those stored in memory, and are not those rounded by show on the REPL.

2 Likes
3

I would serialize the matrix using the Serialization stdlib and keep the file along the test suite. It is a standard library, and it stores the exact values of the floating-point numbers. Moreover, the API is the simplest possible:

using Serialization
M_ = deserialize("matrix.bin")

The format is guaranteed to remain readable between julia versions:

The data format can change in minor (1.x) Julia releases, but files written by prior 1.x versions will remain readable.

2 Likes
4

That gives me an idea… I realized I could just base64 encode the serialized format and have it locally in the code.

1 Like
5

f66
f66540×482 81.7 KB

:smile:

1 Like