lammps/lib/kokkos/core/unit_test/TestViewHooks.hpp

/*
//@HEADER
// ************************************************************************
//
//                        Kokkos v. 3.0
//       Copyright (2020) National Technology & Engineering
//               Solutions of Sandia, LLC (NTESS).
//
// Under the terms of Contract DE-NA0003525 with NTESS,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Christian R. Trott (crtrott@sandia.gov)
//
// ************************************************************************
//@HEADER
*/
#ifndef TESTVIEWHOOKS_HPP_
#define TESTVIEWHOOKS_HPP_

#include <gtest/gtest.h>
#include <Kokkos_Core.hpp>

namespace Test {
template <class DeviceType>
struct TestViewHooks {
  struct TestSubscriber;

  static_assert(
      Kokkos::Experimental::is_hooks_policy<
          Kokkos::Experimental::SubscribableViewHooks<TestSubscriber> >::value,
      "Must be a hooks policy");

  using test_view_type =
      Kokkos::View<double **,
                   Kokkos::Experimental::SubscribableViewHooks<TestSubscriber>,
                   DeviceType>;

  struct TestSubscriber {
    static test_view_type *self_ptr;
    static const test_view_type *other_ptr;

    template <typename View>
    static void copy_constructed(View &self, const View &other) {
      self_ptr  = &self;
      other_ptr = &other;
    }

    template <typename View>
    static void move_constructed(View &self, const View &other) {
      self_ptr  = &self;
      other_ptr = &other;
    }

    template <typename View>
    static void copy_assigned(View &self, const View &other) {
      self_ptr  = &self;
      other_ptr = &other;
    }

    template <typename View>
    static void move_assigned(View &self, const View &other) {
      self_ptr  = &self;
      other_ptr = &other;
    }

    static void reset() {
      self_ptr  = nullptr;
      other_ptr = nullptr;
    }
  };

  static void testViewHooksCopyConstruct() {
    TestSubscriber::reset();
    test_view_type testa;

    test_view_type testb(testa);
    EXPECT_EQ(TestSubscriber::self_ptr, &testb);
    EXPECT_EQ(TestSubscriber::other_ptr, &testa);
  }

  static void testViewHooksMoveConstruct() {
    TestSubscriber::reset();
    test_view_type testa;

    test_view_type testb(std::move(testa));
    EXPECT_EQ(TestSubscriber::self_ptr, &testb);

    // This is valid, even if the view is moved-from
    EXPECT_EQ(TestSubscriber::other_ptr, &testa);
  }

  static void testViewHooksCopyAssign() {
    TestSubscriber::reset();
    test_view_type testa;

    test_view_type testb;
    testb = testa;
    EXPECT_EQ(TestSubscriber::self_ptr, &testb);
    EXPECT_EQ(TestSubscriber::other_ptr, &testa);
  }

  static void testViewHooksMoveAssign() {
    TestSubscriber::reset();
    test_view_type testa;

    test_view_type testb;
    testb = std::move(testa);
    EXPECT_EQ(TestSubscriber::self_ptr, &testb);

    // This is valid, even if the view is moved-from
    EXPECT_EQ(TestSubscriber::other_ptr, &testa);
  }
};

template <class DeviceType>
typename TestViewHooks<DeviceType>::test_view_type
    *TestViewHooks<DeviceType>::TestSubscriber::self_ptr = nullptr;

template <class DeviceType>
const typename TestViewHooks<DeviceType>::test_view_type
    *TestViewHooks<DeviceType>::TestSubscriber::other_ptr = nullptr;

TEST(TEST_CATEGORY, view_hooks) {
  using ExecSpace = TEST_EXECSPACE;
  TestViewHooks<ExecSpace>::testViewHooksCopyConstruct();
  TestViewHooks<ExecSpace>::testViewHooksMoveConstruct();
  TestViewHooks<ExecSpace>::testViewHooksCopyAssign();
  TestViewHooks<ExecSpace>::testViewHooksMoveAssign();
}

}  // namespace Test
#endif  // TESTVIEWHOOKS_HPP_