ListUtils.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: Stephan Aiche, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/OpenMSConfig.h>
#include <OpenMS/config.h>
 
#include <cmath>
#include <iterator>
#include <vector>
#include <algorithm>
 
namespace OpenMS
{
 
  typedef std::vector<Int> IntList;
 
  typedef std::vector<double> DoubleList;
 
 
  typedef std::vector<String> StringList;
 
  class OPENMS_DLLAPI ListUtils
  {
private:
    struct DoubleTolerancePredicate_
    {
      DoubleTolerancePredicate_(const double& target, const double& tolerance) :
        tolerance_(tolerance),
        target_(target)
      {}
 
      inline bool operator()(const double& value) const
      {
        return std::fabs(value - target_) < tolerance_;
      }
 
private:
      double tolerance_;
      double target_;
    };
 
public:
    template <typename T>
    static std::vector<T> create(const String& str, const char splitter = ',')
    {
      // temporary storage for the individual elements of the string
      std::vector<String> temp_string_vec;
      str.split(splitter, temp_string_vec);
      return create<T>(temp_string_vec);
    }
 
    template <typename T>
    static std::vector<T> create(const std::vector<String>& s);
 
 
    template <typename T>
    static std::vector<String> toStringList(const std::vector<T>& s)
    {
      StringList out;
      out.reserve(s.size());
      for (const auto& elem : s) out.push_back(elem);
      return out;
    }
 
    template <typename T, typename E>
    static bool contains(const std::vector<T>& container, const E& elem)
    {
      return find(container.begin(), container.end(), elem) != container.end();
    }
 
    static bool contains(const std::vector<double>& container, const double& elem, double tolerance = 0.00001)
    {
      return find_if(container.begin(), container.end(), DoubleTolerancePredicate_(elem, tolerance)) != container.end();
    }
 
 
    enum class CASE { SENSITIVE, INSENSITIVE};
    static bool contains(const std::vector<String>& container, String elem, const CASE case_sensitive)
    {
      if (case_sensitive == CASE::SENSITIVE) return contains(container, elem);
      // case insensitive ...
      elem.toLower();
      return find_if(container.begin(), container.end(), [&elem](String ce) {
        return elem == ce.toLower();
      }) != container.end();
    }
 
    template <typename T>
    static String concatenate(const std::vector<T>& container, const String& glue = "")
    {
      return concatenate< std::vector<T> >(container, glue);
    }
 
    template <typename T>
    static String concatenate(const T& container, const String& glue = "")
    {
      // handle empty containers
      if (container.empty()) return "";
 
      typename T::const_iterator it = container.begin();
      String ret = String(*it);
      // we have handled the first element
      ++it;
      // add the rest
      for (; it != container.end(); ++it)
      {
        ret += (glue + String(*it));
      }
 
      return ret;
    }
 
    template <typename T, typename E>
    static Int getIndex(const std::vector<T>& container, const E& elem)
    {
      typename std::vector<T>::const_iterator pos =
        std::find(container.begin(), container.end(), elem);
      if (pos == container.end()) return -1;
 
      return static_cast<Int>(std::distance(container.begin(), pos));
    }
 
  };
 
  namespace detail
  {
    template <typename T>
    T convert(const String& s);
  
    template<>
    inline Int32 convert(const String& s)
    {
      return s.toInt32();
    }
    template<>
    inline double convert(const String& s)
    {
      return s.toDouble();
    }
    template<>
    inline float convert(const String& s)
    {
      return s.toFloat();
    }
    template<>
    inline std::string convert(const String& s)
    {
        return static_cast<std::string>(s);
    }
  }
 
  template <typename T>
  inline std::vector<T> ListUtils::create(const std::vector<String>& s)
  {
    std::vector<T> c;
    c.reserve(s.size());
    for (std::vector<String>::const_iterator it = s.begin(); it != s.end(); ++it)
    {
      try
      {
        c.push_back(detail::convert<T>(String(*it).trim())); // succeeds only if the whole output can be explained, i.e. "1.3 3" will fail (which is good)
      }
      catch (...)
      {
        throw Exception::ConversionError(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, String("Could not convert string '") + *it + "'");
      }
    }
 
    return c;
  }
 
  template <>
  inline std::vector<String> ListUtils::create(const std::vector<String>& s)
  {
    return s;
  }
 
} // namespace OpenMS