RebinParamsValidator.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 "MantidKernel/RebinParamsValidator.h"
#include <memory>
 
namespace Mantid::Kernel {
RebinParamsValidator::RebinParamsValidator(bool allowEmpty, bool allowRange)
    : m_allowEmpty(allowEmpty), m_allowRange(allowRange) {}
 
IValidator_sptr RebinParamsValidator::clone() const { return std::make_shared<RebinParamsValidator>(*this); }
 
std::string RebinParamsValidator::checkValidity(const std::vector<double> &value) const {
  // array must not be empty
  if (value.empty()) {
    if (m_allowEmpty) // unless allowed in the constructor
      return "";
    else
      return "Enter values for this property";
  }
 
  if (m_allowRange && value.size() == 2) {
    if (value[0] < value[1])
      return "";
    else
      return "When giving a range the second value must be larger than the "
             "first";
  }
 
  // it must have an odd number of values (and be at least 3 elements long)
  if (value.size() % 2 == 0) {
    return "The number of bin boundary parameters provided must be odd";
  }
 
  // bin widths must not be zero
  if (value.size() == 1 && value[0] == 0.0) {
    return "Cannot have a zero bin width";
  } else {
    for (size_t i = 1; i < value.size(); i += 2) {
      if (value[i] == 0.0) {
        return "Cannot have a zero bin width";
      }
    }
  }
 
  // bin boundary values must be in increasing order
  double previous = value[0];
  for (size_t i = 2; i < value.size(); i += 2) {
    if ((value[i - 1] < 0) && (previous <= 0)) {
      return "Bin boundaries must be positive for logarithmic binning";
    }
    if (value[i] <= previous) {
      return "Bin boundary values must be given in order of increasing value";
    } else
      previous = value[i];
  }
 
  // All's OK if we get to here
  return "";
}
 
} // namespace Mantid::Kernel