Fix #122 via from ckormanyos/issue_0122

ckormanyos · web-flow · commit f44ec20762b1 · 2025-02-27T21:51:58.000+01:00
Fixes #122
diff --git a/.clang-tidy b/.clang-tidy
@@ -12,7 +12,6 @@ Checks: >
 
 WarningsAsErrors: '*'
 HeaderFilterRegex: '.*'
-AnalyzeTemporaryDtors: false
 FormatStyle:     none
 User:            john
 CheckOptions:
diff --git a/.github/workflows/soft_double.yml b/.github/workflows/soft_double.yml
@@ -294,30 +294,46 @@ jobs:
           fetch-depth: '0'
       - name: update-tools
         run: |
-          sudo apt install libncurses5 libpython2.7
+          sudo apt update
+          wget http://security.ubuntu.com/ubuntu/pool/universe/n/ncurses/libtinfo5_6.3-2ubuntu0.1_amd64.deb
+          sudo apt install ./libtinfo5_6.3-2ubuntu0.1_amd64.deb
+          wget http://security.ubuntu.com/ubuntu/pool/universe/n/ncurses/libncursesw5_6.3-2ubuntu0.1_amd64.deb
+          sudo apt install ./libncursesw5_6.3-2ubuntu0.1_amd64.deb
           mkdir -p emu_env && cd emu_env
-          wget --no-check-certificate https://armkeil.blob.core.windows.net/developer/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2
-          tar -xvf gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2
-          wget --no-check-certificate https://github.com/xpack-dev-tools/qemu-arm-xpack/releases/download/v7.1.0-1/xpack-qemu-arm-7.1.0-1-linux-x64.tar.gz
-          tar -xvzf xpack-qemu-arm-7.1.0-1-linux-x64.tar.gz
+          wget --no-check-certificate https://developer.arm.com/-/media/Files/downloads/gnu/13.3.rel1/binrel/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi.tar.xz
+          tar -xf arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi.tar.xz
+          wget --no-check-certificate https://github.com/xpack-dev-tools/qemu-arm-xpack/releases/download/v8.2.6-1/xpack-qemu-arm-8.2.6-1-linux-x64.tar.gz
+          tar -xzf xpack-qemu-arm-8.2.6-1-linux-x64.tar.gz
         working-directory: ./
       - name: build-example-stm32f429
         run: |
+          PATH="${{ runner.workspace }}/soft_double/emu_env/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin:$PATH"
+          echo 'Query arm-none-eabi-g++ version'
+          echo
+          arm-none-eabi-g++ -v
+          echo
           mkdir -p bin
-          emu_env/gcc-arm-none-eabi-10.3-2021.10/bin/arm-none-eabi-g++ -std=${{ matrix.standard }} -Werror -Wall -Wextra -Wpedantic -pedantic -O0 -g -gdwarf-2 -ffunction-sections -fdata-sections -x c++ -fno-rtti -fno-use-cxa-atexit -fno-exceptions -fno-nonansi-builtins -fno-threadsafe-statics -fno-enforce-eh-specs -ftemplate-depth=32 -mcpu=cortex-m4 -mtune=cortex-m4 -mthumb -mfloat-abi=soft -mno-unaligned-access -mno-long-calls -I. -DWIDE_INTEGER_STANDALONE_EXAMPLE010_HYPERGEOMETRIC_2F1 examples/example010_hypergeometric_2f1.cpp ./target/micros/stm32f429/make/single/crt.cpp -nostartfiles -Wl,--gc-sections -Wl,-Map,./bin/example010_hypergeometric_2f1.map -T ./target/micros/stm32f429/make/stm32f429.ld --specs=nano.specs --specs=nosys.specs -o ./bin/example010_hypergeometric_2f1.elf
-          emu_env/gcc-arm-none-eabi-10.3-2021.10/bin/arm-none-eabi-objcopy ./bin/example010_hypergeometric_2f1.elf -O ihex ./bin/example010_hypergeometric_2f1.hex
+          arm-none-eabi-g++ -std=${{ matrix.standard }} -Werror -Wall -Wextra -Wpedantic -pedantic -O0 -g -gdwarf-2 -ffunction-sections -fdata-sections -x c++ -fno-rtti -fno-use-cxa-atexit -fno-exceptions -fno-nonansi-builtins -fno-threadsafe-statics -fno-enforce-eh-specs -ftemplate-depth=32 -mcpu=cortex-m4 -mtune=cortex-m4 -mthumb -mfloat-abi=soft -mno-unaligned-access -mno-long-calls -I. -DWIDE_INTEGER_STANDALONE_EXAMPLE010_HYPERGEOMETRIC_2F1 examples/example010_hypergeometric_2f1.cpp ./target/micros/stm32f429/make/single/crt.cpp -nostartfiles -Wl,--gc-sections -Wl,-Map,./bin/example010_hypergeometric_2f1.map -T ./target/micros/stm32f429/make/stm32f429.ld --specs=nano.specs --specs=nosys.specs -o ./bin/example010_hypergeometric_2f1.elf
+          arm-none-eabi-objcopy ./bin/example010_hypergeometric_2f1.elf -O ihex ./bin/example010_hypergeometric_2f1.hex
           ls -la ./bin/example010_hypergeometric_2f1.elf ./bin/example010_hypergeometric_2f1.hex ./bin/example010_hypergeometric_2f1.map
         working-directory: ./
       - name: emulate-target stm32f429
         run: |
