main_test_fixture.hpp

Go to the documentation of this file.

#ifndef MLPACK_TESTS_MAIN_TEST_FIXTURE_HPP
#define MLPACK_TESTS_MAIN_TEST_FIXTURE_HPP

#include <mlpack/core.hpp>
#include <mlpack/core/util/params.hpp>
#include <mlpack/bindings/tests/test_function_map.hpp>

#define BINDING_TEST_FIXTURE(CLASS_NAME) \
    class CLASS_NAME : public MainTestFixture \
    { \
     public: \
      CLASS_NAME() : MainTestFixture(IO::Parameters(STRINGIFY(BINDING_NAME))) \
      { } \
    };

#define RUN_BINDING() BINDING_FUNCTION(params, timers)

class MainTestFixture
{
 public:
  MainTestFixture(const util::Params& paramsIn) :
      paramsClean(paramsIn)
  {
    // For a test binding, the parameters will not have the correct maps in
    // `functionMap`.  This is because the test executable may also be adding
    // options for different binding types (which happens in
    // `cli_binding_test.cpp`, for instance).  Therefore, we have to ensure that
    // the right functions are in the function map, for every type that appears
    // in any binding.
    paramsClean.functionMap =
        mlpack::bindings::tests::TestFunctionMap::FunctionMap();

    params = paramsClean;
  }

  ~MainTestFixture()
  {
    // Clean any allocated memory associated with any parameters.
    CleanMemory();
  }

  void ResetSettings()
  {
    // Reset the parameters.
    params = paramsClean;

    // Reset the timers too...
    timers.StopAllTimers();
    timers.Reset();
  }

  void CleanMemory()
  {
    bindings::tests::CleanMemory(params);
  }

  template<typename T>
  void SetInputParam(const std::string& name, T&& value)
  {
    params.Get<typename std::remove_reference<T>::type>(name) =
        std::forward<T>(value);
    params.SetPassed(name);
  }

 protected:
  util::Params paramsClean;
  util::Params params;
  util::Timers timers;
};

#endif