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/>.
//
 
// This file contains declarations of exception throwing functions for use
// in matrix.hpp.
 
#ifndef LIBSEMIGROUPS_DETAIL_MATRIX_EXCEPTIONS_HPP_
#define LIBSEMIGROUPS_DETAIL_MATRIX_EXCEPTIONS_HPP_
 
#include <algorithm>         // for find_if_not
#include <initializer_list>  // for initializer_list
#include <iterator>          // for distance, empty
#include <stddef.h>          // for size_t
#include <stdint.h>          // for uint64_t
#include <string_view>       // for basic_string_view, string_view
#include <type_traits>       // for enable_if_t
 
#include "libsemigroups/exception.hpp"  // for LIBSEMIGROUPS_EXCEPTION
#include "libsemigroups/is-matrix.hpp"  // for IsStaticMatrix, IsDynamicMatrix
 
namespace libsemigroups {
  namespace matrix {

    // TODO deprecate + move to detail
    template <typename Mat>
    void throw_if_not_square(Mat const&       x,
                             std::string_view arg_desc = "the argument");

    // TODO deprecate
    template <typename Mat>
    void throw_if_bad_dim(Mat const&       x,
                          Mat const&       y,
                          std::string_view arg_desc_x = "the 1st argument",
                          std::string_view arg_desc_y = "the 2nd argument");

    // TODO deprecate -> detail
    template <typename Mat>
    void throw_if_bad_coords(Mat const& x, size_t r, size_t c);
  }  // namespace matrix
 
  namespace detail {
    template <typename Mat>
    void throw_if_semiring_nullptr(Mat const& m);
 
    template <typename Mat, typename Container>
    auto throw_if_bad_dim(Container const& m)
        -> std::enable_if_t<IsStaticMatrix<Mat>>;
 
    // Not checking dynamic matrices, no compile-time dimensions.
    template <typename Mat, typename Container>
    auto throw_if_bad_dim(Container const&)
        -> std::enable_if_t<IsDynamicMatrix<Mat>> {}
 
    template <typename Mat, typename Container>
    auto throw_if_bad_row_dim(Container const& row)
        -> std::enable_if_t<IsStaticMatrix<Mat>>;
 
    template <typename Mat, typename Container>
    auto throw_if_bad_row_dim(Container const&)
        -> std::enable_if_t<IsDynamicMatrix<Mat>> {}
 
    template <typename Container>
    void throw_if_any_row_wrong_size(Container const& m);
 
    template <typename Scalar>
    void throw_if_any_row_wrong_size(
        std::initializer_list<std::initializer_list<Scalar>> m) {
      throw_if_any_row_wrong_size<
          std::initializer_list<std::initializer_list<Scalar>>>(m);
    }
  }  // namespace detail
}  // namespace libsemigroups
 
#include "matrix-exceptions.tpp"
#endif  // LIBSEMIGROUPS_DETAIL_MATRIX_EXCEPTIONS_HPP_