static_checks.hpp File Reference
Include dependency graph for static_checks.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  CheckDecomposableEvaluate< FunctionType >
 Check if a suitable decomposable overload of Evaluate() is available. More...

 
struct  CheckDecomposableEvaluateWithGradient< FunctionType >
 Check if a suitable decomposable overload of EvaluateWithGradient() is available. More...

 
struct  CheckDecomposableGradient< FunctionType >
 Check if a suitable decomposable overload of Gradient() is available. More...

 
struct  CheckEvaluate< FunctionType >
 Check if a suitable overload of Evaluate() is available. More...

 
struct  CheckEvaluateConstraint< FunctionType >
 Check if a suitable overload of EvaluateConstraint() is available. More...

 
struct  CheckEvaluateWithGradient< FunctionType >
 Check if a suitable overload of EvaluateWithGradient() is available. More...

 
struct  CheckGradient< FunctionType >
 Check if a suitable overload of Gradient() is available. More...

 
struct  CheckGradientConstraint< FunctionType >
 Check if a suitable overload of GradientConstraint() is available. More...

 
struct  CheckNumConstraints< FunctionType >
 Check if a suitable overload of NumConstraints() is available. More...

 
struct  CheckNumFeatures< FunctionType >
 Check if a suitable overload of NumFeatures() is available. More...

 
struct  CheckNumFunctions< FunctionType >
 Check if a suitable overload of NumFunctions() is available. More...

 
struct  CheckPartialGradient< FunctionType >
 Check if a suitable overload of PartialGradient() is available. More...

 
struct  CheckShuffle< FunctionType >
 Check if a suitable overload of Shuffle() is available. More...

 
struct  CheckSparseGradient< FunctionType >
 Check if a suitable overload of Gradient() that supports sparse gradients is available. More...

 

Namespaces

 mlpack
 
.hpp
 
 mlpack::optimization
 
 mlpack::optimization::traits
 

Functions

template
<
typename
FunctionType
>
void CheckConstrainedFunctionTypeAPI ()
 Perform checks for the ConstrainedFunctionType API. More...

 
template
<
typename
FunctionType
>
void CheckDecomposableFunctionTypeAPI ()
 Perform checks for the DecomposableFunctionType API. More...

 
template
<
typename
FunctionType
>
void CheckFunctionTypeAPI ()
 Perform checks for the regular FunctionType API. More...

 
template
<
typename
FunctionType
>
void CheckNonDifferentiableDecomposableFunctionTypeAPI ()
 Perform checks for the NonDifferentiableDecomposableFunctionType API. More...

 
template
<
typename
FunctionType
>
void CheckNonDifferentiableFunctionTypeAPI ()
 Perform checks for the NonDifferentiableFunctionType API. More...

 
template
<
typename
FunctionType
>
void CheckResolvableFunctionTypeAPI ()
 Perform checks for the ResolvableFunctionType API. More...

 
template
<
typename
FunctionType
>
void CheckSparseFunctionTypeAPI ()
 Perform checks for the SparseFunctionType API. More...

 

Detailed Description

Author
Shikhar Bhardwaj

This file contains the definitions of the method forms required by the FunctionType API used by the optimizers. These method forms can be used to check the compliance of a user provided FunctionType with the required interface from the optimizer at compile time.

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.

Definition in file static_checks.hpp.