-          ./emu_env/xpack-qemu-arm-7.1.0-1/bin/qemu-system-gnuarmeclipse --verbose --mcu STM32F429ZI --nographic --gdb tcp::9999 -d unimp,guest_errors &
+          PATH="${{ runner.workspace }}/soft_double/emu_env/xpack-qemu-arm-8.2.6-1/bin:$PATH"
+          qemu-system-gnuarmeclipse --verbose --mcu STM32F429ZI --nographic --gdb tcp::9999 -d unimp,guest_errors &
+          sleep 2
         working-directory: ./
       - name: run-test-on-target
         run: |
-          ./emu_env/gcc-arm-none-eabi-10.3-2021.10/bin/arm-none-eabi-gdb-py ./bin/example010_hypergeometric_2f1.elf -x ./target/build/test_examples_emulator.py
-          qemu_result=$?
-          echo "qemu_result" "$qemu_result"
-          echo "qemu_result" "$qemu_result" | grep 'qemu_result 0'
+          sleep 2
+          PATH="${{ runner.workspace }}/soft_double/emu_env/arm-gnu-toolchain-13.3.rel1-x86_64-arm-none-eabi/bin:$PATH"
+          echo 'Run test on target'
+          echo
+          arm-none-eabi-gdb ./bin/example010_hypergeometric_2f1.elf -x ./target/build/test_examples_emulator.gdb > ./example010_hypergeometric_2f1.txt
+          cat ./example010_hypergeometric_2f1.txt
+          echo
+          echo 'We will now grep for the right answer...'
+          grep 'value 0xF00DCAFE' ./example010_hypergeometric_2f1.txt
         working-directory: ./
   gcc-clang-boost-math-snippets:
     runs-on: ubuntu-latest
diff --git a/.tidy/make/make_tidy_03_flags.gmk b/.tidy/make/make_tidy_03_flags.gmk
@@ -1,5 +1,5 @@
 ﻿# ------------------------------------------------------------------------------
-#  Copyright Christopher Kormanyos 2022 - 2023.
+#  Copyright Christopher Kormanyos 2022 - 2025.
 #  Distributed under the Boost Software License,
 #  Version 1.0. (See accompanying file LICENSE_1_0.txt
 #  or copy at http://www.boost.org/LICENSE_1_0.txt)
