is_square_shaped.hpp

Go to the documentation of this file.

/* This file is part of OpenKalman, a header-only C++ library for
 * Kalman filters and other recursive filters.
 *
 * Copyright (c) 2022-2026 Christopher Lee Ogden <ogden@gatech.edu>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

#ifndef OPENKALMAN_IS_SQUARE_SHAPED_HPP
#define OPENKALMAN_IS_SQUARE_SHAPED_HPP

#include "patterns/patterns.hpp"
#include "linear-algebra/traits/get_pattern_collection.hpp"

namespace OpenKalman
{
#ifdef __cpp_concepts
  template<auto N = values::unbounded_size, indexible T> requires
    (values::integral<decltype(N)> or stdex::same_as<std::decay_t<decltype(N)>, values::unbounded_size_t>) and
    (not values::integral<decltype(N)> or N >= 2)
#else
  template<std::size_t N = values::unbounded_size, typename T, std::enable_if_t<
    (N == values::unbounded_size or N >= 2) and indexible<T>, int> = 0>
#endif
  constexpr auto
  is_square_shaped(const T& t)
  {
#ifdef __cpp_concepts
    if constexpr (std::same_as<std::decay_t<decltype(N)>, values::unbounded_size_t>)
#else
    if constexpr (N == std::size_t(values::unbounded_size))
#endif
      return patterns::get_common_pattern_collection_dimension<std::max(2_uz, index_count_v<T>)>(
        get_pattern_collection(t));
    else
      return patterns::get_common_pattern_collection_dimension<N>(
        get_pattern_collection(t));


  }


}

#endif