nullary.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) 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_NULLARYFUNCTORTRAITS_HPP
#define OPENKALMAN_EIGEN_NULLARYFUNCTORTRAITS_HPP

#include "linear-algebra/traits/triangle_type_of.hpp"

namespace OpenKalman::Eigen3
{
  // Default nullary traits, if NullaryOp is not specifically matched.
  template<typename NullaryOp, typename PlainObjectType>
  struct NullaryFunctorTraits
  {
    template<typename Arg>
    static constexpr auto get_constant(const Arg& arg) { return arg.functor()(); }

    template<typename Arg>
    static constexpr auto get_constant_diagonal(const Arg&) { return std::monostate {}; }

    template<triangle_type t>
    static constexpr bool triangle_type_value = false;

    static constexpr bool is_hermitian = false;
  };


  template<typename Scalar, typename PlainObjectType>
  struct NullaryFunctorTraits<Eigen::internal::scalar_identity_op<Scalar>, PlainObjectType>
  {
    template<typename Arg>
    static constexpr auto get_constant(const Arg&) { return std::monostate {}; }

    template<typename Arg>
    static constexpr auto get_constant_diagonal(const Arg&) { return values::fixed_value<Scalar, 1>{}; }

    static constexpr triangle_type triangle_type_value = triangle_type::diagonal;

    static constexpr bool is_hermitian = true;
  };


  template<typename Scalar, typename PlainObjectType>
  struct NullaryFunctorTraits<Eigen::internal::linspaced_op<Scalar>, PlainObjectType>
  {
    template<typename Arg>
    static constexpr auto get_constant(const Arg&) { return std::monostate {}; }

    template<typename Arg>
    static constexpr auto get_constant_diagonal(const Arg&) { return std::monostate {}; }

    template<triangle_type t>
    static constexpr bool triangle_type_value = false;

    static constexpr bool is_hermitian = false;
  };


  template<typename Scalar, typename PlainObjectType>
  struct NullaryFunctorTraits<Eigen::internal::scalar_constant_op<Scalar>, PlainObjectType>
  {
    template<typename Arg>
    static constexpr auto get_constant(const Arg& arg) { return arg.functor()(); }

    template<typename Arg>
    static constexpr auto get_constant_diagonal(const Arg&) { return std::monostate {}; }

    template<triangle_type t>
    static constexpr bool triangle_type_value = false;

    static constexpr bool is_hermitian = not values::complex<Scalar>;
  };

}

#endif