Rules.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include <algorithm>
#include <cmath>
#include <complex>
#include <fstream>
#include <iomanip>
#include <iterator>
#include <list>
#include <map>
#include <sstream>
#include <stack>
#include <string>
#include <vector>
 
#include "MantidGeometry/Math/Triple.h"
#include "MantidGeometry/Objects/Rules.h"
#include "MantidGeometry/Surfaces/BaseVisit.h"
#include "MantidGeometry/Surfaces/Surface.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/Logger.h"
#include "MantidKernel/Matrix.h"
#include "MantidKernel/V3D.h"
 
namespace Mantid::Geometry {
 
namespace {
Kernel::Logger logger("Rules");
}
 
int Rule::addToKey(std::vector<int> &AV, const int passN)
{
  for (int i = 0; i < static_cast<int>(AV.size()); i++) {
    if (passN != i) {
      if (AV[i] == 1)
        AV[i] = 0;
      else
        return i + 1;
    }
  }
  return -1;
}
 
int Rule::removeComplementary(std::unique_ptr<Rule> &TopRule)
{
  // Search down the rule until we get to common
  // group. Once we have found a common type
  // apply simple
 
  if (TopRule->type() == 0) // One element tree (just return)
    return 0;
 
  int active(1); // active units
 
  Rule *tmpA, *tmpB, *tmpC;              // need three to play
  DTriple<Rule *, int, Rule *> TreeComp; // Storage for top of stack
 
  while (active) {
    active = 0;
    std::stack<DTriple<Rule *, int, Rule *>> TreeLine; // Tree stack of rules
    TreeLine.push(DTriple<Rule *, int, Rule *>(nullptr, 0, TopRule.get()));
 
    while (!active && !TreeLine.empty()) // need to exit on active
    {
      TreeComp = TreeLine.top();
      TreeLine.pop();
      // get first rule off tree
      tmpA = TreeComp.third;
 
      if (!tmpA->commonType()) // Not a common type, then we must get branches
      {
        tmpB = tmpA->leaf(0); // get leaves (two of)
        tmpC = tmpA->leaf(1);
        if (tmpB)
          TreeLine.push(DTriple<Rule *, int, Rule *>(tmpA, 0, tmpB));
        if (tmpC)
          TreeLine.push(DTriple<Rule *, int, Rule *>(tmpA, 1, tmpC));
      } else // Got something to simplify :-)
      {
        // In the simplification we don't need
        // to add anything to the tree.
        // This call the appropiate intersection/Union
        // TrueCount 1 is a simple simplification
        //           -1 alway true
        //           -2 alway false
        const int tcount(tmpA->simplify());
 
        if (tcount == 1) // Deep simplification
        {
          active = 1;
        } else if (tcount == -1) // replacement simplification
        {
          if (TreeComp.first) {
            TreeComp.first = tmpA->leaf(0);
            // delete tmpA
            tmpA->setLeaf(nullptr, 0);
            Rule *parentOfA = tmpA->getParent();
            if (parentOfA) {
              int leafNumber = parentOfA->findLeaf(tmpA);
              parentOfA->setLeaf(nullptr, leafNumber);
            }
          }
        }
      }
    }
  }
  return 1;
}
 
int Rule::makeCNFcopy(std::unique_ptr<Rule> &TopRule)
{
  // Start at top to tree to find an instance
  // an intersection with stuff below.
 
  int count(0);                          // Number of changes made
  int active(1);                         // Do we still have to use
  Rule *tmpA, *tmpB, *tmpC;              // need three to play
  DTriple<Rule *, int, Rule *> TreeComp; // Storage for top of stack
 
  /*
    The process works by below value deletion:
    This is when the tree is modified at a particular
    point, each member of the tree below the modification
    point is deleted and the modification point is
    replaced with a new version (normally a cloned copy).
    This is fine for small items (eg here the memory footprint
    is only 24 bytes, but not acceptable for bigger items.
    The two layer insertion (which could be done) is more
    complex but better proformance is possible.
  */
 
  while (active) {
    active = 0;
    count++;
    // This stack takes a Different Triple < Parent, leaf, Child >
    // We need to store the parent so that when we change the tree
    // of a particular object. The integer records which side
    // of the branch the tree object came from 0 == LHS 1==RHS.
 
    std::stack<DTriple<Rule *, int, Rule *>> TreeLine; // Tree stack of rules
 
    // Start by putting the top item on the Tree Stack.
    // Note that it doesn't have a parent.
    TreeLine.push(DTriple<Rule *, int, Rule *>(nullptr, 0, TopRule.get()));
 
    // Exit condition is that nothing changed last time
    // or the tree is Empty.
 
    while (!active && !TreeLine.empty()) {
      // Ok get and remove the top item from the stack.
      TreeComp = TreeLine.top();
      TreeLine.pop();
 
      // Get the item. (not its parent)
      tmpA = TreeComp.third; // get base item
      // Now it might be a Union or Intersection
      // so we need to get is branches.
      // If it is a surface item then it will not have
      // branches and thus tmpB and tmpC will == 0
      tmpB = tmpA->leaf(0); // get leaves (two of)
      tmpC = tmpA->leaf(1);
 
      // If either then we need to put copies on the stack
      // for later consideration.
      // tmpA is the parent, since it is the leaves of tmpA the
      // are written into tmpB and tmpC
      if (tmpB)
        TreeLine.push(DTriple<Rule *, int, Rule *>(tmpA, 0, tmpB));
      if (tmpC)
        TreeLine.push(DTriple<Rule *, int, Rule *>(tmpA, 1, tmpC));
 
      //
      //  Time to see if we can apply rule 4 (propositional calculus)
      //  to expand (a ^ b) v c to (a v c) ^ (b v c)
      //
      if (tmpA->type() == 1 && tmpB && tmpC) // it is an intersection otherwise no work to do
      {
        // require either the left or right to be unions.
        if (tmpB->type() == -1 || tmpC->type() == -1) // this is a union expand....
        {
          std::unique_ptr<Rule> alpha, beta, gamma;
          if (tmpB->type() == -1) // ok the LHS is a union. (a ^ b) v g ==> (a v g) ^ (b v g )
          {
            // Make copies of the Unions leaves (allowing for null union)
            alpha = (tmpB->leaf(0)) ? tmpB->leaf(0)->clone() : nullptr;
            beta = (tmpB->leaf(1)) ? tmpB->leaf(1)->clone() : nullptr;
            gamma = tmpC->clone();
          } else // RHS a v (b ^ g) ==> (a v b) ^ (a v g )
          {
            // Make copies of the Unions leaves (allowing for null union)
            // Note :: alpha designated as beta , gamma plays the role of alpha
            // in the RHS part of the above equation (allows common replace
            // block below.
            alpha = (tmpC->leaf(0)) ? tmpC->leaf(0)->clone() : nullptr;
            beta = (tmpC->leaf(1)) ? tmpC->leaf(1)->clone() : nullptr;
            gamma = tmpB->clone();
          }
          // Have bit to replace
 
          // Note:: no part of this can be memory copy
          // hence we have to play games with a second
          // gamma->clone()
          std::unique_ptr<Rule> tmp1 = std::make_unique<Intersection>(std::move(alpha), gamma->clone());
          std::unique_ptr<Rule> tmp2 = std::make_unique<Intersection>(std::move(beta), std::move(gamma));
          std::unique_ptr<Rule> partReplace = std::make_unique<Union>(std::move(tmp1), std::move(tmp2));
          //
          // General replacement
          //
          if (TreeComp.first) // Not the top rule (so replace parents leaf)
            TreeComp.first->setLeaf(std::move(partReplace), TreeComp.second);
          else
            // It is the top rule therefore, replace the toprule
            TopRule = std::move(partReplace);
 
          // Now we have to go back to the begining again and start again.
          active = 1; // Exit loop
        }
      }
    }
  }
  return count - 1; // return number of changes
}
 
int Rule::makeCNF(std::unique_ptr<Rule> &TopRule)
{
  // Start at top to tree to find an instance
  // an intersection with stuff below.
 
  if (!TopRule)
    return 0;
 
  TopRule->makeParents();
  int count(0);             // Number of changes made
  int active(1);            // Do we still have to use
  Rule *tmpA, *tmpB, *tmpC; // need three to play
 
  while (active) {
    active = 0;
    count++;
    std::stack<Rule *> TreeLine; // Tree stack of rules
 
    // Start by putting the top item on the Tree Stack.
    // Note that it doesn't have a parent.
    TreeLine.push(TopRule.get());
 
    // Exit condition is that nothing changed last time
    // or the tree is Empty.
    if (!TopRule->checkParents())
      logger.debug() << "Parents False\n";
    while (!active && !TreeLine.empty()) {
      // Ok get and remvoe the top item from the stack.
      tmpA = TreeLine.top();
      TreeLine.pop();
 
      // Now it might be a Union or Intersection
      // so we need to get is branches.
 
      tmpB = tmpA->leaf(0); // get leaves (two of)
      tmpC = tmpA->leaf(1);
 
      if (tmpB)
        TreeLine.push(tmpB);
      if (tmpC)
        TreeLine.push(tmpC);
 
      //
      //  Time to see if we can apply rule 4 (propositional calculus)
      //  to expand (a ^ b) v c to (a v c) ^ (b v c)
      //
      if (tmpA->type() == 1 && tmpB && tmpC) // it is an intersection otherwise no work to do
      {
        // require either the left or right to be unions.
        if (tmpB->type() == -1 || tmpC->type() == -1) // this is a union expand....
        {
          std::unique_ptr<Rule> alpha, beta, gamma; // Uobj to be deleted
          if (tmpB->type() == -1)                   // ok the LHS is a union. (a ^ b) v g ==> (a v g) ^ (b v g )
          {
            // Make copies of the Unions leaves (allowing for null union)
            alpha = tmpB->leaf(0)->clone();
            beta = tmpB->leaf(1)->clone();
            gamma = tmpC->clone();
          } else // RHS a v (b ^ g) ==> (a v b) ^ (a v g )
          {
            // Make copies of the Unions leaves (allowing for null union)
            // Note :: alpha designated as beta , gamma plays the role of alpha
            // in the RHS part of the above equation (allows common replace
            // block below.
            alpha = tmpC->leaf(0)->clone();
            beta = tmpC->leaf(1)->clone();
            gamma = tmpB->clone();
          }
          // Have bit to replace
 
          // Note:: no part of this can be memory copy
          // hence we have to play games with a second
          // gamma->clone()
          std::unique_ptr<Rule> tmp1 = std::make_unique<Intersection>(std::move(alpha), gamma->clone());
          std::unique_ptr<Rule> tmp2 = std::make_unique<Intersection>(std::move(beta), std::move(gamma));
          std::unique_ptr<Rule> partReplace = std::make_unique<Union>(std::move(tmp1), std::move(tmp2));
          //
          // General replacement
          //
          Rule *Pnt = tmpA->getParent(); // parent
          if (Pnt)                       // Not the top rule (so replace parents leaf)
          {
            const int leafN = Pnt->findLeaf(tmpA);
            Pnt->setLeaf(std::move(partReplace), leafN);
          } else
            TopRule = std::move(partReplace);
          // Now we have to go back to the begining again and start again.
          active = 1; // Exit loop
        }
      }
    }
  }
  return count - 1; // return number of changes
}
 
int Rule::removeItem(std::unique_ptr<Rule> &TRule, const int SurfN)
{
  int cnt(0);
  Rule *Ptr = TRule->findKey(SurfN);
  while (Ptr) {
    Rule *LevelOne = Ptr->getParent(); // Must work
    Rule *LevelTwo = (LevelOne) ? LevelOne->getParent() : nullptr;
 
    if (LevelTwo) 
    {
      // Decide which of the pairs is to be copied
      const Rule *PObj = (LevelOne->leaf(0) != Ptr) ? LevelOne->leaf(0) : LevelOne->leaf(1);
      //
      const int side = (LevelTwo->leaf(0) != LevelOne) ? 1 : 0;
      LevelTwo->setLeaf(PObj->clone(), side);
    } else if (LevelOne) // LevelOne is the top rule
    {
      // Decide which of the pairs is to be copied
      Rule *PObj = (LevelOne->leaf(0) != Ptr) ? LevelOne->leaf(0) : LevelOne->leaf(1);
 
      PObj->setParent(nullptr); 
      TRule = PObj->clone();
    } else // Basic surf object
    {
      auto *SX = dynamic_cast<SurfPoint *>(Ptr);
      if (!SX) {
        throw std::logic_error("Failed to cast Rule object to SurfPoint");
      }
      SX->setKeyN(0);
      SX->setKey(std::shared_ptr<Surface>());
      return cnt + 1;
    }
    Ptr = TRule->findKey(SurfN);
    cnt++;
  }
  return cnt;
}
 
Rule::Rule()
    : Parent(nullptr)
{}
 
Rule::Rule(const Rule & /*unused*/)
    : Parent(nullptr)
{}
 
Rule::Rule(Rule *A)
    : Parent(A)
{}
 
// cppcheck-suppress operatorEqVarError
Rule &Rule::operator=(const Rule & /*unused*/)
{
  return *this;
}
 
void Rule::setParent(Rule *A)
{
  Parent = A;
}
 
Rule *Rule::getParent() const
{
  return Parent;
}
 
void Rule::makeParents()
{
  std::stack<Rule *> Tree;
  Tree.push(this);
  while (!Tree.empty()) {
    Rule *Ptmp = Tree.top();
    Tree.pop();
 
    if (Ptmp) {
      for (int i = 0; i < 2; i++) {
        Rule *tmpB = Ptmp->leaf(i);
        if (tmpB) {
          tmpB->setParent(Ptmp);
          Tree.push(tmpB);
        }
      }
    }
  }
}
 
int Rule::checkParents() const
{
  std::stack<const Rule *> Tree;
  Tree.push(this);
  while (!Tree.empty()) {
    const Rule *Ptmp = Tree.top();
    Tree.pop();
 
    if (Ptmp) {
      for (int i = 0; i < 2; i++) {
        const Rule *tmpB = Ptmp->leaf(i);
        if (tmpB) {
          if (tmpB->getParent() != Ptmp)
            return 0;
        }
      }
    }
  }
  return 1;
}
 
int Rule::commonType() const
{
  // initial type
  const int rtype = this->type(); // note the dereference to get non-common comonents
  if (!rtype)
    return 0;
  // now this must be an intersection or a Union
  std::stack<const Rule *> Tree;
  Tree.push(this->leaf(0));
  Tree.push(this->leaf(1));
  while (!Tree.empty()) {
    const Rule *tmpA = Tree.top();
    Tree.pop();
    if (tmpA) {
      if (tmpA->type() == -rtype) // other type return void
        return 0;
      const Rule *tmpB = tmpA->leaf(0);
      const Rule *tmpC = tmpA->leaf(1);
      if (tmpB)
        Tree.push(tmpB);
      if (tmpC)
        Tree.push(tmpC);
    }
  }
  return rtype;
}
 
int Rule::substituteSurf(const int SurfN, const int newSurfN, const std::shared_ptr<Surface> &SPtr)
{
  int cnt(0);
  auto *Ptr = dynamic_cast<SurfPoint *>(findKey(SurfN));
  while (Ptr) {
    Ptr->setKeyN(Ptr->getSign() * newSurfN);
    Ptr->setKey(SPtr);
    cnt++;
    // get next key
    Ptr = dynamic_cast<SurfPoint *>(findKey(SurfN));
  }
  return cnt;
}
 
int Rule::getKeyList(std::vector<int> &IList) const
{
  IList.clear();
  std::stack<const Rule *> TreeLine;
  TreeLine.push(this);
  while (!TreeLine.empty()) {
    const Rule *tmpA = TreeLine.top();
    TreeLine.pop();
    const Rule *tmpB = tmpA->leaf(0);
    const Rule *tmpC = tmpA->leaf(1);
    if (tmpB || tmpC) {
      if (tmpB)
        TreeLine.push(tmpB);
      if (tmpC)
        TreeLine.push(tmpC);
    } else {
      const auto *SurX = dynamic_cast<const SurfPoint *>(tmpA);
      if (SurX)
        IList.emplace_back(SurX->getKeyN());
      else {
        logger.error() << "Error with surface List\n";
        return static_cast<int>(IList.size());
      }
    }
  }
  std::sort(IList.begin(), IList.end());
  auto px = std::unique(IList.begin(), IList.end());
  IList.erase(px, IList.end());
  return static_cast<int>(IList.size());
}
 
int Rule::Eliminate()
{
  std::map<int, int> Base; // map of key names + test value (initially 1)
  std::vector<int> baseVal;
  std::vector<int> baseKeys;
  std::vector<int> deadKeys;
  // collect base keys and populate the cells
  getKeyList(baseKeys);
  std::vector<int>::const_iterator xv;
  for (xv = baseKeys.begin(); xv != baseKeys.end(); ++xv) {
    baseVal.emplace_back(0);
    Base[(*xv)] = 1;
  }
 
  // For each key :: check if the Rule is equal for both cases 0 + 1
  // then loop through all combinations of the map to determine validity
  // This function is not optimised since the tree can be trimmed
  // if the test item is not in a branch.
  for (unsigned int TKey = 0; TKey < baseKeys.size(); TKey++) {
    // INITIALISE STUFF
    int valueTrue(1), valueFalse(1);
    int keyChange = 0;
    int targetKey = baseKeys[TKey];
    for (unsigned int i = 0; i < baseVal.size(); i++) {
      baseVal[i] = 0;
      Base[baseKeys[i]] = 0;
    }
 
    // CHECK EACH KEY IN TURN
    while (valueTrue == valueFalse || keyChange >= 0) {
      // Zero value
      Base[baseKeys[targetKey]] = 0;
      valueFalse = isValid(Base);
 
      // True value
      Base[baseKeys[targetKey]] = 1;
      valueTrue = isValid(Base);
 
      // Put everything back
      if (valueTrue == valueFalse) {
        keyChange = addToKey(baseVal, TKey); // note pass index not key
        for (int ic = 0; ic < keyChange; ic++)
          Base[baseKeys[ic]] = baseVal[ic];
      }
    }
    deadKeys.emplace_back(targetKey);
  }
  return static_cast<int>(deadKeys.size());
}
 
} // namespace Mantid::Geometry