Regex replace "BINDING_PNAME" with "BINDING_NAME".
This commit is contained in:
+11
-11
@@ -130,7 +130,7 @@ using namespace std;
|
||||
// generate documentation for the website.
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Mean Shift Clustering");
|
||||
BINDING_NAME("Mean Shift Clustering");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
@@ -238,7 +238,7 @@ void mlpackMain()
|
||||
@endcode
|
||||
|
||||
We can see that we have defined the basic program information in the
|
||||
@c BINDING_PNAME(), @c BINDING_SHORT_DESC(), @c BINDING_LONG_DESC(),
|
||||
@c BINDING_NAME(), @c BINDING_SHORT_DESC(), @c BINDING_LONG_DESC(),
|
||||
@c BINDING_EXAMPLE() and @c BINDING_SEE_ALSO() macros. This is, for instance,
|
||||
what is displayed to describe the binding if the user passed the
|
||||
<tt>\--help</tt> option for a command-line program.
|
||||
@@ -258,7 +258,7 @@ whether the parameter is input or output. Some examples:
|
||||
Note that each of these macros may have slightly different syntax. See the
|
||||
links above for further documentation.
|
||||
|
||||
In order to write a new binding, then, you simply must write @c BINDING_PNAME(),
|
||||
In order to write a new binding, then, you simply must write @c BINDING_NAME(),
|
||||
@c BINDING_SHORT_DESC(), @c BINDING_LONG_DESC(), @c BINDING_EXAMPLE() and
|
||||
@c BINDING_SEE_ALSO() definitions of the program with some docuentation, define
|
||||
the input and output parameters as @c PARAM macros, and then write an
|
||||
@@ -292,10 +292,10 @@ add a binding for a new mlpack machine learning method. If it is not clear,
|
||||
then the examples in the following sections should clarify.
|
||||
|
||||
@subsection bindings_general_program_doc Documenting a program with
|
||||
@c BINDING_PNAME(), @c BINDING_SHORT_DESC(), @c BINDING_LONG_DESC(),
|
||||
@c BINDING_NAME(), @c BINDING_SHORT_DESC(), @c BINDING_LONG_DESC(),
|
||||
@c BINDING_EXAMPLE() and @c BINDING_SEE_ALSO().
|
||||
|
||||
Any mlpack program should be documented with the @c BINDING_PNAME(),
|
||||
Any mlpack program should be documented with the @c BINDING_NAME(),
|
||||
@c BINDING_SHORT_DESC(), @c BINDING_LONG_DESC() , @c BINDING_EXAMPLE() and
|
||||
@c BINDING_SEE_ALSO() macros, which is available from the
|
||||
@c <mlpack/core/util/mlpack_main.hpp> header. The macro
|
||||
@@ -473,7 +473,7 @@ Go binding output (snippet):
|
||||
Input C++ (full program, 'random_numbers_main.cpp'):
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Random Numbers");
|
||||
BINDING_NAME("Random Numbers");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
@@ -822,7 +822,7 @@ could be created for the "random_numbers" program from earlier sections.
|
||||
@code
|
||||
#include <mlpack/core/util/mlpack_main.hpp>
|
||||
|
||||
// BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC() , BINDING_EXAMPLE(),
|
||||
// BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC() , BINDING_EXAMPLE(),
|
||||
// BINDING_SEE_ALSO() and PARAM_*() definitions should go here:
|
||||
// ...
|
||||
|
||||
@@ -883,7 +883,7 @@ There are eight main components involved with mlpack bindings:
|
||||
|
||||
- the IO module, a singleton class that stores parameter information
|
||||
- the mlpackMain() function that defines the functionality of the binding
|
||||
- the BINDING_PNAME() macro that defines the binding name
|
||||
- the BINDING_NAME() macro that defines the binding name
|
||||
- the BINDING_SHORT_DESC() macro that defines the short description
|
||||
- the BINDING_LONG_DESC() macro that defines the long description
|
||||
- the BINDING_EXAMPLE() macro that defines the example
|
||||
@@ -893,12 +893,12 @@ There are eight main components involved with mlpack bindings:
|
||||
The mlpack::IO module is a singleton class that stores, at runtime, the binding
|
||||
name, the documentation, and the parameter information and values. In order to
|
||||
do this, each parameter and the program documentation must make themselves known
|
||||
to the IO singleton. This is accomplished by having the @c BINDING_PNAME(),
|
||||
to the IO singleton. This is accomplished by having the @c BINDING_NAME(),
|
||||
@c BINDING_SHORT_DESC(), @c BINDING_LONG_DESC(), @c BINDING_EXAMPLE(),
|
||||
@c BINDING_SEE_ALSO() and @c PARAM_*() macros declare global variables that,
|
||||
in their constructors, register themselves with the IO singleton.
|
||||
|
||||
The @c BINDING_PNAME() macro declares an object of type mlpack::util::ProgramName.
|
||||
The @c BINDING_NAME() macro declares an object of type mlpack::util::ProgramName.
|
||||
The @c BINDING_SHORT_DESC() macro declares an object of type
|
||||
mlpack::util::ShortDescription.
|
||||
The @c BINDING_LONG_DESC() macro declares an object of type
|
||||
@@ -1188,7 +1188,7 @@ individually if you like). The file
|
||||
the name of the program and the @c *_main.cpp file to include correctly, then
|
||||
the @c mlpack::bindings::python::PrintPYX() function is called by the program.
|
||||
The @c PrintPYX() function uses the parameters that have been set in the IO
|
||||
singleton by the @c BINDING_PNAME(), @c BINDING_SHORT_DESC(),
|
||||
singleton by the @c BINDING_NAME(), @c BINDING_SHORT_DESC(),
|
||||
@c BINDING_LONG_DESC(), @c BINDING_EXAMPLE(), @c BINDING_SEE_ALSO() and
|
||||
@c PARAM_*() macros in order to actually print a fully-working .pyx file that
|
||||
can be compiled. The file has several sections:
|
||||
|
||||
+2
-2
@@ -120,7 +120,7 @@ and debugging output for your mlpack program.
|
||||
@section simpleio Simple IO Example
|
||||
|
||||
Through the mlpack::IO object, command-line parameters can be easily added
|
||||
with the BINDING_PNAME, BINDING_SHORT_DESC, BINDING_LONG_DESC, BINDING_EXAMPLE,
|
||||
with the BINDING_NAME, BINDING_SHORT_DESC, BINDING_LONG_DESC, BINDING_EXAMPLE,
|
||||
BINDING_SEE_ALSO, PARAM_INT, PARAM_DOUBLE, PARAM_STRING, and PARAM_FLAG
|
||||
macros.
|
||||
|
||||
@@ -133,7 +133,7 @@ Here is a sample use of those macros, extracted from methods/pca/pca_main.cpp.
|
||||
#include <mlpack/core/util/mlpack_main.hpp>
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Principal Components Analysis");
|
||||
BINDING_NAME("Principal Components Analysis");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -19,7 +19,7 @@ using namespace mlpack;
|
||||
using namespace mlpack::kernel;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Golang binding test");
|
||||
BINDING_NAME("Golang binding test");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -19,7 +19,7 @@ using namespace mlpack;
|
||||
using namespace mlpack::kernel;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Julia binding test");
|
||||
BINDING_NAME("Julia binding test");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
* http://www.opensource.org/licenses/BSD-3-Clause for more information.
|
||||
*/
|
||||
|
||||
#define BINDING_NAME "${BINDING}"
|
||||
#define MARKDOWN_BINDING_NAME "${BINDING}"
|
||||
|
||||
#include <mlpack/core.hpp>
|
||||
#include "generate_markdown.${BINDING}.hpp"
|
||||
|
||||
@@ -69,7 +69,7 @@ void PrintDocs(const std::string& bindingName,
|
||||
cout << endl;
|
||||
|
||||
// Next, print the logical name of the binding (that's known by
|
||||
// BINDING_PNAME()).
|
||||
// BINDING_NAME()).
|
||||
cout << "#### " << programName.programName << endl;
|
||||
cout << endl;
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ using namespace mlpack;
|
||||
using namespace mlpack::kernel;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Python binding test");
|
||||
BINDING_NAME("Python binding test");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -260,7 +260,7 @@ std::map<char, std::string>& IO::Aliases()
|
||||
return GetSingleton().aliases;
|
||||
}
|
||||
|
||||
// Get the program name as set by BINDING_PNAME().
|
||||
// Get the program name as set by BINDING_NAME().
|
||||
std::string IO::ProgramName()
|
||||
{
|
||||
return GetSingleton().pname->programName;
|
||||
|
||||
@@ -119,18 +119,18 @@ class SeeAlso;
|
||||
* @section bindingseealso Documenting the seeAlso.
|
||||
*
|
||||
* In addition to allowing documentation for each individual parameter and
|
||||
* module, the BINDING_PNAME() macro provides support for documenting the
|
||||
* module, the BINDING_NAME() macro provides support for documenting the
|
||||
* programName, BINDING_SHORT_DESC() macro provides support for documenting the
|
||||
* shortDescription, BINDING_LONG_DESC() macro provides support for documenting
|
||||
* the longDescription, the BINDING_EXAMPLE() macro provides support for
|
||||
* documenting the example and the BINDING_SEE_ALSO() macro provides support for
|
||||
* documenting the seeAlso. There should only be one instance of the
|
||||
* BINDING_PNAME(), BINDING_SHORT_DESC() and BINDING_LONG_DESC() macros and there
|
||||
* BINDING_NAME(), BINDING_SHORT_DESC() and BINDING_LONG_DESC() macros and there
|
||||
* can be multiple instance of BINDING_EXAMPLE() and BINDING_SEE_ALSO() macro.
|
||||
* Below is an example:
|
||||
*
|
||||
* @code
|
||||
* BINDING_PNAME("Maximum Variance Unfolding");
|
||||
* BINDING_NAME("Maximum Variance Unfolding");
|
||||
* BINDING_SHORT_DESC("An implementation of Maximum Variance Unfolding");
|
||||
* BINDING_LONG_DESC( "This program performs maximum "
|
||||
* "variance unfolding on the given dataset, writing a lower-dimensional "
|
||||
@@ -322,7 +322,7 @@ class IO
|
||||
//! Return a modifiable list of aliases that IO knows about.
|
||||
static std::map<char, std::string>& Aliases();
|
||||
|
||||
//! Get the program name as set by the BINDING_PNAME() macro.
|
||||
//! Get the program name as set by the BINDING_NAME() macro.
|
||||
static std::string ProgramName();
|
||||
|
||||
/**
|
||||
|
||||
@@ -211,8 +211,8 @@ using Option = mlpack::bindings::python::PyOption<T>;
|
||||
static const std::string testName = "";
|
||||
#include <mlpack/core/util/param.hpp>
|
||||
|
||||
#undef BINDING_PNAME
|
||||
#define BINDING_PNAME(NAME) static \
|
||||
#undef BINDING_NAME
|
||||
#define BINDING_NAME(NAME) static \
|
||||
mlpack::util::ProgramName \
|
||||
io_programname_dummy_object = mlpack::util::ProgramName(NAME); \
|
||||
namespace mlpack { \
|
||||
@@ -259,8 +259,8 @@ using Option = mlpack::bindings::julia::JuliaOption<T>;
|
||||
static const std::string testName = "";
|
||||
#include <mlpack/core/util/param.hpp>
|
||||
|
||||
#undef BINDING_PNAME
|
||||
#define BINDING_PNAME(NAME) static \
|
||||
#undef BINDING_NAME
|
||||
#define BINDING_NAME(NAME) static \
|
||||
mlpack::util::ProgramName \
|
||||
io_programname_dummy_object = mlpack::util::ProgramName(NAME); \
|
||||
namespace mlpack { \
|
||||
@@ -303,8 +303,8 @@ using Option = mlpack::bindings::go::GoOption<T>;
|
||||
static const std::string testName = "";
|
||||
#include <mlpack/core/util/param.hpp>
|
||||
|
||||
#undef BINDING_PNAME
|
||||
#define BINDING_PNAME(NAME) static \
|
||||
#undef BINDING_NAME
|
||||
#define BINDING_NAME(NAME) static \
|
||||
mlpack::util::ProgramName \
|
||||
io_programname_dummy_object = mlpack::util::ProgramName(NAME); \
|
||||
namespace mlpack { \
|
||||
@@ -322,11 +322,11 @@ PARAM_FLAG("verbose", "Display informational messages and the full list of "
|
||||
|
||||
#elif BINDING_TYPE == BINDING_TYPE_MARKDOWN
|
||||
|
||||
// We use BINDING_NAME in BINDING_PNAME(), BINDING_SHORT_DESC(),
|
||||
// We use MARKDOWN_BINDING_NAME in BINDING_NAME(), BINDING_SHORT_DESC(),
|
||||
// BINDING_LONG_DESC(), BINDING_EXAMPLE() and BINDING_SEE_ALSO()
|
||||
// so it needs to be defined.
|
||||
#ifndef BINDING_NAME
|
||||
#error "BINDING_NAME must be defined when BINDING_TYPE is Markdown!"
|
||||
#ifndef MARKDOWN_BINDING_NAME
|
||||
#error "MARKDOWN_BINDING_NAME must be defined when BINDING_TYPE is Markdown!"
|
||||
#endif
|
||||
|
||||
// This value doesn't actually matter, but it needs to be defined as something.
|
||||
@@ -389,53 +389,53 @@ using Option = mlpack::bindings::markdown::MDOption<T>;
|
||||
#include <mlpack/core/util/param.hpp>
|
||||
#include <mlpack/bindings/markdown/program_doc_wrapper.hpp>
|
||||
|
||||
#undef BINDING_PNAME
|
||||
#undef BINDING_NAME
|
||||
#undef BINDING_SHORT_DESC
|
||||
#undef BINDING_LONG_DESC
|
||||
#undef BINDING_EXAMPLE
|
||||
#undef BINDING_SEE_ALSO
|
||||
|
||||
#define BINDING_PNAME(NAME) static \
|
||||
#define BINDING_NAME(NAME) static \
|
||||
mlpack::bindings::markdown::ProgramNameWrapper \
|
||||
io_programname_dummy_object = \
|
||||
mlpack::bindings::markdown::ProgramNameWrapper( \
|
||||
BINDING_NAME, NAME);
|
||||
MARKDOWN_BINDING_NAME, NAME);
|
||||
|
||||
#define BINDING_SHORT_DESC(SHORT_DESC) static \
|
||||
mlpack::bindings::markdown::ShortDescriptionWrapper \
|
||||
io_programshort_desc_dummy_object = \
|
||||
mlpack::bindings::markdown::ShortDescriptionWrapper( \
|
||||
BINDING_NAME, SHORT_DESC);
|
||||
MARKDOWN_BINDING_NAME, SHORT_DESC);
|
||||
|
||||
#define BINDING_LONG_DESC(LONG_DESC) static \
|
||||
mlpack::bindings::markdown::LongDescriptionWrapper \
|
||||
io_programlong_desc_dummy_object = \
|
||||
mlpack::bindings::markdown::LongDescriptionWrapper( \
|
||||
BINDING_NAME, []() { return std::string(LONG_DESC); });
|
||||
MARKDOWN_BINDING_NAME, []() { return std::string(LONG_DESC); });
|
||||
|
||||
#ifdef __COUNTER__
|
||||
#define BINDING_EXAMPLE(EXAMPLE) static \
|
||||
mlpack::bindings::markdown::ExampleWrapper \
|
||||
JOIN(io_programexample_dummy_object_, __COUNTER__) = \
|
||||
mlpack::bindings::markdown::ExampleWrapper(BINDING_NAME, \
|
||||
mlpack::bindings::markdown::ExampleWrapper(MARKDOWN_BINDING_NAME, \
|
||||
[]() { return(std::string(EXAMPLE)); });
|
||||
|
||||
#define BINDING_SEE_ALSO(DESCRIPTION, LINK) static \
|
||||
mlpack::bindings::markdown::SeeAlsoWrapper \
|
||||
JOIN(io_programsee_also_dummy_object_, __COUNTER__) = \
|
||||
mlpack::bindings::markdown::SeeAlsoWrapper(BINDING_NAME, \
|
||||
mlpack::bindings::markdown::SeeAlsoWrapper(MARKDOWN_BINDING_NAME, \
|
||||
DESCRIPTION, LINK);
|
||||
#else
|
||||
#define BINDING_EXAMPLE(EXAMPLE) static \
|
||||
mlpack::bindings::markdown::ExampleWrapper \
|
||||
JOIN(JOIN(io_programexample_dummy_object_, __LINE__), opt) = \
|
||||
mlpack::bindings::markdown::ExampleWrapper(BINDING_NAME, \
|
||||
mlpack::bindings::markdown::ExampleWrapper(MARKDOWN_BINDING_NAME, \
|
||||
[]() { return(std::string(EXAMPLE)); });
|
||||
|
||||
#define BINDING_SEE_ALSO(DESCRIPTION, LINK) static \
|
||||
mlpack::bindings::markdown::SeeAlsoWrapper \
|
||||
JOIN(JOIN(io_programsee_also_dummy_object_, __LINE__), opt) = \
|
||||
mlpack::bindings::markdown::SeeAlsoWrapper(BINDING_NAME, \
|
||||
mlpack::bindings::markdown::SeeAlsoWrapper(MARKDOWN_BINDING_NAME, \
|
||||
DESCRIPTION, LINK);
|
||||
#endif
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
*
|
||||
* @param NAME Short string representing the name of the program.
|
||||
*/
|
||||
#define BINDING_PNAME(NAME) static \
|
||||
#define BINDING_NAME(NAME) static \
|
||||
mlpack::util::ProgramName \
|
||||
io_programname_dummy_object = mlpack::util::ProgramName(NAME);
|
||||
|
||||
@@ -173,7 +173,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -200,7 +200,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
* @param DEF Default value of the parameter.
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -232,7 +232,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* printing macros like PRINT_PARAM_STRING() or PRINT_DATASET() or others
|
||||
* here---it will cause problems.
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -259,7 +259,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
* @param DEF Default value of the parameter.
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -290,7 +290,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* printing macros like PRINT_PARAM_STRING() or PRINT_DATASET() or others
|
||||
* here---it will cause problems.
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -319,7 +319,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
* @param DEF Default value of the parameter.
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -351,7 +351,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -926,7 +926,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -960,7 +960,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -1000,7 +1000,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS One-character string representing the alias of the parameter.
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -1113,7 +1113,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -1138,7 +1138,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -1163,7 +1163,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
@@ -1190,7 +1190,7 @@ using DatasetInfo = DatasetMapper<IncrementPolicy, std::string>;
|
||||
* here---it will cause problems.
|
||||
* @param ALIAS An alias for the parameter (one letter).
|
||||
*
|
||||
* @see mlpack::IO, BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* @see mlpack::IO, BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO().
|
||||
*
|
||||
* @bug
|
||||
|
||||
@@ -20,7 +20,7 @@ namespace util {
|
||||
/**
|
||||
* A static object whose constructor registers program documentation with the
|
||||
* IO class. This should not be used outside of IO itself, and you should use
|
||||
* these BINDING_PNAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* these BINDING_NAME(), BINDING_SHORT_DESC(), BINDING_LONG_DESC(),
|
||||
* BINDING_EXAMPLE() and BINDING_SEE_ALSO() macros to declare these objects.
|
||||
* Only correspond object should ever exist.
|
||||
*
|
||||
|
||||
@@ -47,7 +47,7 @@ using namespace mlpack::perceptron;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("AdaBoost");
|
||||
BINDING_NAME("AdaBoost");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -22,7 +22,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Approximate furthest neighbor search");
|
||||
BINDING_NAME("Approximate furthest neighbor search");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -22,7 +22,7 @@ using namespace mlpack::regression;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("BayesianLinearRegression");
|
||||
BINDING_NAME("BayesianLinearRegression");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -42,7 +42,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Collaborative Filtering");
|
||||
BINDING_NAME("Collaborative Filtering");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -28,7 +28,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("DBSCAN clustering");
|
||||
BINDING_NAME("DBSCAN clustering");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -22,7 +22,7 @@ using namespace std;
|
||||
using namespace arma;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Decision Stump");
|
||||
BINDING_NAME("Decision Stump");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -21,7 +21,7 @@ using namespace mlpack::data;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Decision tree");
|
||||
BINDING_NAME("Decision tree");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -20,7 +20,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Density Estimation With Density Estimation Trees");
|
||||
BINDING_NAME("Density Estimation With Density Estimation Trees");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
#include "dtb.hpp"
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Fast Euclidean Minimum Spanning Tree");
|
||||
BINDING_NAME("Fast Euclidean Minimum Spanning Tree");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -25,7 +25,7 @@ using namespace mlpack::metric;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("FastMKS (Fast Max-Kernel Search)");
|
||||
BINDING_NAME("FastMKS (Fast Max-Kernel Search)");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -20,7 +20,7 @@ using namespace mlpack::gmm;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("GMM Sample Generator");
|
||||
BINDING_NAME("GMM Sample Generator");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -20,7 +20,7 @@ using namespace mlpack::gmm;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("GMM Probability Calculator");
|
||||
BINDING_NAME("GMM Probability Calculator");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -27,7 +27,7 @@ using namespace mlpack::kmeans;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Gaussian Mixture Model (GMM) Training");
|
||||
BINDING_NAME("Gaussian Mixture Model (GMM) Training");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -31,7 +31,7 @@ using namespace arma;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Hidden Markov Model (HMM) Sequence Generator");
|
||||
BINDING_NAME("Hidden Markov Model (HMM) Sequence Generator");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -28,7 +28,7 @@ using namespace arma;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Hidden Markov Model (HMM) Sequence Log-Likelihood");
|
||||
BINDING_NAME("Hidden Markov Model (HMM) Sequence Log-Likelihood");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -29,7 +29,7 @@ using namespace arma;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Hidden Markov Model (HMM) Training");
|
||||
BINDING_NAME("Hidden Markov Model (HMM) Training");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -29,7 +29,7 @@ using namespace arma;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Hidden Markov Model (HMM) Viterbi State Prediction");
|
||||
BINDING_NAME("Hidden Markov Model (HMM) Viterbi State Prediction");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -26,7 +26,7 @@ using namespace mlpack::data;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Hoeffding trees");
|
||||
BINDING_NAME("Hoeffding trees");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -23,7 +23,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Kernel Density Estimation");
|
||||
BINDING_NAME("Kernel Density Estimation");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -41,7 +41,7 @@ using namespace std;
|
||||
using namespace arma;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Kernel Principal Components Analysis");
|
||||
BINDING_NAME("Kernel Principal Components Analysis");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -28,7 +28,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("K-Means Clustering");
|
||||
BINDING_NAME("K-Means Clustering");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -22,7 +22,7 @@ using namespace mlpack::regression;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("LARS");
|
||||
BINDING_NAME("LARS");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -22,7 +22,7 @@ using namespace arma;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Simple Linear Regression and Prediction");
|
||||
BINDING_NAME("Simple Linear Regression and Prediction");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -24,7 +24,7 @@ using namespace mlpack::svm;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Linear SVM is an L2-regularized support vector machine.");
|
||||
BINDING_NAME("Linear SVM is an L2-regularized support vector machine.");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
#include <ensmallen.hpp>
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Large Margin Nearest Neighbors (LMNN)");
|
||||
BINDING_NAME("Large Margin Nearest Neighbors (LMNN)");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -24,7 +24,7 @@ using namespace mlpack::sparse_coding; // For NothingInitializer.
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Local Coordinate Coding");
|
||||
BINDING_NAME("Local Coordinate Coding");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -23,7 +23,7 @@ using namespace mlpack::regression;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("L2-regularized Logistic Regression and Prediction");
|
||||
BINDING_NAME("L2-regularized Logistic Regression and Prediction");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -24,7 +24,7 @@ using namespace mlpack::neighbor;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("K-Approximate-Nearest-Neighbor Search with LSH");
|
||||
BINDING_NAME("K-Approximate-Nearest-Neighbor Search with LSH");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -23,7 +23,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Mean Shift Clustering");
|
||||
BINDING_NAME("Mean Shift Clustering");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
#include "mvu.hpp"
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Maximum Variance Unfolding (MVU)");
|
||||
BINDING_NAME("Maximum Variance Unfolding (MVU)");
|
||||
|
||||
// Long description.
|
||||
BINDING_LONG_DESC("This program implements "
|
||||
|
||||
@@ -26,7 +26,7 @@ using namespace std;
|
||||
using namespace arma;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Parametric Naive Bayes Classifier");
|
||||
BINDING_NAME("Parametric Naive Bayes Classifier");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
#include <ensmallen.hpp>
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Neighborhood Components Analysis (NCA)");
|
||||
BINDING_NAME("Neighborhood Components Analysis (NCA)");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -33,7 +33,7 @@ using namespace mlpack::util;
|
||||
typedef NSModel<FurthestNS> KFNModel;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("k-Furthest-Neighbors Search");
|
||||
BINDING_NAME("k-Furthest-Neighbors Search");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -35,7 +35,7 @@ using namespace mlpack::util;
|
||||
typedef NSModel<NearestNeighborSort> KNNModel;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("k-Nearest-Neighbors Search");
|
||||
BINDING_NAME("k-Nearest-Neighbors Search");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -28,7 +28,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Non-negative Matrix Factorization");
|
||||
BINDING_NAME("Non-negative Matrix Factorization");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -26,7 +26,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Principal Components Analysis");
|
||||
BINDING_NAME("Principal Components Analysis");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -26,7 +26,7 @@ using namespace std;
|
||||
using namespace arma;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Perceptron");
|
||||
BINDING_NAME("Perceptron");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -21,7 +21,7 @@ using namespace std;
|
||||
using namespace mlpack::data;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Image Converter");
|
||||
BINDING_NAME("Image Converter");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
#include <mlpack/core/data/binarize.hpp>
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Binarize Data");
|
||||
BINDING_NAME("Binarize Data");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -23,7 +23,7 @@ using namespace std;
|
||||
using namespace boost;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Descriptive Statistics");
|
||||
BINDING_NAME("Descriptive Statistics");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
#include <mlpack/core/data/imputation_methods/listwise_deletion.hpp>
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Impute Data");
|
||||
BINDING_NAME("Impute Data");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -29,7 +29,7 @@ using namespace arma;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Scale Data");
|
||||
BINDING_NAME("Scale Data");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
#include <mlpack/core/data/split_data.hpp>
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Split Data");
|
||||
BINDING_NAME("Split Data");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
#include "radical.hpp"
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("RADICAL");
|
||||
BINDING_NAME("RADICAL");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -20,7 +20,7 @@ using namespace mlpack::util;
|
||||
using namespace std;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Random forests");
|
||||
BINDING_NAME("Random forests");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -28,7 +28,7 @@ using namespace mlpack::metric;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Range Search");
|
||||
BINDING_NAME("Range Search");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -29,7 +29,7 @@ using namespace mlpack::util;
|
||||
typedef RAModel<NearestNeighborSort> RANNModel;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("K-Rank-Approximate-Nearest-Neighbors (kRANN)");
|
||||
BINDING_NAME("K-Rank-Approximate-Nearest-Neighbors (kRANN)");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -24,7 +24,7 @@ using namespace mlpack::regression;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Softmax Regression");
|
||||
BINDING_NAME("Softmax Regression");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
@@ -23,7 +23,7 @@ using namespace mlpack::sparse_coding;
|
||||
using namespace mlpack::util;
|
||||
|
||||
// Program Name.
|
||||
BINDING_PNAME("Sparse Coding");
|
||||
BINDING_NAME("Sparse Coding");
|
||||
|
||||
// Short description.
|
||||
BINDING_SHORT_DESC(
|
||||
|
||||
Reference in New Issue
Block a user