gz101 / snarfpp Goto Github PK

There are currently two doc strings.

Expected behavior: it should return by value.

Rather than using a size_t type which is 8 bytes wide, it can be done with an int or equivalent which is 4 bytes only.

Expected behavior: deliver a summary of what the original implementation of how the SNARF instance and range query funcitonality works. The current one in this repo does not do the exact same thing. This will unblock work for #12.

Deliverable: a summary document which explains the logic in detail.

Expected behavior: relies on model's size_bytes() function to compute total size of SNARF instance.

Remove the "Project Title" in the README.md file.

Expected behavior: should assert against correct expected size.

The error is:

Assertion failed: snarf.size_bytes() == expected_size, file tests/test_snarf.cpp, line 63

Expected behavior: all functions should be documented.

Use the existing linear spline functionality to build a cubic spline model with unit tests.

Expected behavior: both false positive and true positive must be demonstrated.

Expected behavior: running make examples should compile and run examples/example.cpp.

Expected behavior: should accept argument for make and needs documentation, both in the bash script file and in README.

Expected behavior: containerizing application should not result in a new container or image being constructed on every run/change in source code.

Expected behavior: Should return the correct size of the model in bytes.

Provide contact info and link to license in the README.md file.

Add sphinx docs or equivalent to document all classes and functions.

The entire training data and eCDF is currently contained in the model. This should not be the case.

Expected behavior: All functions in snarf.hpp should be fully tested (and correct).

Users should be able to specify which model to run, not just the default LinearSplineModel as is currently the case in snarf.hpp.

Expected behaviour: should mimic reference implementation.

Expected behavior: SNARF code should have a way to print to console to enable debugging. The parameters of the SNARF instance should be printed at a minimum.