IsVector(3)

IsVector3

If value == true, then vectype is some sort of armadillo vector or subview.

Usage

Static Public Attributes

static const bool value = false

Detailed Description

template<typename VecType>struct IsVector< VecType >

If value == true, then VecType is some sort of Armadillo vector or subview.

You might use this struct like this:

// Only accepts VecTypes that are actually Armadillo vector types.
template<typename VecType>
void Function(const VecType& argumentA,
              typename boost::enable_if<IsVector<VecType> >* = 0);

The use of the enable_if object allows the compiler to instantiate Function() only if VecType is one of the Armadillo vector types. It has a default argument because it isn't meant to be used in either the function call or the function body.

Definition at line 45 of file arma_traits.hpp.

Member Data Documentation

template<typename VecType > const bool IsVector< VecType >::value = false [static]

Definition at line 47 of file arma_traits.hpp.

Author

Generated automatically by Doxygen for MLPACK from the source code.

From mlpack-doc 1.0.10-1 in Debian 8 (Jessie). Parsed by carta from the page's man source.