CVTermList.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: Mathias Walzer $
// $Authors: Andreas Bertsch, Mathias Walzer $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/METADATA/CVTerm.h>
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <map>
 
namespace OpenMS
{
  class OPENMS_DLLAPI CVTermList :
    public MetaInfoInterface
  {
public:
 
    CVTermList() = default;
 
    CVTermList(const CVTermList&) = default;
 
    // note: we implement the move constructor ourselves due to a bug in MSVS
    // 2015/2017 which cannot produce a default move constructor for classes
    // that contain STL containers (other than vector).
 
    CVTermList(CVTermList&&) noexcept;
 
    virtual ~CVTermList();
 
    CVTermList& operator=(const CVTermList& rhs) & = default;
 
    CVTermList& operator=(CVTermList&&) & = default;
 
    void setCVTerms(const std::vector<CVTerm>& terms);
 
    void replaceCVTerm(const CVTerm& cv_term);
 
    void replaceCVTerms(const std::vector<CVTerm>& cv_terms, const std::string& accession);
 
    void replaceCVTerms(const std::map<std::string, std::vector<CVTerm> >& cv_term_map);
 
    void consumeCVTerms(const std::map<std::string, std::vector<CVTerm> >& cv_term_map);
 
    const std::map<std::string, std::vector<CVTerm> >& getCVTerms() const;
 
    void addCVTerm(const CVTerm& term);
 
    //bool checkCVTerms(const ControlledVocabulary& cv) const;
 
    //void correctCVTermNames();
 
    bool operator==(const CVTermList& cv_term_list) const;
 
    bool operator!=(const CVTermList& cv_term_list) const;
 
    bool hasCVTerm(const std::string& accession) const;
 
    //bool checkCVTerms(const CVMappingRule & rule, const ControlledVocabulary & cv) const;
 
    bool empty() const;
    //}
 
protected:
 
  std::map<std::string, std::vector<CVTerm> > cv_terms_;
 
  };
 
  template<typename T>
  inline std::size_t hashCVTerms(const T& obj) noexcept
  {
    std::size_t seed = 0;
    const auto& cv_terms = obj.getCVTerms();
    for (const auto& [accession, terms] : cv_terms)
    {
      hash_combine(seed, fnv1a_hash_string(accession));
      for (const auto& term : terms)
      {
        hash_combine(seed, fnv1a_hash_string(term.getAccession()));
        hash_combine(seed, fnv1a_hash_string(term.getName()));
        hash_combine(seed, fnv1a_hash_string(term.getCVIdentifierRef()));
        if (term.hasValue())
        {
          hash_combine(seed, fnv1a_hash_string(term.getValue().toString()));
        }
        if (term.hasUnit())
        {
          hash_combine(seed, fnv1a_hash_string(term.getUnit().accession));
        }
      }
    }
    return seed;
  }
 
  // Convenience wrappers for backward compatibility
  inline std::size_t hashCVTermList(const CVTermList& cvtl) noexcept { return hashCVTerms(cvtl); }
 
} // namespace OpenMS
 
// Hash function specialization for CVTermList
namespace std
{
  template<>
  struct hash<OpenMS::CVTermList>
  {
    std::size_t operator()(const OpenMS::CVTermList& list) const noexcept
    {
      // Start with MetaInfoInterface base class hash
      std::size_t seed = std::hash<OpenMS::MetaInfoInterface>{}(list);
 
      // Hash all CV terms
      for (const auto& entry : list.getCVTerms())
      {
        // Hash the accession string
        OpenMS::hash_combine(seed, OpenMS::fnv1a_hash_string(entry.first));
        // Hash each CV term in the vector
        for (const auto& term : entry.second)
        {
          OpenMS::hash_combine(seed, std::hash<OpenMS::CVTerm>{}(term));
        }
      }
      return seed;
    }
  };
} // namespace std