HeadAnalyzer.h
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2020,
5  * Max Planck Institute for Intelligent Systems (MPI-IS).
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of the MPI-IS nor the names
19  * of its contributors may be used to endorse or promote products
20  * derived from this software without specific prior written
21  * permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *********************************************************************/
36 
37 /* Author: Andreas Orthey */
38 
39 #pragma once
40 #include <ompl/multilevel/datastructures/pathrestriction/Head.h>
41 
42 namespace ompl
43 {
44  namespace multilevel
45  {
47 
48  OMPL_CLASS_FORWARD(Head);
50  class HeadAnalyzer
51  {
52  public:
55  HeadAnalyzer(HeadPtr &head)
56  {
57  head_ = head;
58  }
59  using OccurenceMap = std::map<std::string, int>;
60 
61  void operator()(std::string s)
62  {
63  if (enabled_)
64  {
65  auto entry = map_.find(s);
66  if (entry == map_.end())
67  {
68  map_[s] = 1;
69  }
70  else
71  {
72  map_[s] = map_[s] + 1;
73  }
74  samples_++;
75  }
76  }
77 
78  void disable()
79  {
80  enabled_ = false;
81  }
82 
83  void clear()
84  {
85  map_.clear();
86  }
87  void print()
88  {
89  if (enabled_)
90  {
91  OccurenceMap::iterator itr;
92  std::cout << std::string(80, '-') << std::endl;
93  std::cout << "HeadAnalyzer (" << samples_ << " samples, location " << head_->getLocationOnBasePath()
94  << ")" << std::endl;
95  for (itr = map_.begin(); itr != map_.end(); ++itr)
96  {
97  std::cout << " > " << itr->first << ": " << itr->second << std::endl;
98  }
99  std::cout << std::string(80, '-') << std::endl;
100  }
101  }
102 
103  private:
104  OccurenceMap map_;
105  int samples_{0};
106  HeadPtr head_;
107 
108  bool enabled_{true};
109  };
110  }
111 }
HeadAnalyzer(HeadPtr &head)
Simple debugger for the Head class to write information continuously onto the terminal.
Definition: HeadAnalyzer.h:157
Main namespace. Contains everything in this library.