fixed.hpp File Reference

#include <type_traits>
#include <mlpack/core.hpp>

Include dependency graph for fixed.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	mlpack::hpt::PreFixedArg< T >
	A struct for marking arguments as ones that should be fixed (it can be useful for the Optimize method of HyperParameterTuner). More...
struct	mlpack::hpt::FixedArg< T, I >
	A struct for storing information about a fixed argument. More...
struct	mlpack::hpt::PreFixedArg< T >
	A struct for marking arguments as ones that should be fixed (it can be useful for the Optimize method of HyperParameterTuner). More...
struct	mlpack::hpt::PreFixedArg< T & >
	The specialization of the template for references. More...
class	mlpack::hpt::IsPreFixedArg< T >
	A type function for checking whether the given type is PreFixedArg. More...

Namespaces
	mlpack
	Linear algebra utility functions, generally performed on matrices or vectors.

Functions
template<typename T >
PreFixedArg< T >	mlpack::hpt::Fixed (T &&value)
	Mark the given argument as one that should be fixed. More...

Detailed Description

Author

Kirill Mishchenko

Facilities for supporting fixed arguments.

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.

Function Documentation

Fixed()

template<typename T >

PreFixedArg<T> mlpack::hpt::Fixed

(

T &&

value

)

Mark the given argument as one that should be fixed.

It can be applied to arguments that are passed to the Optimize method of HyperParameterTuner.

The implementation avoids data copying. If the passed argument is an l-value reference, we store it as a const l-value rerefence inside the returned PreFixedArg object. If the passed argument is an r-value reference, light-weight copying (by taking possession of the r-value) will be made during the initialization of the returned PreFixedArg object.