v0.2.48..v0.2.49 changeset RandomElementRenamer.h

diff --git a/hoot-core/src/main/cpp/hoot/core/visitors/RandomElementRenamer.h b/hoot-core/src/main/cpp/hoot/core/visitors/RandomElementRenamer.h
new file mode 100644
index 0000000..a3ed08f
--- /dev/null
+++ b/hoot-core/src/main/cpp/hoot/core/visitors/RandomElementRenamer.h
@@ -0,0 +1,88 @@
+/*
+ * This file is part of Hootenanny.
+ *
+ * Hootenanny is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * --------------------------------------------------------------------
+ *
+ * The following copyright notices are generated automatically. If you
+ * have a new notice to add, please use the format:
+ * " * @copyright Copyright ..."
+ * This will properly maintain the copyright information. DigitalGlobe
+ * copyrights will be updated automatically.
+ *
+ * @copyright Copyright (C) 2015, 2017, 2018, 2019 DigitalGlobe (http://www.digitalglobe.com/)
+ */
+#ifndef RANDOM_ELEMENT_RENAMER_H
+#define RANDOM_ELEMENT_RENAMER_H
+
+// hoot
+#include <hoot/core/elements/ElementVisitor.h>
+#include <hoot/core/util/Configurable.h>
+#include <hoot/core/util/RngConsumer.h>
+#include <hoot/core/info/OperationStatusInfo.h>
+
+namespace hoot
+{
+
+/**
+ * A simple random name changer. This is not part of the original PERTY paper.
+ */
+class RandomElementRenamer : public ElementVisitor, public RngConsumer, public Configurable,
+  public OperationStatusInfo
+{
+public:
+
+  static std::string className() { return "hoot::RandomElementRenamer"; }
+
+  RandomElementRenamer();
+
+  QString permuteName(const QString& s);
+
+  virtual void setConfiguration(const Settings& conf);
+
+  /**
+   * The probability of a change to each character in the name. The expected number of changes is
+   * perty.name.change.p * str.size()
+   */
+  void setChangeProbability(double changeP) { _changeP = changeP; }
+
+  /**
+   * Set the probability that a name will be modified.
+   */
+  void setProbability(double p) { _p = p; }
+
+  virtual void setRng(boost::minstd_rand& rng) { _rng = &rng; }
+
+  virtual void visit(const std::shared_ptr<Element>& e) override;
+
+  virtual QString getDescription() const { return "Randomly changes element names"; }
+
+  virtual QString getInitStatusMessage() const
+  { return "Randomly changing element names..."; }
+
+  virtual QString getCompletedStatusMessage() const
+  { return "Randomly changed " + QString::number(_numAffected) + " element names"; }
+
+private:
+
+  double _changeP;
+  double _p;
+  boost::minstd_rand* _rng;
+  std::shared_ptr<boost::minstd_rand> _localRng;
+};
+
+}
+
+#endif // RANDOM_ELEMENT_RENAMER_H