FlagSet.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-2023.
//
// 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/Macros.h> // for OPENMS_PRECONDITION
 
namespace OpenMS
{
  template<class ENUM>
  class FlagSet
  {
  public:
    FlagSet() 
      : value_(0)
    {}
 
    explicit FlagSet(const ENUM& en)
      : value_(getPow_(en))
    {
    }
 
    FlagSet(const FlagSet& stat) = default;
 
    FlagSet& operator=(const FlagSet& stat) = default;
 
    FlagSet& operator=(const ENUM& en) = delete;
 
 
    ~FlagSet() = default;
 
    bool operator==(const FlagSet& stat) const
    {
      return (value_ == stat.value_);
    }
 
    FlagSet operator&(const ENUM& en) const
    {
      FlagSet s(*this) ;
      s &= en;
      return s;
    }
 
    FlagSet operator&(const FlagSet& rhs) const
    {
      FlagSet s(*this);
      s &= rhs;
      return s;
    }
 
    FlagSet& operator&=(const ENUM& en)
    {
      value_ &= getPow_(en);
      return *this;
    }
  
    FlagSet& operator&=(const FlagSet& rhs)
    {
      value_ &= rhs.value_;
      return *this;
    }
 
    FlagSet operator|(const ENUM& en) const
    {
      FlagSet s(*this);
      s.value_ |= getPow_(en);
      return s;
    }
    FlagSet operator|(const FlagSet& rhs) const
    {
      FlagSet s(*this);
      s.value_ |= rhs.value_;
      return s;
    }
 
    FlagSet& operator|=(const ENUM& en)
    {
      value_ |= getPow_(en);
      return *this;
    }
 
    FlagSet& operator|=(const FlagSet& rhs)
    {
      value_ |= rhs.value_;
      return *this;
    }
 
    FlagSet operator+(const ENUM& en) const
    {
      return *this | en;
    }
 
    FlagSet operator+(const FlagSet& en) const
    {
      return *this | en;
    }
    FlagSet& operator+=(const ENUM& rhs)
    {
      return *this |= rhs;
    }
 
    FlagSet& operator+=(const FlagSet& rhs)
    {
      return *this |= rhs;
    }
 
    FlagSet operator-(const FlagSet& rhs)
    {
      FlagSet r(*this);
      r -= rhs;
      return r;
    }
 
    FlagSet& operator-=(const FlagSet& rhs)
    {
      auto overlap = value_ & rhs.value_;
      value_ ^= overlap; // disable bits which overlap with rhs using XOR
      return *this;
    }
 
    FlagSet operator-(const ENUM& rhs)
    {
      FlagSet r(*this);
      r -= rhs;
      return r;
    }
 
    FlagSet& operator-=(const ENUM& rhs)
    {
      auto overlap = value_ & FlagSet(rhs).value_;
      value_ ^= overlap; // disable bits which overlap with rhs using XOR
      return *this;
    }
 
    bool isSuperSetOf(const FlagSet& required) const
    {
      return ((*this | required) == *this);
    }
 
    bool isSuperSetOf(const ENUM& required) const
    {
      return ((*this | required) == *this);
    }
 
    bool empty() const
    {
      return value_ == 0;
    }
 
    UInt64 value() const
    {
      return value_;
    }
 
  private:
    UInt64 getPow_(const ENUM& en) const
    {
      OPENMS_PRECONDITION((int)en >= 0, "Enum value is too small!")
      OPENMS_PRECONDITION((int)en <= 63, "Enum value is too large!")
      return UInt64(1) << UInt64(en);
    }
    UInt64 value_;
  };
}