@@ -35,12 +35,25 @@ C_INCLUDES  :=$(addprefix -I,$(C_INCLUDES))
 
 
 TIDY_CHECKS  = "*,                                                             \
-               -altera-struct-pack-align,                                      \
-               -altera-unroll-loops,                                           \
-               -fuchsia-*,                                                     \
-               -llvmlibc-*,                                                    \
-               -readability-identifier-length,                                 \
-               -readability-identifier-naming"
+                -cert-dcl58-cpp,                                               \
+                -cppcoreguidelines-rvalue-reference-param-not-moved,           \
+                -cppcoreguidelines-avoid-do-while,                             \
+                -modernize-type-traits,                                        \
+                -modernize-use-constraints,                                    \
+                -misc-header-include-cycle,                                    \
+                -misc-include-cleaner,                                         \
+                -misc-const-correctness,                                       \
+                -modernize-use-std-numbers,                                    \
+                -performance-avoid-endl,                                       \
+                -readability-avoid-nested-conditional-operator,                \
+                -readability-identifier-length,                                \
+                -readability-identifier-naming,                                \
+                -readability-redundant-casting,                                \
+                -altera-struct-pack-align,                                     \
+                -altera-unroll-loops,                                          \
+                -fuchsia-*,                                                    \
+                -llvmlibc-*"
+
 
 TIDY_FLAGS   = --extra-arg-before=--driver-mode=g++                            \
                -warnings-as-errors=*                                           \
diff --git a/examples/example001_roots_sqrt.cpp b/examples/example001_roots_sqrt.cpp
@@ -1,12 +1,11 @@
 ///////////////////////////////////////////////////////////////////
-//  Copyright Christopher Kormanyos 2020 - 2022.                 //
+//  Copyright Christopher Kormanyos 2020 - 2025.                 //
 //  Distributed under the Boost Software License,                //
 //  Version 1.0. (See accompanying file LICENSE_1_0.txt          //
 //  or copy at http://www.boost.org/LICENSE_1_0.txt)             //
 ///////////////////////////////////////////////////////////////////
 
 #include <cmath>
-#include <cstdint>
 
 #include <math/softfloat/soft_double.h>
 #include <math/softfloat/soft_double_examples.h>
@@ -48,7 +47,7 @@ auto math::softfloat::example001_roots_sqrt() -> bool
 }
 
 // Enable this if you would like to activate this main() as a standalone example.
-#if 0
+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)
 
 #include <iomanip>
 #include <iostream>
diff --git a/examples/example004_bessel_recur.cpp b/examples/example004_bessel_recur.cpp
@@ -36,7 +36,7 @@ auto bisect(const std::function<FloatingPointType(const FloatingPointType)>& pfn
   {
     // Bisection interval has no root or it has multiple roots!
 
-    return static_cast<floating_point_type>(static_cast<int>(INT8_C(0)));
+    return static_cast<floating_point_type>(static_cast<int>(INT8_C(0))); // NOLINT(readability-redundant-casting)
   }
 
   // Orient the search such that f > 0 lies at x + dx.
@@ -248,7 +248,7 @@ auto math::softfloat::example004_bessel_recur() -> bool
 }
 
 // Enable this if you would like to activate this main() as a standalone example.
-#if 0
+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)
 
 #include <iomanip>
 #include <iostream>
diff --git a/examples/example005_polylog_series.cpp b/examples/example005_polylog_series.cpp
@@ -101,7 +101,7 @@ auto math::softfloat::example005_polylog_series() -> bool
 }
 
 // Enable this if you would like to activate this main() as a standalone example.
-#if 0
+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)
 
 #include <iomanip>
 #include <iostream>
diff --git a/examples/example007_catalan_series.cpp b/examples/example007_catalan_series.cpp
@@ -142,7 +142,7 @@ auto math::softfloat::example007_catalan_series() -> bool
 }
 
 // Enable this if you would like to activate this main() as a standalone example.
-#if 0
+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)
 
 #include <iomanip>
 #include <iostream>
diff --git a/examples/example011_trig_trapezoid_integral.cpp b/examples/example011_trig_trapezoid_integral.cpp
@@ -159,7 +159,7 @@ auto math::softfloat::example011_trig_trapezoid_integral() -> bool
 }
 
 // Enable this if you would like to activate this main() as a standalone example.
-#if 0
+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)
 
 #include <iomanip>
 #include <iostream>
