PermutationMatrix.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) 2019-2023 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_EIGEN_TRAITS_PERMUTATIONMATRIX_HPP
#define OPENKALMAN_EIGEN_TRAITS_PERMUTATIONMATRIX_HPP

#include <type_traits>


namespace OpenKalman::interface
{
  template<int SizeAtCompileTime, int MaxSizeAtCompileTime, typename StorageIndex>
  struct indexible_object_traits<Eigen::PermutationMatrix<SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex>>
    : Eigen3::indexible_object_traits_base<Eigen::PermutationMatrix<SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex>>
  {
  private:

    using Base = Eigen3::indexible_object_traits_base<Eigen::PermutationMatrix<SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex>>;

  public:

    template<typename Arg>
    static decltype(auto) nested_object(Arg&& arg)
    {
      return std::forward<Arg>(arg).indices();
    }


    // PermutationMatrix is always self-contained.

    // get_constant() not defined

    // get_constant_diagonal() not defined
  };

} // namespace OpenKalman::interface

#endif //OPENKALMAN_EIGEN_TRAITS_PERMUTATIONMATRIX_HPP