.TH "/var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-git/src/mlpack/core/util/param_checks.hpp" 3 "Mon Aug 31 2020" "Version 3.3.2" "mlpack" \" -*- nroff -*-
.ad l
.nh
.SH NAME
/var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-git/src/mlpack/core/util/param_checks.hpp
.SH SYNOPSIS
.br
.PP
.SS "Namespaces"

.in +1c
.ti -1c
.RI " \fBmlpack\fP"
.br
.RI "Linear algebra utility functions, generally performed on matrices or vectors\&. "
.ti -1c
.RI " \fBmlpack::util\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBReportIgnoredParam\fP (const std::vector< std::pair< std::string, bool >> &constraints, const std::string &paramName)"
.br
.RI "Report that a parameter is ignored, if each of the constraints given are satisfied\&. "
.ti -1c
.RI "void \fBReportIgnoredParam\fP (const std::string &paramName, const std::string &reason)"
.br
.RI "If the given parameter is passed, report that it is ignored, supplying a custom reason\&. "
.ti -1c
.RI "void \fBRequireAtLeastOnePassed\fP (const std::vector< std::string > &constraints, const bool fatal=true, const std::string &customErrorMessage='')"
.br
.RI "Require that at least one of the given parameters in the constraints set was passed to the \fBIO\fP object; otherwise, issue a warning or fatal error, optionally with the given custom error message\&. "
.ti -1c
.RI "void \fBRequireNoneOrAllPassed\fP (const std::vector< std::string > &constraints, const bool fatal=true, const std::string &customErrorMessage='')"
.br
.RI "Require that either none or all of the given parameters in the constraints set were passed to the \fBIO\fP object; otherwise, issue a warning or fatal error, optionally with the given custom error message\&. "
.ti -1c
.RI "void \fBRequireOnlyOnePassed\fP (const std::vector< std::string > &constraints, const bool fatal=true, const std::string &customErrorMessage='')"
.br
.RI "Require that only one of the given parameters in the constraints set was passed to the \fBIO\fP object; otherwise, issue a warning or fatal error, optionally with the given custom error message\&. "
.ti -1c
.RI "template<typename T > void \fBRequireParamInSet\fP (const std::string &paramName, const std::vector< T > &\fBset\fP, const bool fatal, const std::string &errorMessage)"
.br
.RI "Require that a given parameter is in a set of allowable parameters\&. "
.ti -1c
.RI "template<typename T > void \fBRequireParamValue\fP (const std::string &paramName, const std::function< bool(T)> &conditional, const bool fatal, const std::string &errorMessage)"
.br
.RI "Require that a given parameter satisfies the given conditional function\&. "
.in -1c
.SH "Detailed Description"
.PP 

.PP
\fBAuthor:\fP
.RS 4
Ryan Curtin
.RE
.PP
A set of utility functions to check parameter values for mlpack programs\&. These are meant to be used as the first part of an mlpackMain() function, to validate parameters\&.
.PP
mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license\&. You should have received a copy of the 3-clause BSD license along with mlpack\&. If not, see http://www.opensource.org/licenses/BSD-3-Clause for more information\&. 
.PP
Definition in file \fBparam_checks\&.hpp\fP\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for mlpack from the source code\&.