ElementList.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright © 2014-2024 Allan Leal
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
// Reaktoro includes
#include <Reaktoro/Common/Types.hpp>
#include <Reaktoro/Core/Element.hpp>
 
namespace Reaktoro {
 
class ElementList
{
public:
    ElementList();
 
    ElementList(std::initializer_list<Element> elements);
 
    ElementList(const Vec<Element>& elements);
 
    auto append(const Element& element) -> void;
 
    auto data() const -> const Vec<Element>&;
 
    auto empty() const -> bool;
 
    auto size() const -> Index;
 
    auto operator[](Index i) const -> const Element&;
 
    auto find(const String& symbol) const -> Index;
 
    auto findWithSymbol(const String& symbol) const -> Index;
 
    auto findWithName(const String& name) const -> Index;
 
    auto index(const String& symbol) const -> Index;
 
    auto indexWithSymbol(const String& symbol) const -> Index;
 
    auto indexWithName(const String& name) const -> Index;
 
    auto get(const String& symbol) const -> const Element&;
 
    auto getWithSymbol(const String& symbol) const -> const Element&;
 
    auto getWithName(const String& name) const -> const Element&;
 
    auto withSymbols(const StringList& symbols) const -> ElementList;
 
    auto withNames(const StringList& names) const -> ElementList;
 
    auto withTag(const String& tag) const -> ElementList;
 
    auto withoutTag(const String& tag) const -> ElementList;
 
    auto withTags(const StringList& tags) const -> ElementList;
 
    auto withoutTags(const StringList& tags) const -> ElementList;
 
    operator Vec<Element>&();
 
    operator Vec<Element>const&() const;
 
private:
    Vec<Element> m_elements;
 
public:
    template<typename InputIterator>
    ElementList(InputIterator begin, InputIterator end) : m_elements(begin, end) {}
 
    auto begin() const { return m_elements.begin(); }
 
    auto begin() { return m_elements.begin(); }
 
    auto end() const { return m_elements.end(); }
 
    auto end() { return m_elements.end(); }
 
    auto push_back(const Element& elements) -> void { append(elements); }
 
    template<typename Iterator, typename InputIterator>
    auto insert(Iterator pos, InputIterator begin, InputIterator end) -> void { m_elements.insert(pos, begin, end); }
 
    using value_type = Element;
};
 
auto operator+(const ElementList& a, const ElementList& b) -> ElementList;
 
} // namespace Reaktoro