Notes

Dependencies

How to build and install

git clone git@github.com:HDembinski/histogram.git
mkdir build; cd build
cmake ../histogram.git/CMake
make install

Do make test to run the tests, or ctest -V for more output.

Caveat: I couldn’t figure out a proper way to install the Python module with CMake, so for the time being, CMake will print a message with manual instructions instead. The main problem is how to pick the right dist-packages path in a platform-independent way, and such that it respects the CMAKE_INSTALL_PREFIX.

Tests

Most of the C++ interface is implicitly tested in the tests of the Python interface, which in turn calls the C++ interface.

Checks

Some checks are included in test/check. These are not strictly tests, and not strictly examples, yet they provide useful information that belongs with the library code. They are not build by default, building can be activated with the CMake flag BUILD_CHECKS.

Consistency of C++ and Python interface

The Python and C++ interface are indentical - except when they are not. The exceptions concern cases where a more elegant and pythonic way of implementing things exists. In a few cases, the C++ classes have extra member functions for convenience, which are not needed on the Python side.

Properties
Getter/setter-like functions are wrapped as properties.
Keyword-based parameters
C++ member functions histogram::fill() and histogram::wfill() are wrapped by the single Python member function histogram.fill() with an optional keyword parameter w to pass a weight.
C++ convenience
C++ member function histogram::bins() is omitted on the Python side, since it is very easy to just query this directly from the axis object in Python. On the C++ side, this would require a extra type cast or applying a visitor.