/CompareVgImages

A tool to compare Vg images for the learn Ocaml platform

Primary LanguageOCamlMIT LicenseMIT

CompareVgImages

The project


CompareVgImages is a tool to help you compare Vg.image in a different way than with only the I.equal function.


Summary

The Vg module let you use an I.equal function that checks if two images are exactly equals.

However, when you look at two images, they can look alike even if they don't have the same constructors (example the image of an 'L' and the image of a 'J' which was mirrored.

The Compare module tries to check if two images are visually equal.


How it works

Vg.image constructors are hidden, in order to do pattern-matching with a Vg.image you need to reconstruct the constructors tree.

In order to do that we use the Vg.I.to_string function to transform images to string and then, with some custom parsing, we transfom a Vg.image to a Compare.i_tree.

Having this tree we can manipulate the Vg.image infos to try compare them.


When to use

CompareVgImages is made to be used with learn-OCaml, a platform for learning the OCaml language, featuring a Web toplevel, an exercise environment, and a directory of lessons and tutorials.

However, it's utilisation will be more user-friendly with easy-check, a tool to help you correct and grade exercices for the learn-OCaml platform.



Howtos


To learn how to install and use all of these plateform you can check the HOWTO.md file.

If you follow the instructions you'll be able to try the samples given here.

If you need more information about CompareVgImages, feel free to read the documentation or open an issue request ^^ .



Author


CompareVgImages is a tiny free and open source tool.

Made by :

  • Kedadry Yannis, Sorbonne University, Paris, France

Usable for

  • Learn-OCaml by Benjamin Canou, Çağdaş Bozman and Grégoire Henry

  • easy-check by Loïc Sylvestre Sorbonne University, Paris, France