cutlass/test/unit/core/float8.cu

/***************************************************************************************************
 * Copyright (c) 2017 - 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * 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 copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR 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.
 *
 **************************************************************************************************/
/*! \file
    \brief Tests for basic float8 functionality
*/

#include "../common/cutlass_unit_test.h"

#include "cutlass/numeric_types.h"
#include <bitset>

/////////////////////////////////////////////////////////////////////////////////////////////////

TEST(float_e4m3_t, host_conversion) {
  using FP8 = cutlass::float_e4m3_t;
  using Base = typename FP8::Base;
  const float max_abs_normal_val = 448.0f; // 0.1111.110
  const float min_abs_subnormal_val = 0.001953125f; // 0.0000.001 

  for (int i = -8; i < 8; ++i) {
    float f = static_cast<float>(i);

    cutlass::int4b_t s = static_cast<cutlass::int4b_t>(i);
    FP8 w = static_cast<FP8>(s);
    FP8 x = static_cast<FP8>(i);
    FP8 y = static_cast<FP8>(f);

    EXPECT_TRUE(static_cast<cutlass::int4b_t>(w) == s);
    EXPECT_TRUE(static_cast<int>(x) == i);
    EXPECT_TRUE(static_cast<float>(y) == f);

    if (i >= 0) {
      cutlass::uint4b_t u = static_cast<cutlass::uint4b_t>(i);
      FP8 z = static_cast<FP8>(u);
      EXPECT_TRUE(static_cast<unsigned>(z) == u);
    }
  }

  // Try out default-ctor (zero initialization of primitive proxy type)
  EXPECT_TRUE(FP8() == 0.0_fe4m3);

  // Try out user-defined literals
  EXPECT_TRUE(FP8(7) == 7_fe4m3);
  EXPECT_TRUE(7 == static_cast<int>(7_fe4m3));
}

TEST(float_e5m2_t, host_conversion) {
  using FP8 = cutlass::float_e5m2_t;
  using Base = typename FP8::Base;
  const float max_abs_normal_val = 57344.0f; // 0.11110.11
  const float min_abs_subnormal_val = 0.0000152588f; // 0.00000.01 

  for (int i = -8; i < 8; ++i) {
    float f = static_cast<float>(i);

    cutlass::int4b_t s = static_cast<cutlass::int4b_t>(i);
    FP8 w = static_cast<FP8>(s);
    FP8 x = static_cast<FP8>(i);
    FP8 y = static_cast<FP8>(f);

    EXPECT_TRUE(static_cast<cutlass::int4b_t>(w) == s);
    EXPECT_TRUE(static_cast<int>(x) == i);
    EXPECT_TRUE(static_cast<float>(y) == f);

    if (i >= 0) {
      cutlass::uint4b_t u = static_cast<cutlass::uint4b_t>(i);
      FP8 z = static_cast<FP8>(u);
      EXPECT_TRUE(static_cast<cutlass::uint4b_t>(z) == u);
    }
  }

  // Try out default-ctor (zero initialization of primitive proxy type)
  EXPECT_TRUE(FP8() == 0.0_fe5m2);

  // Try out user-defined literals
  EXPECT_TRUE(FP8(7) == 7_fe5m2);
  EXPECT_TRUE(7 == static_cast<int>(7_fe5m2));
}

TEST(float_e4m3_t, host_arithmetic) {
  for (int i = -4; i < 4; ++i) {
    for (int j = -4; j < 4; ++j) {

      cutlass::float_e4m3_t x = static_cast<cutlass::float_e4m3_t>(i);
      cutlass::float_e4m3_t y = static_cast<cutlass::float_e4m3_t>(j);

      EXPECT_TRUE(static_cast<int>(x + y) == (i + j));
    }
  }
}

TEST(float_e5m2_t, host_arithmetic) {
  for (int i = -4; i < 4; ++i) {
    for (int j = -4; j < 4; ++j) {

      cutlass::float_e5m2_t x = static_cast<cutlass::float_e5m2_t>(i);
      cutlass::float_e5m2_t y = static_cast<cutlass::float_e5m2_t>(j);

      EXPECT_TRUE(static_cast<int>(x + y) == (i + j));
    }
  }
}

/////////////////////////////////////////////////////////////////////////////////////////////////