ruy/test_special_mul_params.cc

/* Copyright 2019 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==============================================================================*/

// This test covers non-basic specs.

#include "ruy/test.h"

namespace ruy {

template <typename AccumScalar, typename DstScalar,
          LoopStructure tLoopStructure>
struct LoopStructureMulParams : MulParams<AccumScalar, DstScalar> {
  static constexpr LoopStructure kLoopStructure = tLoopStructure;
};

template <typename AccumScalar, typename DstScalar,
          ZeroPointSupport tZeroPointSupport>
struct ZeroPointSupportMulParams : MulParams<AccumScalar, DstScalar> {
  static constexpr ZeroPointSupport kZeroPointSupport = tZeroPointSupport;
};

template <typename AccumScalar, typename DstScalar>
struct RCCMulParams : MulParams<AccumScalar, DstScalar> {
  static constexpr LayoutSupport kLayoutSupport = LayoutSupport::kRCC;
};

template <typename AccumScalar, typename DstScalar, typename LhsKernelLayout,
          typename RhsKernelLayout>
struct StandardCppKernelLayoutMulParams : MulParams<AccumScalar, DstScalar> {
  using StandardCppKernelLhsLayout = LhsKernelLayout;
  using StandardCppKernelRhsLayout = RhsKernelLayout;
};

using LhsScalar = RUY_TEST_LHSSCALAR;
using RhsScalar = RUY_TEST_RHSSCALAR;
using AccumScalar = RUY_TEST_ACCUMSCALAR;
using DstScalar = RUY_TEST_DSTSCALAR;

template <LoopStructure tLoopStructure>
void TestLoopStructure() {
  using SpecType =
      LoopStructureMulParams<AccumScalar, DstScalar, tLoopStructure>;
  using TestSetType = TestSet<LhsScalar, RhsScalar, SpecType>;
  for (int size = 1; size < 10; size++) {
    TestLinearAllOrders<TestSetType>(size, size, size);
  }
  TestLinearAllOrders<TestSetType>(3, 5, 78);
  TestLinearAllOrders<TestSetType>(19, 91, 7);
  TestLinearAllOrders<TestSetType>(71, 26, 44);
  TestLinearAllOrders<TestSetType>(81, 93, 72);
}

TEST(TestSpecialSpecs, LoopStructure) {
  static_assert(MulParams<std::uint8_t, std::int32_t>::kLoopStructure ==
                    LoopStructure::kAuto,
                "");
  static_assert(MulParams<float, float>::kLoopStructure == LoopStructure::kAuto,
                "");
  TestLoopStructure<LoopStructure::kSimple>();
  TestLoopStructure<LoopStructure::kGeneral>();
}

template <ZeroPointSupport tZeroPointSupport>
void TestZeroPointSupport(LhsScalar lhs_zero_point, RhsScalar rhs_zero_point,
                          DstScalar dst_zero_point,
                          ExpectedOutcome expected_outcome) {
  using SpecType =
      ZeroPointSupportMulParams<AccumScalar, DstScalar, tZeroPointSupport>;
  using TestSetType = TestSet<LhsScalar, RhsScalar, SpecType>;
  TestSetType test_set;
  test_set.rows = 11;
  test_set.depth = 12;
  test_set.cols = 13;
  test_set.lhs_order = Order::kRowMajor;
  test_set.rhs_order = Order::kColMajor;
  test_set.dst_order = Order::kColMajor;
  test_set.layout_style = LayoutStyle::kUnstridedLinear;
  test_set.expected_outcome = expected_outcome;
  test_set.lhs_zero_point = lhs_zero_point;
  test_set.rhs_zero_point = rhs_zero_point;
  test_set.dst_zero_point = dst_zero_point;
  test_set.use_specified_zero_points = true;
  test_set.Run();
}

TEST(TestSpecialSpecs, ZeroPointSupport) {
  // Sanity check
  RUY_CHECK_EQ(SymmetricZeroPoint<std::uint8_t>(), 128);
  RUY_CHECK_EQ(SymmetricZeroPoint<std::int8_t>(), 0);

  if (std::is_floating_point<LhsScalar>::value) {
    return;
  }

  TestZeroPointSupport<ZeroPointSupport::kGeneral>(
      SymmetricZeroPoint<LhsScalar>(), SymmetricZeroPoint<RhsScalar>(),
      SymmetricZeroPoint<DstScalar>(), ExpectedOutcome::kSuccess);
  TestZeroPointSupport<ZeroPointSupport::kGeneral>(
      SymmetricZeroPoint<LhsScalar>() - 1, SymmetricZeroPoint<RhsScalar>(),
      SymmetricZeroPoint<DstScalar>(), ExpectedOutcome::kSuccess);
  TestZeroPointSupport<ZeroPointSupport::kSymmetric>(
      SymmetricZeroPoint<LhsScalar>(), SymmetricZeroPoint<RhsScalar>(),
      SymmetricZeroPoint<DstScalar>(), ExpectedOutcome::kSuccess);
  TestZeroPointSupport<ZeroPointSupport::kSymmetric>(
      SymmetricZeroPoint<LhsScalar>() + 1, SymmetricZeroPoint<RhsScalar>(),
      SymmetricZeroPoint<DstScalar>(), ExpectedOutcome::kDeath);
  TestZeroPointSupport<ZeroPointSupport::kSymmetric>(
      SymmetricZeroPoint<LhsScalar>(), SymmetricZeroPoint<RhsScalar>() + 1,
      SymmetricZeroPoint<DstScalar>(), ExpectedOutcome::kDeath);
  TestZeroPointSupport<ZeroPointSupport::kSymmetric>(
      SymmetricZeroPoint<LhsScalar>(), SymmetricZeroPoint<RhsScalar>(),
      SymmetricZeroPoint<DstScalar>() - 1, ExpectedOutcome::kDeath);
}

TEST(TestSpecialSpecs, RCC) {
  using RCCMulParams = RCCMulParams<AccumScalar, DstScalar>;
  using RCCTestSet = TestSet<LhsScalar, RhsScalar, RCCMulParams>;
  TestRCC<RCCTestSet>(81, 93, 72);
  TestNonRCC<RCCTestSet>(81, 93, 72, ExpectedOutcome::kDeath);
}

template <typename LhsKernelLayout, typename RhsKernelLayout>
void TestStandardCppKernelLayout() {
  using SpecType =
      StandardCppKernelLayoutMulParams<AccumScalar, DstScalar, LhsKernelLayout,
                                       RhsKernelLayout>;
  using TestSetType = TestSet<LhsScalar, RhsScalar, SpecType>;
  for (int size = 1; size < 10; size++) {
    TestLinearAllOrders<TestSetType>(size, size, size);
  }
  TestLinearAllOrders<TestSetType>(87, 34, 56);
  TestLinearAllOrders<TestSetType>(123, 234, 78);
}

TEST(TestSpecialSpecs, StandardCppKernelLayoutTrivial1x1) {
  TestStandardCppKernelLayout<FixedKernelLayout<Order::kColMajor, 1, 1>,
                              FixedKernelLayout<Order::kColMajor, 1, 1>>();
}

TEST(TestSpecialSpecs, StandardCppKernelLayoutSquare4x4) {
  TestStandardCppKernelLayout<FixedKernelLayout<Order::kRowMajor, 4, 4>,
                              FixedKernelLayout<Order::kRowMajor, 4, 4>>();
}

TEST(TestSpecialSpecs, StandardCppKernelLayoutRectangular4x8) {
  TestStandardCppKernelLayout<FixedKernelLayout<Order::kColMajor, 1, 4>,
                              FixedKernelLayout<Order::kColMajor, 1, 8>>();
}

}  // namespace ruy