Manak
2.0.0
|
Manual case registration can only be done inside init function. Check out Set Manual initialization function for setting manual init function.
Simplest manual case registration can be done with the following code
NOTE: 'MANAK_AUTO_MAIN' or 'MANAK_INIT' has to be defined only once in case of multi file project. Check out Using Manak Effectively in Multi File Project for more information.
The function to be registered as a case must have no parameters. The function with parameters can used to generate parametrized benchmark cases. See Complete guide on Parametrized Benchmarking for more information. Also see Advance Function Registration for registration of complex functions such as overloaded functions, template functions and class member functions.
When iteration, tolerance or succes percentage is not specified for any benchmark case the default will be used. See MANAK_DEFAULT_ITERATIONS, MANAK_DEFAULT_TOLERANCE and MANAK_DEFAULT_SP for more details.
The library name is taken as default library name in the simple module. Check out Introduction for how to set default library name of simple module.
Creates a benchmark case with name, benchmark function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, benchmark function, tolerance and iterations. The value of success percentage is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, benchmark function, iterations and success percentage. The value of tolerance is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, benchmark function and tolerance. The values of iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, benchmark function and iterations. The values of tolerance and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name and benchmark function. The values of tolerance, iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates an empty unregistered benchmark suite with name. This benchmark suite can be registred by passing it to any registered benchmark suite by manak::ManakSuite::AddSuite function.
You can also use parametrized benchmarks with manual registartion.
Creates a parametrized benchmark with name, function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, function, tolerance and iterations. The value of success percentage is taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, function, iterations and success percentage. The value of tolerance is taken s default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, function and tolerance. The values of iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, function and iterations. The values of tolerance and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, function. The values of tolerance, iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
For more advance parametrized benchmark options check Complete guide on Parametrized Benchmarking.
Marks the start and end of the group with name. Manak manual group can also be templatized. Use 'MANAK_ADD_GROUP' to register a group. For more advance manual group registration see Tutorial on Using Groups
Note: Manual registration group benchmark cases needs to be done in 'GINIT' function. Remember while initialization only one 'GINIT' function is called depending on the parameters given. This may sometimes be usefull but can also create confusion.
Creates a benchmark case with name, benchmark function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, benchmark function, tolerance and iterations. The value of success percentage is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, benchmark function, iterations and success percentage. The value of tolerance is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, benchmark function and tolerance. The values of iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, benchmark function and iterations. The values of tolerance and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name and benchmark function. The values of tolerance, iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Note: Manual registration group benchmark cases needs to be done in 'GINIT' function. Remember while initialization only one 'GINIT' function is called depending on the parameters given. This may sometimes be usefull but can also create confusion.
You can also use group parametrized benchmarks with manual registartion.
Creates a parametrized benchmark with name, function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, function, tolerance and iterations. The value of success percentage is taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, function, iterations and success percentage. The value of tolerance is taken s default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, function and tolerance. The values of iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, function and iterations. The values of tolerance and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, function. The values of tolerance, iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
For more advance parametrized benchmark options check Complete guide on Parametrized Benchmarking.
For example on simple module manual registration check Example.
Simplest manual case registration can be done with the following code
NOTE: 'MANAK_AUTO_MAIN' or 'MANAK_INIT' has to be defined only once in case of multi file project. Check out Using Manak Effectively in Multi File Project for more information.
The function to be registered as a case must have no parameters. The function with parameters can used to generate parametrized benchmark cases. See Complete guide on Parametrized Benchmarking for more information. Also see Advance Function Registration for registration of complex functions such as overloaded functions, template functions and class member functions.
When iteration, tolerance or succes percentage is not specified for any benchmark case the default will be used. See MANAK_DEFAULT_ITERATIONS, MANAK_DEFAULT_TOLERANCE and MANAK_DEFAULT_SP for more details.
Creates a benchmark case with name, library, benchmark function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, library, benchmark function, tolerance and iterations. The value of success percentage is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, library, benchmark function, iterations and success percentage. The value of tolerance is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, library, benchmark function and tolerance. The values of iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, library, benchmark function and iterations. The values of tolerance and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a benchmark case with name, library and benchmark function. The values of tolerance, iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates an empty unregistered benchmark suite with name. This benchmark suite can be registred by passing it to any registered benchmark suite by manak::ManakSuite::AddSuite function.
You can also use parametrized benchmarks with manual registartion.
Creates a parametrized benchmark with name, library, function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, library, function, tolerance and iterations. The value of success percentage is taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, library, function, iterations and success percentage. The value of tolerance is taken s default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, library, function and tolerance. The values of iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, library, function and iterations. The values of tolerance and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
Creates a parametrized benchmark with name, libary, function. The values of tolerance, iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be passed to manak::ManakSuite::AddCase.
For more advance parametrized benchmark options check Complete guide on Parametrized Benchmarking.
Marks the start and end of the group with name. Manak manual group can also be templatized. Use 'MANAK_ADD_GROUP' to register a group. For more advance manual group registration see Tutorial on Using Groups
Note: Manual registration group benchmark cases needs to be done in 'GINIT' function. Remember while initialization only one 'GINIT' function is called depending on the parameters given. This may sometimes be usefull but can also create confusion.
Creates a benchmark case with name, library, benchmark function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, library, benchmark function, tolerance and iterations. The value of success percentage is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, library, benchmark function, iterations and success percentage. The value of tolerance is taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, library, benchmark function and tolerance. The values of iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, benchmark function and iterations. The values of tolerance and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a benchmark case with name, library and benchmark function. The values of tolerance, iterations and success percentage are taken to be default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Note: Manual registration group benchmark cases needs to be done in 'GINIT' function. Remember while initialization only one 'GINIT' function is called depending on the parameters given. This may sometimes be usefull but can also create confusion.
You can also use group parametrized benchmarks with manual registartion.
Creates a parametrized benchmark with name, library, function, tolerance, iterations and success percentage. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, library, function, tolerance and iterations. The value of success percentage is taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, library, function, iterations and success percentage. The value of tolerance is taken s default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, library, function and tolerance. The values of iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, library, function and iterations. The values of tolerance and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
Creates a parametrized benchmark with name, library, function. The values of tolerance, iterations and succes percentage are taken as default. Returns pointer to created manak::BenchmarkCase object. This can be added to member std::list named 'cases'.
For more advance parametrized benchmark options check Complete guide on Parametrized Benchmarking.
For example on normal module manual registration check Example.