symmetry.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <uni20/symmetry/symmetryimpl.hpp>
 
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
 
namespace uni20
{
 
class Symmetry {
  public:
    Symmetry() = default;
 
    explicit Symmetry(std::string_view spec) : impl_(detail::SymmetryImpl::parse(spec)) {}
 
    explicit Symmetry(detail::SymmetryImpl const* impl) : impl_(impl) {}
 
    static auto parse(std::string_view spec) -> Symmetry { return Symmetry{detail::SymmetryImpl::parse(spec)}; }
 
    auto valid() const -> bool { return impl_ != nullptr; }
 
    auto factor_count() const -> std::size_t
    {
      this->ensure_valid();
      return impl_->factor_count();
    }
 
    auto factors() const -> std::span<detail::SymmetryFactorSpec const>
    {
      this->ensure_valid();
      return impl_->factors();
    }
 
    auto to_string() const -> std::string
    {
      this->ensure_valid();
      return impl_->to_string();
    }
 
    auto impl() const -> detail::SymmetryImpl const*
    {
      this->ensure_valid();
      return impl_;
    }
 
    auto operator==(Symmetry const& other) const -> bool = default;
 
  private:
    void ensure_valid() const
    {
      if (!this->valid())
      {
        throw std::logic_error("Symmetry handle is not initialized");
      }
    }
 
    detail::SymmetryImpl const* impl_ = nullptr;
};
 
inline auto to_string(Symmetry const& symmetry) -> std::string { return symmetry.to_string(); }
 
} // namespace uni20