Types.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
 
// C++ includes
#include <any>
#include <array>
#include <cstddef>
#include <deque>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <variant>
#include <vector>
 
// Third-party includes
#include <tsl/ordered_map.h>
 
// Reaktoro includes
#include <Reaktoro/Common/Real.hpp>
 
namespace Reaktoro {
 
using Index = std::size_t;
 
using Indices = std::vector<Index>;
 
using Chars = const char*;
 
using String = std::string;
 
using Strings = std::vector<std::string>;
 
using StringOrIndex = std::variant<Index, int, std::string>;
 
template<typename T, std::size_t N>
using Array = std::array<T, N>;
 
template<typename T>
using Vec = std::vector<T>;
 
template<typename T>
using Deque = std::deque<T>;
 
template<typename Key, typename T>
using Map = std::unordered_map<Key, T>;
 
// Conveniet alias to `std::unordered_set<T>`
template<typename T>
using Set = std::unordered_set<T>;
 
// Conveniet alias to `tsl::ordered_map<Key, T>`
template<class Key, class T>
using Dict = tsl::ordered_map<Key, T>;
 
template<typename T, typename U>
using Pair = std::pair<T, U>;
 
template<typename T, typename U>
using Pairs = Vec<Pair<T, U>>;
 
template<typename... Args>
using Tuple = std::tuple<Args...>;
 
template<typename... Args>
using Tuples = Vec<Tuple<Args...>>;
 
template<typename T>
using Ptr = std::unique_ptr<T>;
 
template<typename T>
using SharedPtr = std::shared_ptr<T>;
 
template<typename F>
using Fn = std::function<F>;
 
template<typename T>
using Optional = std::optional<T>;
 
template<typename T>
using OptionalRef = std::optional<std::reference_wrapper<T>>;
 
template<typename T>
using OptionalConstRef = std::optional<std::reference_wrapper<const T>>;
 
using Any = std::any;
 
using Nullptr = std::nullptr_t;
 
} // namespace Reaktoro