Windowing

docs/changelog.rst

@@ -35,6 +35,8 @@ v0.2 (not yet released)
 * Views:
     - Assign names to signals and outputs (`names_view`) `#181 <https://github.com/lsils/mockturtle/pull/181>`_ `#184 <https://github.com/lsils/mockturtle/pull/184>`_
     - Creates a CNF while creating a network (`cnf_view`) `#274 <https://github.com/lsils/mockturtle/pull/274>`_
+    - Revised window view (`window_view`) `#381 <https://github.com/lsils/mockturtle/pull/381>`_
+    - In-place and out-of-place color view (`color_view`, `out_of_place_color_view`) `#381 <https://github.com/lsils/mockturtle/pull/381>`_
 * I/O:
     - Write networks to DIMACS files for CNF (`write_dimacs`) `#146 <https://github.com/lsils/mockturtle/pull/146>`_
     - Read BLIF files using *lorina* (`blif_reader`) `#167 <https://github.com/lsils/mockturtle/pull/167>`_
@@ -63,6 +65,8 @@ v0.2 (not yet released)
     - Random logic networks for XAGs (`random_logic_generator`) `#366 <https://github.com/lsils/mockturtle/pull/366>`_
 * Properties:
     - Costs based on multiplicative complexity (`multiplicative_complexity` and `multiplicative_complexity_depth`) `#170 <https://github.com/lsils/mockturtle/pull/170>`_
+* Utils:
+    - Computing windows and manipulating cuts (`create_window_impl`, `collect_nodes`, `collect_inputs`, `collect_outputs`, `expand0_towards_tfi`, `expand_towards_tfi`, `expand_towards_tfo`, `levelized_expand_towards_tfo`) `#381 <https://github.com/lsils/mockturtle/pull/381>`_
 
 v0.1 (March 31, 2019)
 ---------------------

docs/implementations.rst

@@ -284,3 +284,17 @@ All network implementations are located in `mockturtle/networks/`:
 +--------------------------------+-------------+-------------+-------------+-------------+-----------------+
 | ``get_output_name``            |             |             |             |             |                 |
 +--------------------------------+-------------+-------------+-------------+-------------+-----------------+
+|                                | *Coloring methods*                                                      |
++--------------------------------+-------------+-------------+-------------+-------------+-----------------+
+| ``new_color``                  |             |             |             |             |                 |
++--------------------------------+-------------+-------------+-------------+-------------+-----------------+
+| ``current_color``              |             |             |             |             |                 |
++--------------------------------+-------------+-------------+-------------+-------------+-----------------+
+| ``color``                      |             |             |             |             |                 |
++--------------------------------+-------------+-------------+-------------+-------------+-----------------+
+| ``paint``                      |             |             |             |             |                 |
++--------------------------------+-------------+-------------+-------------+-------------+-----------------+
+| ``eval_color``                 |             |             |             |             |                 |
++--------------------------------+-------------+-------------+-------------+-------------+-----------------+
+| ``eval_fanins_color``          |             |             |             |             |                 |
++--------------------------------+-------------+-------------+-------------+-------------+-----------------+

docs/views.rst

@@ -89,3 +89,14 @@ algorithm.  Several views are implemented in mockturtle.
 
 .. doxygenclass:: mockturtle::cnf_view
    :members:
+
+`color_view`: Manages traversal IDs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Header:** ``mockturtle/views/color_view.hpp``
+
+.. doxygenclass:: mockturtle::color_view
+   :members:
+
+ .. doxygenclass:: mockturtle::out_of_place_color_view
+   :members:

include/mockturtle/algorithms/dont_cares.hpp

@@ -44,6 +44,7 @@
 #include "../views/fanout_view.hpp"
 #include "../views/topo_view.hpp"
 #include "../views/window_view.hpp"
+#include "../views/color_view.hpp"
 
 #include <fmt/format.h>
 #include <kitty/bit_operations.hpp>