diff --git a/examples/example012_exercise_constexpr.cpp b/examples/example012_exercise_constexpr.cpp
@@ -51,7 +51,7 @@ auto math::softfloat::example012_exercise_constexpr() -> bool
 
 
 // Enable this if you would like to activate this main() as a standalone example.
-#if 0
+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)
 
 #include <iomanip>
 #include <iostream>
diff --git a/math/softfloat/soft_double.h b/math/softfloat/soft_double.h
@@ -1,5 +1,5 @@
 ﻿///////////////////////////////////////////////////////////////////
-//  Copyright Christopher Kormanyos 2012 - 2024.                 //
+//  Copyright Christopher Kormanyos 2012 - 2025.                 //
 //  Distributed under the Boost Software License,                //
 //  Version 1.0. (See accompanying file LICENSE_1_0.txt          //
 //  or copy at http://www.boost.org/LICENSE_1_0.txt)             //
@@ -421,7 +421,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     using float_type    = BuiltInFloatType;
     using unsigned_type = ExactUnsignedIntegralType;
 
-    const float_type my_f; // NOLINT(misc-non-private-member-variables-in-classes)
+    const float_type my_f; // NOLINT(misc-non-private-member-variables-in-classes,cppcoreguidelines-avoid-const-or-ref-data-members)
 
     explicit constexpr uz_type(float_type    f) noexcept : my_f(f) { }
 
@@ -733,7 +733,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     SOFT_DOUBLE_NODISCARD constexpr auto to_float() const -> typename std::enable_if<(   (sizeof(FloatingPointType) == static_cast<std::size_t>(UINT8_C(8)))
                                                                                       && std::numeric_limits<FloatingPointType>::is_iec559), FloatingPointType>::type
     {
-      return static_cast<FloatingPointType>(*static_cast<const volatile FloatingPointType*>(static_cast<const volatile void*>(this)));
+      return static_cast<FloatingPointType>(*static_cast<const volatile FloatingPointType*>(static_cast<const volatile void*>(this))); // NOLINT(bugprone-casting-through-void)
     }
 
   public:
@@ -1371,19 +1371,21 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     static constexpr auto f64_to_f32(const std::uint64_t a) -> float
     {
       return
-        softfloat_roundPackToF32
-        (
-          detail::signF64UI(a),
-          static_cast<std::int16_t>(detail::expF64UI(a) - static_cast<std::int16_t>(INT16_C(0x381))),
-          static_cast<std::uint32_t>
-          (
+        (a == 0)
+          ? 0.0F // See issue 122 at: https://github.com/ckormanyos/soft_double/issues/122
+          : softfloat_roundPackToF32
+            (
+              detail::signF64UI(a),
+              static_cast<std::int16_t>(detail::expF64UI(a) - static_cast<std::int16_t>(INT16_C(0x381))),
               static_cast<std::uint32_t>
               (
-                detail::softfloat_shortShiftRightJam64(detail::fracF64UI(a), static_cast<std::uint_fast16_t>(UINT8_C(22)))
+                  static_cast<std::uint32_t>
+                  (
+                    detail::softfloat_shortShiftRightJam64(detail::fracF64UI(a), static_cast<std::uint_fast16_t>(UINT8_C(22)))
+                  )
+                | static_cast<std::uint32_t>(UINT32_C(0x40000000))
               )
-            | static_cast<std::uint32_t>(UINT32_C(0x40000000))
-          )
-        );
+            );
     }
 
     static constexpr auto softfloat_roundPackToF32(bool sign, std::int16_t expA, std::uint32_t sig) -> float
diff --git a/soft_double_vs2022.vcxproj b/soft_double_vs2022.vcxproj
@@ -60,7 +60,7 @@
     <None Include="codecov.yml" />
     <None Include="README.md" />
     <None Include="sonar-project.properties" />
-    <None Include="target\build\test_examples_emulator.py">
+    <None Include="target\build\test_examples_emulator.gdb">
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release|x64'">true</ExcludedFromBuild>
     </None>
