VectorParameter.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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 +
#pragma once
 
#include "MantidAPI/ImplicitFunctionParameter.h"
#include "MantidKernel/System.h"
 
namespace Mantid {
namespace API {
 
template <typename Derived, typename ElemType> class DLLExport VectorParameter : public ImplicitFunctionParameter {
public:
  using ValueType = ElemType;
  VectorParameter();
  VectorParameter(size_t size);
  VectorParameter(const VectorParameter<Derived, ElemType> &other);
  VectorParameter<Derived, ElemType> &operator=(const VectorParameter<Derived, ElemType> &other);
  ~VectorParameter() override;
  void addValue(const size_t index, const ElemType &value);
  std::string toXMLString() const override;
  Derived &assignFrom(const Derived &other);
  bool operator==(const Derived &other) const;
  bool operator!=(const Derived &other) const;
  bool isValid() const override;
  ElemType &operator[](int index);
  const ElemType *getPointerToStart();
  size_t getSize() const;
  ElemType &at(size_t index);
 
protected:
  ElemType *m_arry;
  size_t m_size;
  bool m_isValid;
 
private:
  Derived &operator=(const Derived &other);
};
 
//----------------------------------------------------------------------
/* Getter for the valid state.
@return true if object is valid.
*/
template <typename Derived, typename ElemType> bool VectorParameter<Derived, ElemType>::isValid() const {
  return m_isValid;
}
 
//----------------------------------------------------------------------
/* Assignment
@param other : object to assign from.
@return ref to assined object.
*/
template <typename Derived, typename ElemType>
Derived &VectorParameter<Derived, ElemType>::assignFrom(const Derived &other) {
  if (other.getSize() != this->getSize()) {
    throw std::runtime_error("Cannot assign between VectorParameters where the "
                             "size of the vectors are different.");
  }
  if (&other != this) {
    this->m_isValid = other.m_isValid;
    for (size_t i = 0; i < other.getSize(); i++) {
      this->m_arry[i] = other.m_arry[i];
    }
  }
  return *(dynamic_cast<Derived *>(this));
}
 
//----------------------------------------------------------------------
/* Overriden equality operator
@param other : object to compare with
@return true if to be considered equal
*/
template <typename Derived, typename ElemType>
bool VectorParameter<Derived, ElemType>::operator==(const Derived &other) const {
  if (other.m_isValid != this->m_isValid) {
    return false; // Early termination
  }
  if (other.getSize() != this->getSize()) {
    return false; // Early termination
  }
  for (size_t i = 0; i < other.getSize(); i++) {
    if (this->m_arry[i] != other.m_arry[i]) {
      return false;
    }
  }
  return true;
}
 
//----------------------------------------------------------------------
/* Overriden not equals operator
@param other : object to compare with
@return true if to be considered not equal
*/
template <typename Derived, typename ElemType>
bool VectorParameter<Derived, ElemType>::operator!=(const Derived &other) const {
  return !(*this == other);
}
 
//----------------------------------------------------------------------
/* Copy constructor
@param other : object to act as source of copy.
*/
template <typename Derived, typename ElemType>
VectorParameter<Derived, ElemType>::VectorParameter(const VectorParameter<Derived, ElemType> &other) {
  *this = other;
}
 
template <typename Derived, typename ElemType>
VectorParameter<Derived, ElemType> &
VectorParameter<Derived, ElemType>::operator=(const VectorParameter<Derived, ElemType> &other) {
  m_size = other.m_size;
  m_isValid = other.m_isValid;
  m_arry = new ElemType[other.getSize()];
  for (size_t i = 0; i < other.getSize(); i++) {
    this->m_arry[i] = other.m_arry[i];
  }
  return *this;
}
 
template <typename Derived, typename ElemType>
VectorParameter<Derived, ElemType>::VectorParameter() : m_arry(nullptr), m_size(0) {
  m_isValid = false;
}
 
//----------------------------------------------------------------------
/* Constructor
@param size : size of array
*/
template <typename Derived, typename ElemType>
VectorParameter<Derived, ElemType>::VectorParameter(size_t size) : m_size(size) {
  m_arry = new ElemType[size];
  m_isValid = true;
}
 
template <typename Derived, typename ElemType> VectorParameter<Derived, ElemType>::~VectorParameter() {
  delete[] m_arry;
}
 
//----------------------------------------------------------------------
/* Setter for values on vector
@param value : Value to add.
*/
template <typename Derived, typename ElemType>
void VectorParameter<Derived, ElemType>::addValue(const size_t index, const ElemType &value) {
  m_arry[index] = value;
}
 
//----------------------------------------------------------------------
/* Serialize the object to an xml string.
@return string containing object in xml serialized form.
*/
template <typename Derived, typename ElemType> std::string VectorParameter<Derived, ElemType>::toXMLString() const {
  if (!m_isValid) {
    throw std::runtime_error("Cannot serialize VectorParameter if it is not valid!");
  }
  std::string valueXMLtext;
  for (size_t i = 0; i < m_size; i++) {
    if (i < (m_size - 1)) {
      valueXMLtext.append(ElementTraits<ElemType>::formatCS(m_arry[i])); // Comma-seperated
    } else {
      valueXMLtext.append(ElementTraits<ElemType>::format(m_arry[i])); // No comma sepearation for last value
    }
  }
  return this->parameterXMLTemplate(valueXMLtext);
}
 
//----------------------------------------------------------------------
/* Overrriden array operator
@param index : array index to access.
@return ref to the element at the specified index.
*/
template <typename Derived, typename ElemType> ElemType &VectorParameter<Derived, ElemType>::operator[](int index) {
  return m_arry[index];
}
 
//----------------------------------------------------------------------
/* Getter for the vector size.
@return the size of the vector
*/
template <typename Derived, typename ElemType> size_t VectorParameter<Derived, ElemType>::getSize() const {
  return m_size;
}
 
//----------------------------------------------------------------------
/* Getter to pointer to the start of the underlying array
@return pointer to start.
*/
template <typename Derived, typename ElemType> const ElemType *VectorParameter<Derived, ElemType>::getPointerToStart() {
  return m_arry;
}
 
//----------------------------------------------------------------------
/* Convienince array access method
@param index : index to get element at
@return element at index
*/
template <typename Derived, typename ElemType> ElemType &VectorParameter<Derived, ElemType>::at(size_t index) {
  return m_arry[index];
}
 
//-----------------------------------------------------------------------------------------------------------------//
// Macro for generating concrete types of VectorParameters.
//
// Use of macro enables parameter names to be assigned to each type.
// Most of the work is done in the VectorParamter base class, which utilises
// CRTP.
//-----------------------------------------------------------------------------------------------------------------//
#define DECLARE_VECTOR_PARAMETER(classname, type_)                                                                     \
  class classname : public Mantid::API::VectorParameter<classname, type_> {                                            \
  public:                                                                                                              \
    using SuperType = Mantid::API::VectorParameter<classname, type_>;                                                  \
    static std::string parameterName() { return #classname; }                                                          \
    classname() : SuperType() {}                                                                                       \
    classname(size_t index) : SuperType(index) {}                                                                      \
    std::string getName() const override { return #classname; }                                                        \
    classname *clone() const override { return new classname(*this); }                                                 \
  };
} // namespace API
} // namespace Mantid