test_option.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_BINDINGS_TESTS_TEST_OPTION_HPP
#define MLPACK_CORE_BINDINGS_TESTS_TEST_OPTION_HPP

#include <string>

#include <mlpack/core/util/io.hpp>
#include "get_printable_param.hpp"
#include "get_param.hpp"
#include "get_allocated_memory.hpp"
#include "delete_allocated_memory.hpp"
#include "test_function_map.hpp"

namespace mlpack {
namespace bindings {
namespace tests {

// Defined in mlpack_main.hpp.
extern std::string programName;

template<typename N>
class TestOption
{
 public:
  TestOption(const N defaultValue,
             const std::string& identifier,
             const std::string& description,
             const std::string& alias,
             const std::string& cppName,
             const bool required = false,
             const bool input = true,
             const bool noTranspose = false,
             const std::string& bindingName = "")
  {
    // Create the ParamData object to give to IO.
    util::ParamData data;

    data.desc = description;
    data.name = identifier;
    data.tname = TYPENAME(N);
    data.alias = alias[0];
    // If this is an output option, set it as passed.
    data.wasPassed = !input;
    data.noTranspose = noTranspose;
    data.required = required;
    data.input = input;
    data.loaded = false;
    data.cppType = cppName;
    data.value = boost::any(defaultValue);

    const std::string tname = data.tname;

    // Set the function pointers in the test function map singleton.  We don't
    // register them with IO::AddFunction(), because these will be restored as
    // part of the test binding fixture; see
    // `src/mlpack/tests/main_tests/main_test_fixture.hpp`.
    TestFunctionMap::RegisterFunction(tname, "GetPrintableParam",
        &GetPrintableParam<N>);
    TestFunctionMap::RegisterFunction(tname, "GetParam", &GetParam<N>);
    TestFunctionMap::RegisterFunction(tname, "GetAllocatedMemory",
        &GetAllocatedMemory<N>);
    TestFunctionMap::RegisterFunction(tname, "DeleteAllocatedMemory",
        &DeleteAllocatedMemory<N>);

    IO::AddParameter(bindingName, std::move(data));
  }
};

} // namespace tests
} // namespace bindings
} // namespace mlpack

#endif