Implements type trait is_truth_table

docs/changelog.rst

@@ -7,6 +7,9 @@ v0.5 (not yet released)
 * Cube methods: ``difference`` (contributed by Heinz Riener)
   `#52 <https://github.com/msoeken/kitty/pull/52>`_
 
+* Type traits: ``is_truth_table``
+  `#53 <https://github.com/msoeken/kitty/pull/53>`_
+
 v0.4 (May 4, 2018)
 ------------------
 

docs/index.rst

@@ -35,6 +35,7 @@ Welcome to kitty's documentation!
    esop
    isop
    cnf
+   traits
    reference
 
 Indices and tables

docs/traits.rst

@@ -0,0 +1,7 @@
+Type traits
+===========
+
+A type trait ``is_truth_table<T>`` can be used to check whether type ``T``
+implements a truth table type.  The value ``is_truth_table<T>::value``
+evaluates to true if ``T`` is ``dynamic_truth_table`` or
+``static_truth_table<NumVars>`` (for any ``NumVars``), and ``false``, otherwise.

include/kitty/kitty.hpp

@@ -52,6 +52,7 @@
 #include "print.hpp"
 #include "properties.hpp"
 #include "spectral.hpp"
+#include "traits.hpp"
 
 /*
          /\___/\

include/kitty/traits.hpp

@@ -0,0 +1,49 @@
+/* kitty: C++ truth table library
+ * Copyright (C) 2017-2018  EPFL
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/*!
+  \file traits.hpp
+  \brief Type traits for truth tables
+
+  \author Mathias Soeken
+*/
+
+#pragma once
+
+#include <type_traits>
+
+namespace kitty
+{
+
+template<class TT>
+struct is_truth_table : std::false_type {};
+
+template<>
+struct is_truth_table<kitty::dynamic_truth_table> : std::true_type {};
+
+template<int NumVars>
+struct is_truth_table<kitty::static_truth_table<NumVars>> : std::true_type {};
+
+}

test/traits.cpp

@@ -0,0 +1,43 @@
+/* kitty: C++ truth table library
+ * Copyright (C) 2017-2018  EPFL
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <gtest/gtest.h>
+
+#include <kitty/dynamic_truth_table.hpp>
+#include <kitty/static_truth_table.hpp>
+#include <kitty/traits.hpp>
+
+using namespace kitty;
+
+TEST( TraitsTest, supports_traits )
+{
+
+EXPECT_TRUE( is_truth_table<dynamic_truth_table>::value );
+EXPECT_TRUE( is_truth_table<static_truth_table<4>>::value );
+EXPECT_TRUE( is_truth_table<static_truth_table<5>>::value );
+EXPECT_TRUE( is_truth_table<static_truth_table<6>>::value );
+EXPECT_FALSE( is_truth_table<uint64_t>::value );
+
+}