diff --git a/soft_double_vs2022.vcxproj.filters b/soft_double_vs2022.vcxproj.filters
@@ -178,12 +178,12 @@
     <None Include=".github\workflows\soft_double_codecov.yml">
       <Filter>.github\workflows</Filter>
     </None>
-    <None Include="target\build\test_examples_emulator.py">
-      <Filter>target\build</Filter>
-    </None>
     <None Include="target\micros\stm32f429\make\stm32f429.ld">
       <Filter>target\micros\stm32f429\make</Filter>
     </None>
+    <None Include="target\build\test_examples_emulator.gdb">
+      <Filter>target\build</Filter>
+    </None>
   </ItemGroup>
   <ItemGroup>
     <Text Include="examples\CMakeLists.txt">
diff --git a/target/build/test_examples_emulator.gdb b/target/build/test_examples_emulator.gdb
@@ -0,0 +1,28 @@
+# ///////////////////////////////////////////////////////////////////
+# //  Copyright Christopher Kormanyos 2020 - 2024.
+# //  Distributed under the Boost Software License,
+# //  Version 1.0. (See accompanying file LICENSE_1_0.txt
+# //  or copy at http://www.boost.org/LICENSE_1_0.txt)
+# //
+
+# Connect to the target (e.g., OpenOCD or another GDB server).
+target remote localhost:9999
+monitor halt
+
+# Ensure that the program is loaded.
+load
+
+# Set a breakpoint at the specified subroutine.
+break example_get_standalone_result
+
+# Start or continue program execution.
+continue
+
+# Format and print the value of a variable.
+printf "value 0x%X\n\n", example_standalone_result
+
+# Delete (all) breakpoint(s).
+delete
+
+# Perform a non-elegant quit of the GDB session.
+quit
diff --git a/target/build/test_examples_emulator.py b/target/build/test_examples_emulator.py
diff --git a/test/test_soft_double_spot_values.cpp b/test/test_soft_double_spot_values.cpp
diff --git a/util/utility/util_constexpr_algorithm_unsafe.h b/util/utility/util_constexpr_algorithm_unsafe.h

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ auto bisect(const std::function<FloatingPointType(const FloatingPointType)>& pfn`
`36`	`36`	`{`
`37`	`37`	`// Bisection interval has no root or it has multiple roots!`
`38`	`38`
`39`		`- return static_cast<floating_point_type>(static_cast<int>(INT8_C(0)));`
	`39`	`+ return static_cast<floating_point_type>(static_cast<int>(INT8_C(0))); // NOLINT(readability-redundant-casting)`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`// Orient the search such that f > 0 lies at x + dx.`
`@@ -248,7 +248,7 @@ auto math::softfloat::example004_bessel_recur() -> bool`
`248`	`248`	`}`
`249`	`249`
`250`	`250`	`// Enable this if you would like to activate this main() as a standalone example.`
`251`		`-#if 0`
	`251`	`+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)`
`252`	`252`
`253`	`253`	`#include <iomanip>`
`254`	`254`	`#include <iostream>`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ auto math::softfloat::example005_polylog_series() -> bool`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`// Enable this if you would like to activate this main() as a standalone example.`
`104`		`-#if 0`
	`104`	`+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)`
`105`	`105`
`106`	`106`	`#include <iomanip>`
`107`	`107`	`#include <iostream>`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ auto math::softfloat::example007_catalan_series() -> bool`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`// Enable this if you would like to activate this main() as a standalone example.`
`145`		`-#if 0`
	`145`	`+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)`
`146`	`146`
`147`	`147`	`#include <iomanip>`
`148`	`148`	`#include <iostream>`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ auto math::softfloat::example011_trig_trapezoid_integral() -> bool`
`159`	`159`	`}`
`160`	`160`
`161`	`161`	`// Enable this if you would like to activate this main() as a standalone example.`
`162`		`-#if 0`
	`162`	`+#if 0 // NOLINT(readability-avoid-unconditional-preprocessor-if)`
`163`	`163`
`164`	`164`	`#include <iomanip>`
`165`	`165`	`#include <iostream>`