MobilityPeak1D.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/DPosition.h>
#include <iosfwd>

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
    {
      return intensity_;
    }
    void setIntensity(IntensityType intensity)
    {
      intensity_ = intensity;
    }

    inline CoordinateType getMobility() const
    {
      return position_[0];
    }

    inline void setMobility(CoordinateType mobility)
    {
      position_[0] = mobility;
    }

    inline CoordinateType getPos() const
    {
      return position_[0];
    }

    inline void setPos(CoordinateType pos)
    {
      position_[0] = pos;
    }

    inline PositionType const& getPosition() const
    {
      return position_;
    }

    inline PositionType& getPosition()
    {
      return position_;
    }

    inline void setPosition(PositionType const& position)
    {
      position_ = position;
    }


    bool operator==(const MobilityPeak1D& rhs) const
    {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wfloat-equal"
      return intensity_ == rhs.intensity_ && position_ == rhs.position_;
#pragma clang diagnostic pop
    }

    bool operator!=(const MobilityPeak1D& rhs) const
    {
      return !(operator==(rhs));
    }

    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