Homec4science
Diffusion akantu (features/developer-manual-initial) Browse

rAKA/src/common/aka_safe_enum.hh
73bed14ec284features/developer…

Last Change
Raw File

aka_safe_enum.hh
View Options

/**
* @file aka_safe_enum.hh
*
* @author Nicolas Richart <nicolas.richart@epfl.ch>
*
* @date creation: Thu Feb 21 2013
* @date last modification: Tue Nov 07 2017
*
* @brief Safe enums type (see More C++ Idioms/Type Safe Enum on Wikibooks
* http://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Type_Safe_Enum)
*
*
* Copyright (©) 2014-2018 EPFL (Ecole Polytechnique Fédérale de Lausanne)
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* Akantu 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 3 of the License, or (at your option) any
* later version.
*
* Akantu 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 Akantu. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
#ifndef AKANTU_AKA_SAFE_ENUM_HH_
#define AKANTU_AKA_SAFE_ENUM_HH_
namespace akantu {
/// Safe enumerated type
template <typename def, typename inner = typename def::type>
class safe_enum : public def {
using type = typename def::type;
public:
constexpr explicit safe_enum(type v = def::_end_) : val(v) {}
constexpr inner underlying() const { return val; }
constexpr bool operator==(const safe_enum & s) const {
return this->val == s.val;
}
constexpr bool operator!=(const safe_enum & s) const {
return this->val != s.val;
}
constexpr bool operator<(const safe_enum & s) const {
return this->val < s.val;
}
constexpr bool operator<=(const safe_enum & s) const {
return this->val <= s.val;
}
constexpr bool operator>(const safe_enum & s) const {
return this->val > s.val;
}
constexpr bool operator>=(const safe_enum & s) const {
return this->val >= s.val;
}
constexpr operator inner() { return val; };
public:
// Works only if enumerations are contiguous.
class const_iterator {
public:
constexpr explicit const_iterator(type v) : it(v) {}
constexpr const_iterator & operator++() {
++it;
return *this;
}
constexpr safe_enum operator*() { return safe_enum(static_cast<type>(it)); }
constexpr bool operator!=(const_iterator const & it) { return it.it != this->it; }
private:
int it;
};
constexpr auto begin() const { return const_iterator(def::_begin_); }
constexpr auto end() const { return const_iterator(def::_end_); }
private:
inner val;
};
} // namespace akantu
#endif /* AKANTU_AKA_SAFE_ENUM_HH_ */
c4science · Help