ParamValue.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Authors: Ruben Grünberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/OpenMSConfig.h>
#include <OpenMS/CONCEPT/HashUtils.h>
 
#include <cstddef> // for ptrdiff_t
#include <functional>
#include <string>
#include <vector>
 
 
namespace OpenMS
{
  class OPENMS_DLLAPI ParamValue
  {
 
public:
 
    static const ParamValue EMPTY;
 
    enum ValueType : unsigned char
    {
      STRING_VALUE, 
      INT_VALUE, 
      DOUBLE_VALUE, 
      STRING_LIST, 
      INT_LIST, 
      DOUBLE_LIST, 
      EMPTY_VALUE 
    };
 
 
 
    ParamValue();
    ParamValue(const ParamValue&);
    ParamValue(ParamValue&&) noexcept;
    ParamValue(const char*);
    ParamValue(const std::string&);
    ParamValue(const std::vector<std::string>&);
    ParamValue(const std::vector<int>&);
    ParamValue(const std::vector<double>&);
    ParamValue(long double);
    ParamValue(double);
    ParamValue(float);
    ParamValue(short int);
    ParamValue(unsigned short int);
    ParamValue(int);
    ParamValue(unsigned);
    ParamValue(long int);
    ParamValue(unsigned long);
    ParamValue(long long);
    ParamValue(unsigned long long);
    ~ParamValue();
 
 
 
    operator std::string() const;
 
    operator std::vector<std::string>() const;
 
    operator std::vector<int>() const;
 
    operator std::vector<double>() const;
 
    operator long double() const;
 
    operator double() const;
 
    operator float() const;
 
    operator short int() const;
 
    operator unsigned short int() const;
 
    operator int() const;
 
    operator unsigned int() const;
 
    operator long int() const;
 
    operator unsigned long int() const;
 
    operator long long() const;
 
    operator unsigned long long() const;
 
    bool toBool() const;
 
    const char* toChar() const;
 
    std::string toString(bool full_precision = true) const;
 
    std::vector<std::string> toStringVector() const;
 
    std::vector<int> toIntVector() const;
 
    std::vector<double> toDoubleVector() const;
 
 
 
    ParamValue& operator=(const ParamValue&);
    ParamValue& operator=(ParamValue&&) noexcept;
    ParamValue& operator=(const char*);
    ParamValue& operator=(const std::string&);
    ParamValue& operator=(const std::vector<std::string>&);
    ParamValue& operator=(const std::vector<int>&);
    ParamValue& operator=(const std::vector<double>&);
    ParamValue& operator=(const long double);
    ParamValue& operator=(const double);
    ParamValue& operator=(const float);
    ParamValue& operator=(const short int);
    ParamValue& operator=(const unsigned short int);
    ParamValue& operator=(const int);
    ParamValue& operator=(const unsigned);
    ParamValue& operator=(const long int);
    ParamValue& operator=(const unsigned long);
    ParamValue& operator=(const long long);
    ParamValue& operator=(const unsigned long long);
 
    inline ValueType valueType() const
    {
      return value_type_;
    }
 
    inline bool isEmpty() const
    {
      return value_type_ == EMPTY_VALUE;
    }
 
    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator==(const ParamValue&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator<(const ParamValue&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator>(const ParamValue&, const ParamValue&);
 
    friend OPENMS_DLLAPI bool operator!=(const ParamValue&, const ParamValue&);
 
protected:
 
    ValueType value_type_;
 
    union
    {
      std::ptrdiff_t ssize_;
      double dou_;
      std::string* str_;
      std::vector<std::string>* str_list_;
      std::vector<int>* int_list_;
      std::vector<double>* dou_list_;
    } data_;
 
private:
 
    void clear_() noexcept;
 
    static std::string doubleToString(double value, bool full_precision = true);
 
  };
} // namespace OpenMS
 
// std::hash specialization for ParamValue - must be in std namespace
namespace std
{
  template<>
  struct hash<OpenMS::ParamValue>
  {
    std::size_t operator()(const OpenMS::ParamValue& pv) const noexcept
    {
      using namespace OpenMS;
      std::size_t seed = hash_int(static_cast<unsigned char>(pv.valueType()));
 
      switch (pv.valueType())
      {
        case ParamValue::EMPTY_VALUE:
          // No additional data to hash
          break;
        case ParamValue::STRING_VALUE:
        {
          std::string s = pv;
          hash_combine(seed, fnv1a_hash_string(s));
          break;
        }
        case ParamValue::INT_VALUE:
        {
          std::ptrdiff_t i = static_cast<long long>(pv);
          hash_combine(seed, hash_int(i));
          break;
        }
        case ParamValue::DOUBLE_VALUE:
        {
          double d = pv;
          hash_combine(seed, hash_float(d));
          break;
        }
        case ParamValue::STRING_LIST:
        {
          std::vector<std::string> sl = pv.toStringVector();
          hash_combine(seed, hash_int(sl.size()));
          for (const auto& s : sl)
          {
            hash_combine(seed, fnv1a_hash_string(s));
          }
          break;
        }
        case ParamValue::INT_LIST:
        {
          std::vector<int> il = pv.toIntVector();
          hash_combine(seed, hash_int(il.size()));
          for (int i : il)
          {
            hash_combine(seed, hash_int(i));
          }
          break;
        }
        case ParamValue::DOUBLE_LIST:
        {
          std::vector<double> dl = pv.toDoubleVector();
          hash_combine(seed, hash_int(dl.size()));
          for (double d : dl)
          {
            hash_combine(seed, hash_float(d));
          }
          break;
        }
      }
      return seed;
    }
  };
} // namespace std