is_one_dimensional.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_ONE_DIMENSIONAL_HPP
#define OPENKALMAN_IS_ONE_DIMENSIONAL_HPP

#include "patterns/patterns.hpp"
#include "linear-algebra/concepts/indexible.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 >= 0)
  constexpr internal::boolean_testable auto
#else
  template<std::size_t N = values::unbounded_size, typename T, std::enable_if_t<
    (N == values::unbounded_size or N >= 0) and indexible<T>, int> = 0>
  constexpr auto
#endif
  is_one_dimensional(const T& t)
  {
    return patterns::compare_collection_patterns_with_dimension<1_uz, &stdex::is_eq, N>(get_pattern_collection(t));
  }

}

#endif