MASH SDK

From MASH Wiki

Introduction

The MASH SDK is used to implement new heuristics. It can be downloaded either as a .tar.gz file or as a .zip one. The SDK is implemented in C++ (If you only know C, don't worry: the API is kept very simple and the documentation will show you everything you need to know).

The SDK uses CMake to allows the compilation of the heuristics on any platform. You'll need to install at least the version 2.6.

See the Heuristics development page for details about the compilation of the SDK and how to use it to implement a new heuristic.

Content

The SDK has the following hierarchy of files and folders:

• data/
  • image files
• dependencies/
  • the libraries used: FreeImage 3.13.1 (under the FreeImage Public License) and SimpleOpt 3.4 (under the MIT Licence)
• heuristics/
  • examples/
    • the example heuristics
  • template.cpp (the template file that you can use to implement your heuristics)
• sdk/
  • testheuristic.cpp (source code of the program that you'll use to test your heuristics)
• mash/
  • source code of the MASH library
• create_heuristic.py (a Python script that can help you to create a new heuristic)

Implementation of a new heuristic

Note: This is a very quick introduction, see the Heuristics development page for step-by-step instructions.

To implement a heuristic, you'll use only two classes from the SDK: Heuristic and Image.

Once compiled, you can test your heuristics using the testheuristic program.

When your heuristic is ready, you'll upload it on the MASH website, on the heuristics page.