[mlpack-svn] r16313 - mlpack/trunk/src/mlpack/core/util

[fastlab-svn at coffeetalk-1.cc.gatech.edu]

Author: rcurtin
Date: Wed Feb 19 19:15:09 2014
New Revision: 16313

Log:
Add some Armadillo traits for template metaprogramming.  This abstraction may
change as time goes on.


Added:
   mlpack/trunk/src/mlpack/core/util/arma_traits.hpp

Added: mlpack/trunk/src/mlpack/core/util/arma_traits.hpp
==============================================================================
--- (empty file)
+++ mlpack/trunk/src/mlpack/core/util/arma_traits.hpp	Wed Feb 19 19:15:09 2014
@@ -0,0 +1,86 @@
+/**
+ * @file arma_traits.hpp
+ * @author Ryan Curtin
+ *
+ * Some traits used for template metaprogramming (SFINAE) with Armadillo types.
+ */
+#ifndef __MLPACK_CORE_UTIL_ARMA_TRAITS_HPP
+#define __MLPACK_CORE_UTIL_ARMA_TRAITS_HPP
+
+// Structs have public members by default (that's why they are chosen over
+// classes).
+
+/**
+ * If value == true, then VecType is some sort of Armadillo vector or subview.
+ * You might use this struct like this:
+ *
+ * @code
+ * // Only accepts VecTypes that are actually Armadillo vector types.
+ * template<typename VecType>
+ * void Function(const VecType& argumentA,
+ *               typename boost::enable_if<IsVector<VecType> >* = 0);
+ * @endcode
+ *
+ * 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.
+ */
+template<typename VecType>
+struct IsVector
+{
+  const static bool value = false;
+};
+
+template<>
+template<typename eT>
+struct IsVector<arma::Col<eT> >
+{
+  const static bool value = true;
+};
+
+template<>
+template<typename eT>
+struct IsVector<arma::SpCol<eT> >
+{
+  const static bool value = true;
+};
+
+template<>
+template<typename eT>
+struct IsVector<arma::Row<eT> >
+{
+  const static bool value = true;
+};
+
+template<>
+template<typename eT>
+struct IsVector<arma::SpRow<eT> >
+{
+  const static bool value = true;
+};
+
+template<>
+template<typename eT>
+struct IsVector<arma::subview_col<eT> >
+{
+  const static bool value = true;
+};
+
+template<>
+template<typename eT>
+struct IsVector<arma::subview_row<eT> >
+{
+  const static bool value = true;
+};
+
+// I'm not so sure about this one.  An SpSubview object can be a row or column,
+// but it can also be a matrix subview.
+template<>
+template<typename eT>
+struct IsVector<arma::SpSubview<eT> >
+{
+  const static bool value = true;
+};
+
+#endif