MobilityPeak1D.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: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <OpenMS/DATASTRUCTURES/DPosition.h>
 
#include <iosfwd>
#include <functional>
 
namespace OpenMS
{
  class OPENMS_DLLAPI MobilityPeak1D
  {
  public:
    enum{ DIMENSION = 1 };
    using IntensityType = float;
    using PositionType = DPosition<1>;
    using CoordinateType = double;
 
    MobilityPeak1D() = default;
 
    MobilityPeak1D(PositionType a, IntensityType b) : position_(a), intensity_(b)
    {
    }
 
    MobilityPeak1D(const MobilityPeak1D& p) = default;
 
    // Move constructor
    MobilityPeak1D(MobilityPeak1D&&) noexcept = default;
    
    MobilityPeak1D& operator=(const MobilityPeak1D& rhs) = default;
 
    MobilityPeak1D& operator=(MobilityPeak1D&&) noexcept = default;
 
 
    ~MobilityPeak1D() noexcept = default;
 
 
    IntensityType getIntensity() const;
    void setIntensity(IntensityType intensity);
 
    CoordinateType getMobility() const;
 
    void setMobility(CoordinateType mobility);
 
    CoordinateType getPos() const;
 
    void setPos(CoordinateType pos);
 
    PositionType const& getPosition() const;
 
    PositionType& getPosition();
 
    void setPosition(PositionType const& position);
 
 
    bool operator==(const MobilityPeak1D& rhs) const;
 
    bool operator!=(const MobilityPeak1D& rhs) const;
 
    struct IntensityLess {
      inline bool operator()(MobilityPeak1D const& left, MobilityPeak1D const& right) const
      {
        return left.getIntensity() < right.getIntensity();
      }
 
      inline bool operator()(MobilityPeak1D const& left, IntensityType right) const
      {
        return left.getIntensity() < right;
      }
 
      inline bool operator()(IntensityType left, MobilityPeak1D const& right) const
      {
        return left < right.getIntensity();
      }
 
      inline bool operator()(IntensityType left, IntensityType right) const
      {
        return left < right;
      }
    };
 
    struct MobilityLess {
      inline bool operator()(const MobilityPeak1D& left, const MobilityPeak1D& right) const
      {
        return left.getMobility() < right.getMobility();
      }
 
      inline bool operator()(MobilityPeak1D const& left, CoordinateType right) const
      {
        return left.getMobility() < right;
      }
 
      inline bool operator()(CoordinateType left, MobilityPeak1D const& right) const
      {
        return left < right.getMobility();
      }
 
      inline bool operator()(CoordinateType left, CoordinateType right) const
      {
        return left < right;
      }
    };
 
    struct PositionLess {
      inline bool operator()(const MobilityPeak1D& left, const MobilityPeak1D& right) const
      {
        return left.getPosition() < right.getPosition();
      }
 
      inline bool operator()(const MobilityPeak1D& left, const PositionType& right) const
      {
        return left.getPosition() < right;
      }
 
      inline bool operator()(const PositionType& left, const MobilityPeak1D& right) const
      {
        return left < right.getPosition();
      }
 
      inline bool operator()(const PositionType& left, const PositionType& right) const
      {
        return left < right;
      }
    };
 
  protected:
    PositionType position_{};
    IntensityType intensity_ = 0.0;
  };
 
  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const MobilityPeak1D& point);
 
} // namespace OpenMS
 
// Hash function specialization for MobilityPeak1D
namespace std
{
  template<>
  struct hash<OpenMS::MobilityPeak1D>
  {
    std::size_t operator()(const OpenMS::MobilityPeak1D& p) const noexcept
    {
      std::size_t seed = OpenMS::hash_float(p.getMobility());
      OpenMS::hash_combine(seed, OpenMS::hash_float(p.getIntensity()));
      return seed;
    }
  };
} // namespace std