matrix-exceptions.hpp

//
// libsemigroups - C++ library for semigroups and monoids
// Copyright (C) 2026 James D. Mitchell
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
 
#ifndef LIBSEMIGROUPS_MATRIX_EXCEPTIONS_HPP_
#define LIBSEMIGROUPS_MATRIX_EXCEPTIONS_HPP_
 
#include <algorithm>    // for find_if_not
#include <string>       // for basic_string
#include <type_traits>  // for enable_if_t
 
#include "constants.hpp"       // for POSITIVE_INFINITY
#include "exception.hpp"       // for LIBSEMIGROUPS_EXCEPTION
#include "is-matrix.hpp"       // for IsMatrix
#include "matrix-helpers.hpp"  // for threshold, period
 
#include "detail/matrix-common.hpp"      // for entry_repr
#include "detail/matrix-exceptions.hpp"  // for throw_if_semiring_nullptr
 
namespace libsemigroups::matrix {

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& x) -> std::enable_if_t<IsIntMat<Mat>>;

  // NOTE this function isn't used and so should be deleted
  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsIntMat<Mat>>;

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& m) -> std::enable_if_t<IsBMat<Mat>>;

  // NOTE this function isn't used and so should be deleted
  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsBMat<Mat>>;

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& x) -> std::enable_if_t<IsMaxPlusMat<Mat>>;

  // NOTE this function isn't used and so should be deleted
  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsMaxPlusMat<Mat>>;

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& x) -> std::enable_if_t<IsMinPlusMat<Mat>>;

  // NOTE this function isn't used and so should be deleted
  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsMinPlusMat<Mat>>;

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& m)
      -> std::enable_if_t<IsMaxPlusTruncMat<Mat>>;

  // NOTE this function isn't used and so should be deleted
  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&                m,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsMaxPlusTruncMat<Mat>>;

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& m)
      -> std::enable_if_t<IsMinPlusTruncMat<Mat>>;

  // NOTE this function isn't used and so should be deleted
  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&                m,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsMinPlusTruncMat<Mat>>;

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& m) -> std::enable_if_t<IsNTPMat<Mat>>;

  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&                m,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsNTPMat<Mat>>;

  template <typename Mat>
  auto throw_if_bad_entry(Mat const& x)
      -> std::enable_if_t<IsProjMaxPlusMat<Mat>> {
    throw_if_bad_entry(x.underlying_matrix());
  }

  template <typename Mat>
  [[deprecated]] auto throw_if_bad_entry(Mat const&                x,
                                         typename Mat::scalar_type val)
      -> std::enable_if_t<IsProjMaxPlusMat<Mat>> {
    throw_if_bad_entry(x.underlying_matrix(), val);
  }
}  // namespace libsemigroups::matrix
 
#include "matrix-exceptions.tpp"
#endif  // LIBSEMIGROUPS_MATRIX_EXCEPTIONS_HPP_