ElementAccessor.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) 2020-2024 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_ELEMENTACCESSOR_HPP
#define OPENKALMAN_ELEMENTACCESSOR_HPP

#include <functional>

namespace OpenKalman::internal
{
#ifdef __cpp_lib_ranges
  template<indexible Object, index_range_for<Object> Indices> requires
    writable_by_component<Object, Indices> and values::index<std::ranges::range_value_t<Indices>>
#else
  template<typename Object, typename Indices>
#endif
  struct ElementAccessor
  {
    using Scalar = scalar_type_of_t<Object>;


#ifdef __cpp_lib_ranges
    template<typename Arg, std::invocable PreAccess, std::invocable PostSet> requires
      std::same_as<Scalar, scalar_type_of_t<Arg>>
#else
    template<typename Arg, typename PreAccess, typename PostSet, std::enable_if_t<
      std::is_invocable_v<PreAccess> and std::is_invocable_v<PostSet> and
      std::is_same_v<Scalar, typename scalar_type_of<Arg>::type>, int> = 0>
#endif
    ElementAccessor(Arg&& arg, Indices&& indices, PreAccess&& pre_access = []{}, PostSet&& post_set = []{})
      : object {std::forward<Arg>(arg)},
        indices {std::forward<Indices>(indices)},
        before_access {std::forward<decltype(pre_access)>(pre_access)},
        after_set {std::forward<decltype(post_set)>(post_set)} {}


    operator Scalar() const
    {
      before_access();
      return get_component(object, indices);
    }


    void operator=(Scalar s)
    {
      before_access();
      set_component(object, s, indices);
      after_set();
    }

  private:

    Object object;

    Indices indices;

    const std::function<void()> before_access;

    const std::function<void()> after_set;

  };


  // ----------------- //
  //  Deduction guide  //
  // ----------------- //

  template<typename Arg, typename Indices, typename PreAccess, typename PostSet>
  ElementAccessor(Arg&&, Indices&&, PreAccess&&, PostSet&&) -> ElementAccessor<Arg, Indices>;


}

#endif //OPENKALMAN_ELEMENTACCESSOR_HPP