FeatureHandle.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: $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <OpenMS/CONCEPT/UniqueIdInterface.h>
#include <OpenMS/KERNEL/Peak2D.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <functional>
#include <iosfwd>
#include <vector>
 
namespace OpenMS
{
  class BaseFeature;
 
  class OPENMS_DLLAPI FeatureHandle :
    public Peak2D,
    public UniqueIdInterface
  {
 
public:
    class FeatureHandleMutable_;
 
 
 
    typedef Int ChargeType;
    typedef float WidthType;
 
 
 
    FeatureHandle();
 
    FeatureHandle(UInt64 map_index, const Peak2D& point, UInt64 element_index);
 
    FeatureHandle(UInt64 map_index, const BaseFeature& feature);
 
    FeatureHandle(const FeatureHandle& rhs);
 
    FeatureHandle& operator=(const FeatureHandle& rhs);
 
    ~FeatureHandle() override;
 
    FeatureHandleMutable_& asMutable() const;
 
 
 
    UInt64 getMapIndex() const;
 
    void setMapIndex(UInt64 i);
 
    void setCharge(ChargeType charge);
 
    ChargeType getCharge() const;
 
    void setWidth(WidthType width);
 
    WidthType getWidth() const;
 
 
    bool operator==(const FeatureHandle& i) const;
 
    bool operator!=(const FeatureHandle& i) const;
 
    struct IndexLess
    {
      bool operator()(FeatureHandle const& left, FeatureHandle const& right) const;
    };
 
protected:
 
    UInt64 map_index_;
    Int charge_;
    float width_;
  };
 
  class OPENMS_DLLAPI FeatureHandle::FeatureHandleMutable_ :
    public FeatureHandle
  {
private:
    using FeatureHandle::setUniqueId;
    using FeatureHandle::setMapIndex;
    FeatureHandleMutable_();
    FeatureHandleMutable_(const FeatureHandleMutable_&);
  };
 
  inline FeatureHandle::FeatureHandleMutable_& FeatureHandle::asMutable() const
  {
    // the const cast is to remove constness, but note that FeatureHandleMutable_ lacks some mutators
    // TODO use const_cast
    return static_cast<FeatureHandleMutable_&>(const_cast<FeatureHandle&>(*this));
  }
 
  inline bool FeatureHandle::IndexLess::operator()(FeatureHandle const& left, FeatureHandle const& right) const
  {
    // if map indices are equal, use unique ids
    if (left.map_index_ == right.map_index_)
    {
      return left.getUniqueId() < right.getUniqueId();
    }
    //else use map indices
    return left.map_index_ < right.map_index_;
  }
 
  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const FeatureHandle& cons);
} // namespace OpenMS
 
// Hash function specialization for FeatureHandle
namespace std
{
  template<>
  struct hash<OpenMS::FeatureHandle>
  {
    std::size_t operator()(const OpenMS::FeatureHandle& fh) const noexcept
    {
      // Hash Peak2D base class components
      std::size_t seed = OpenMS::hash_float(fh.getRT());
      OpenMS::hash_combine(seed, OpenMS::hash_float(fh.getMZ()));
      OpenMS::hash_combine(seed, OpenMS::hash_float(fh.getIntensity()));
      // Hash UniqueIdInterface component
      OpenMS::hash_combine(seed, OpenMS::hash_int(fh.getUniqueId()));
      // Hash FeatureHandle-specific members
      OpenMS::hash_combine(seed, OpenMS::hash_int(fh.getMapIndex()));
      OpenMS::hash_combine(seed, OpenMS::hash_int(fh.getCharge()));
      OpenMS::hash_combine(seed, OpenMS::hash_float(fh.getWidth()));
      return seed;
    }
  };
} // namespace std