@@ -74,8 +75,10 @@ kitty::dynamic_truth_table satisfiability_dont_cares( Ntk const& ntk, std::vecto
 
   fanout_view<Ntk> fanout_ntk{ntk};
   fanout_ntk.clear_visited();
+  color_view<Ntk> color_ntk{fanout_ntk};
 
-  window_view<fanout_view<Ntk>> window_ntk{fanout_ntk, extended_leaves, leaves, false};
+  std::vector<node<Ntk>> gates{collect_nodes( color_ntk, extended_leaves, leaves )};
+  window_view window_ntk{color_ntk, extended_leaves, leaves, gates};
 
   default_simulator<kitty::dynamic_truth_table> sim( window_ntk.num_pis() );
   const auto tts = simulate_nodes<kitty::dynamic_truth_table>( window_ntk, sim );
@@ -110,8 +113,10 @@ kitty::dynamic_truth_table observability_dont_cares( Ntk const& ntk, node<Ntk> c
 {
   fanout_view<Ntk> fanout_ntk{ntk};
   fanout_ntk.clear_visited();
+  color_view<Ntk> color_ntk{fanout_ntk};
 
-  window_view<fanout_view<Ntk>> window_ntk{fanout_ntk, leaves, roots, false};
+  std::vector<node<Ntk>> gates{collect_nodes( color_ntk, leaves, roots )};
+  window_view window_ntk{color_ntk, leaves, roots, gates};
 
   default_simulator<kitty::dynamic_truth_table> sim( window_ntk.num_pis() );
   unordered_node_map<kitty::dynamic_truth_table, Ntk> node_to_value0( ntk );

include/mockturtle/interface.hpp

@@ -916,17 +916,69 @@ class network final
   /*! \brief Sets the visited value of a node. */
   void set_visited( node const& n, uint32_t v ) const;
 
-  /*! \brief An id that can be used as a visited flag.
-   *
-   * By using the traversal is, one can reuse multiple visited flags over
-   * several levels.
-   */
+  /*! \brief Returns the current traversal id. */
   uint32_t trav_id() const;
 
   /*! \brief Increment the current traversal id. */
   void incr_trav_id() const;
 #pragma endregion
 
+#pragma beginregion Color values
+  /* Color values offer a more recent and flexible mechanism to manage
+     and manipulate traversal ids. */
+
+  /*! \brief Returns a new color and increases the current color. */
+  uint32_t new_color() const;
+
+  /*! \brief Returns the current color. */
+  uint32_t current_color() const;
+
+  /*! \brief Resets all nodes colors to value `color`. */
+  void clear_colors( uint32_t color = 0 ) const;
+
+  /*! \brief Returns the color of a node. */
+  auto color( node const& n ) const;
+
+  /*! \brief Returns the color of a node. */
+  auto color( signal const& n ) const;
+
+  /*! \brief Assigns the current color to a node. */
+  void paint( node const& n ) const;
+
+  /*! \brief Assigns `color` to a node. */
+  void paint( node const& n, uint32_t color ) const;
+
+  /*! \brief Copies the color from `other` to `n`. */
+  void paint( node const& n, node const& other ) const;
+
+  /*! \brief Evaluates a predicate on the color of a node.
+   *
+   * The predicate `pred` is any callable that must have the signature
+   * ``bool(color_type)``, where `color_type` is the
+   * implementation-dependent type returned by the method `color`.
+   */
+  template<typename Pred>
+  bool eval_color( node const& n, Pred&& pred ) const;
+
+  /*! \brief Evaluates a predicate on the colors of two nodes.
+   *
+   * The predicate `pred` is any callable that must have the signature
+   * ``bool(color_type,color_type)``, where `color_type` is the
+   * implementation-dependent type returned by the method `color`.
+   */
+  template<typename Pred>
+  bool eval_color( node const& a, node const& b, Pred&& pred ) const;
+
+  /*! \brief Evaluates a predicate on the colors of the fanins of a node.
+   *
+   * The predicate `pred` is any callable that must have the signature
+   * ``bool(color_type)``, where `color_type` is the
+   * implementation-dependent type returned by the method `color`.
+   */
+  template<typename Pred>
+  bool eval_fanins_color( node const& n, Pred&& pred ) const;
+#pragma endregion
+
 #pragma region Signal naming
   /*! \brief Checks if a signal has a name. */
   bool has_name( signal const& s ) const;
@@ -945,7 +997,7 @@ class network final
 
   /*! \brief Returns the name of an output signal. */
   std::string get_output_name( uint32_t index ) const;
-#end endregion
+#pragma endregion
 
 #pragma region General methods
   /*! \brief Returns network events object.

include/mockturtle/traits.hpp

@@ -1943,6 +1943,111 @@ template<class Ntk>
 inline constexpr bool has_has_output_name_v = has_has_output_name<Ntk>::value;
 #pragma endregion
 
+#pragma region has_new_color
+template<class Ntk, class = void>
+struct has_new_color : std::false_type
+{
+};
+
+template<class Ntk>
+struct has_new_color<Ntk, std::void_t<decltype( std::declval<Ntk>().new_color() )>> : std::true_type
+{
+};
+
+template<class Ntk>
+inline constexpr bool has_new_color_v = has_new_color<Ntk>::value;
+#pragma endregion
+
+#pragma region has_current_color
+template<class Ntk, class = void>
+struct has_current_color : std::false_type
+{
+};
+
+template<class Ntk>
+struct has_current_color<Ntk, std::void_t<decltype( std::declval<Ntk>().current_color() )>> : std::true_type
+{
+};
+
+template<class Ntk>
+inline constexpr bool has_current_color_v = has_current_color<Ntk>::value;
+#pragma endregion
+
+#pragma region has_clear_colors
+template<class Ntk, class = void>
+struct has_clear_colors : std::false_type
+{
+};
+
+template<class Ntk>
+struct has_clear_colors<Ntk, std::void_t<decltype( std::declval<Ntk>().clear_colors( uint32_t() ) )>> : std::true_type
+{
+};
+
+template<class Ntk>
+inline constexpr bool has_clear_colors_v = has_clear_colors<Ntk>::value;
+#pragma endregion
+
+#pragma region has_color
+template<class Ntk, class = void>
+struct has_color : std::false_type
+{
+};
+
+template<class Ntk>
+struct has_color<Ntk, std::void_t<decltype( std::declval<Ntk>().color( std::declval<node<Ntk>>() ) )>> : std::true_type
+{
+};
+
+template<class Ntk>
+inline constexpr bool has_color_v = has_color<Ntk>::value;
+#pragma endregion
+
+#pragma region has_paint
+template<class Ntk, class = void>
+struct has_paint : std::false_type
+{
+};
+
+template<class Ntk>
+struct has_paint<Ntk, std::void_t<decltype( std::declval<Ntk>().paint( std::declval<node<Ntk>>() ) )>> : std::true_type
+{
+};
+
+template<class Ntk>
+inline constexpr bool has_paint_v = has_paint<Ntk>::value;
+#pragma endregion
+
+#pragma region has_eval_color
+template<class Ntk, class = void>
+struct has_eval_color : std::false_type
+{
+};
+
+template<class Ntk>
+struct has_eval_color<Ntk, std::void_t<decltype( std::declval<Ntk>().eval_color( std::declval<node<Ntk>>(), std::declval<void( uint32_t )>() ) )>> : std::true_type
+{
+};
+
+template<class Ntk>
+inline constexpr bool has_eval_color_v = has_eval_color<Ntk>::value;
+#pragma endregion
+
+#pragma region has_eval_fanins_color
+template<class Ntk, class = void>
+struct has_eval_fanins_color : std::false_type
+{
+};
+
+template<class Ntk>
+struct has_eval_fanins_color<Ntk, std::void_t<decltype( std::declval<Ntk>().eval_fanins_color( std::declval<node<Ntk>>(), std::declval<void( uint32_t )>() ) )>> : std::true_type
+{
+};
+
+template<class Ntk>
+inline constexpr bool has_eval_fanins_color_v = has_eval_fanins_color<Ntk>::value;
+#pragma endregion
+
 /*! \brief SFINAE based on iterator type (for compute functions).
  */
 template<typename Iterator, typename T>