JPlag icon indicating copy to clipboard operation
JPlag copied to clipboard

Return normalized comparison similarity value (interval [0, 1])

Open JanWittler opened this issue 2 years ago • 1 comments

Currently, JPlagComparison returns a value between 0 and 100 for the similarity. This is not really intuitive and probably makes computation on these values more complex.

Instead, I would propose to return a value between 0 and 1. This will require adjustments in the results visualization and maybe in the results serialisation.

JanWittler avatar Aug 03 '22 12:08 JanWittler

Regarding intuition, the methods of the comparison class are clearly documented, so it should be really obvious that it is a percentage. I am not entirely convinced, that switching to normalized value will bring many benefits. It just moves the complexity into the report viewer and creates a divide between the programmatic usage of JPlag and the usage via CLI and the report viewer.

tsaglam avatar Aug 03 '22 13:08 tsaglam

Internal discussion results in the decision to normalize similarity in the result object but not in the report viewer. In the viewer, we depict %.

tsaglam avatar Sep 07 '22 11:09 tsaglam