DataValue.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
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <OpenMS/OpenMSConfig.h>
 
namespace OpenMS
{
    class ParamValue;
 
  class OPENMS_DLLAPI DataValue
  {
 
public:
 
    static const DataValue EMPTY;
 
    enum DataType : unsigned char
    {
      STRING_VALUE, 
      INT_VALUE, 
      DOUBLE_VALUE, 
      STRING_LIST, 
      INT_LIST, 
      DOUBLE_LIST, 
      EMPTY_VALUE, 
      SIZE_OF_DATATYPE
    };
 
    static const std::string NamesOfDataType[SIZE_OF_DATATYPE];
 
    enum UnitType : unsigned char
    { 
      UNIT_ONTOLOGY, 
      MS_ONTOLOGY, 
      OTHER 
    };
 
 
 
    DataValue();
    DataValue(const DataValue&);
    DataValue(DataValue&&) noexcept;
    DataValue(const char*);
    DataValue(const std::string&);
    DataValue(const String&);
    DataValue(const StringList&);
    DataValue(const IntList&);
    DataValue(const DoubleList&);
    DataValue(long double);
    DataValue(double);
    DataValue(float);
    DataValue(short int);
    DataValue(unsigned short int);
    DataValue(int);
    DataValue(unsigned);
    DataValue(long int);
    DataValue(unsigned long);
    DataValue(long long);
    DataValue(unsigned long long);
    DataValue(const ParamValue&);
    ~DataValue();
 
 
 
    operator ParamValue() const;
 
    operator std::string() const;
 
    operator StringList() const;
 
    operator IntList() const;
 
    operator DoubleList() 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;
 
    StringList toStringList() const;
 
    IntList toIntList() const;
 
    DoubleList toDoubleList() const;
 
 
 
    DataValue& operator=(const DataValue&);
    DataValue& operator=(DataValue&&) noexcept;
    DataValue& operator=(const char*);
    DataValue& operator=(const std::string&);
    DataValue& operator=(const String&);
    DataValue& operator=(const StringList&);
    DataValue& operator=(const IntList&);
    DataValue& operator=(const DoubleList&);
    DataValue& operator=(const long double);
    DataValue& operator=(const double);
    DataValue& operator=(const float);
    DataValue& operator=(const short int);
    DataValue& operator=(const unsigned short int);
    DataValue& operator=(const int);
    DataValue& operator=(const unsigned);
    DataValue& operator=(const long int);
    DataValue& operator=(const unsigned long);
    DataValue& operator=(const long long);
    DataValue& operator=(const unsigned long long);
 
 
 
    String toString(bool full_precision = true) const;
 
 
    DataType valueType() const;
 
    bool isEmpty() const;
 
 
 
    UnitType getUnitType() const;
 
    void setUnitType(const UnitType & u);
 
    bool hasUnit() const;
 
    const int32_t & getUnit() const;
 
    void setUnit(const int32_t & unit);
 
 
    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream&, const DataValue&);
 
    friend OPENMS_DLLAPI bool operator==(const DataValue&, const DataValue&);
 
    friend OPENMS_DLLAPI bool operator<(const DataValue&, const DataValue&);
 
    friend OPENMS_DLLAPI bool operator>(const DataValue&, const DataValue&);
 
    friend OPENMS_DLLAPI bool operator!=(const DataValue&, const DataValue&);
 
protected:
 
    DataType value_type_;
 
    UnitType unit_type_;
 
    int32_t unit_;
 
    union
    {
      SignedSize ssize_;
      double dou_;
      String* str_;
      StringList* str_list_;
      IntList* int_list_;
      DoubleList* dou_list_;
    } data_;
 
private:
 
    void clear_() noexcept;
  };
} // namespace OpenMS
 
// Hash function specialization for DataValue
namespace std
{
  template<>
  struct hash<OpenMS::DataValue>
  {
    std::size_t operator()(const OpenMS::DataValue& dv) const noexcept
    {
      std::size_t seed = 0;
 
      // Hash the value type
      OpenMS::hash_combine(seed, OpenMS::hash_int(static_cast<int>(dv.valueType())));
 
      // Hash the value content based on type
      if (!dv.isEmpty())
      {
        switch (dv.valueType())
        {
          case OpenMS::DataValue::DOUBLE_VALUE:
          {
            // operator== uses fabs(a - b) < 1e-6 for doubles, so we round to 6 decimal places
            // to ensure equal values (per operator==) produce identical hashes
            double val = static_cast<double>(dv);
            // Round to 6 decimal places: multiply by 1e6, round, then hash as int64
            int64_t rounded = static_cast<int64_t>(std::round(val * 1e6));
            OpenMS::hash_combine(seed, OpenMS::hash_int(rounded));
            break;
          }
          default:
            // For all other types (string, int, lists), use toString() which is consistent with operator==
            OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(dv.toString()));
            break;
        }
      }
 
      // Hash unit information if present
      if (dv.hasUnit())
      {
        OpenMS::hash_combine(seed, OpenMS::hash_int(static_cast<int>(dv.getUnitType())));
        OpenMS::hash_combine(seed, OpenMS::hash_int(dv.getUnit()));
      }
 
      return seed;
    }
  };
} // namespace std