matrix-make.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_MAKE_HPP_
#define LIBSEMIGROUPS_MATRIX_MAKE_HPP_
 
#include <cstddef>           // for size_t
#include <initializer_list>  // for initializer_list
#include <type_traits>       // for enable_if_t
#include <vector>            // for vector
 
#include "is-matrix.hpp"          // for IsMatrix, IsMa...
#include "matrix-class.hpp"       // for ProjMaxPlusMat
#include "matrix-exceptions.hpp"  // for throw_if_bad_e...
 
#include "libsemigroups/detail/matrix-exceptions.hpp"  // for throw_if_any_r
 
namespace libsemigroups {

  template <typename Mat,
            typename
            = std::enable_if_t<IsMatrix<Mat> && !IsMatWithSemiring<Mat>>>
  [[nodiscard]] Mat
  make(std::vector<std::vector<typename Mat::scalar_type>> const& rows);

  template <typename Mat,
            typename
            = std::enable_if_t<IsMatrix<Mat> && !IsMatWithSemiring<Mat>>>
  [[nodiscard]] Mat
  make(std::initializer_list<std::vector<typename Mat::scalar_type>> const&
           rows) {
    return make<Mat>(std::vector<std::vector<typename Mat::scalar_type>>(rows));
  }

  template <typename Mat,
            typename
            = std::enable_if_t<IsMatrix<Mat> && !IsMatWithSemiring<Mat>>>
  // TODO(1) vector version
  [[nodiscard]] Mat
  make(std::initializer_list<typename Mat::scalar_type> const& row);

  template <typename Mat,
            typename Semiring,
            typename = std::enable_if_t<IsMatrix<Mat>>>
  // TODO(1) pass Semiring by reference, this is hard mostly due to the way
  // the tests are written, which is not optimal.
  [[nodiscard]] Mat
  make(Semiring const* semiring,
       std::initializer_list<
           std::initializer_list<typename Mat::scalar_type>> const& rows);

  template <typename Mat,
            typename Semiring,
            typename = std::enable_if_t<IsMatrix<Mat>>>
  [[nodiscard]] Mat
  make(Semiring const*                                            semiring,
       std::vector<std::vector<typename Mat::scalar_type>> const& rows);

  template <typename Mat,
            typename Semiring,
            typename = std::enable_if_t<IsMatrix<Mat>>>
  [[nodiscard]] Mat
  make(Semiring const*                                         semiring,
       std::initializer_list<typename Mat::scalar_type> const& row);

  template <size_t R, size_t C, typename Scalar>
  [[nodiscard]] ProjMaxPlusMat<R, C, Scalar>
  make(std::initializer_list<std::initializer_list<Scalar>> const& rows) {
    return ProjMaxPlusMat<R, C, Scalar>(
        make<ProjMaxPlusMat<R, C, Scalar>::underlying_matrix_type>(rows));
  }
}  // namespace libsemigroups
 
#include "matrix-make.tpp"
#endif  // LIBSEMIGROUPS_MATRIX_MAKE_HPP_