CCMath 0.3.0 Release Candidate

.clang-format

@@ -2,18 +2,23 @@
 AccessModifierOffset: -4
 AlignConsecutiveAssignments: Consecutive
 AlignConsecutiveMacros: Consecutive
+AlignConsecutiveShortCaseStatements:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCaseColons: true
 AlignEscapedNewlines: Right
 AlignTrailingComments:
   Kind: Always
-AllowShortBlocksOnASingleLine: Always
+AllowShortBlocksOnASingleLine: Empty
 AllowShortCaseLabelsOnASingleLine: true
-AllowShortEnumsOnASingleLine: true
-AllowShortFunctionsOnASingleLine: InlineOnly
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
 AllowShortIfStatementsOnASingleLine: WithoutElse
 AllowShortLambdasOnASingleLine: All
-AllowShortLoopsOnASingleLine: true
+AllowShortLoopsOnASingleLine: false
 AlwaysBreakBeforeMultilineStrings: true
-AlwaysBreakTemplateDeclarations: Yes
+AlwaysBreakTemplateDeclarations: MultiLine
 BasedOnStyle: LLVM
 BinPackArguments: false
 BinPackParameters: false
@@ -31,40 +36,43 @@ BraceWrapping:
   BeforeElse: false
   BeforeLambdaBody: false
   BeforeWhile: false
-  IndentBraces: true
-  SplitEmptyFunction: true
-  SplitEmptyNamespace: true
-  SplitEmptyRecord: true
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyNamespace: false
+  SplitEmptyRecord: false
+BracedInitializerIndentWidth: 4
 BreakAfterAttributes: Never
-BreakBeforeBraces: Allman
+BreakBeforeBraces: Custom
 ColumnLimit: 160
 CompactNamespaces: false
-ConstructorInitializerAllOnOneLineOrOnePerLine: true
 Cpp11BracedListStyle: false
-DerivePointerAlignment: true
+DerivePointerAlignment: false
 FixNamespaceComments: true
 IncludeBlocks: Regroup
 IncludeCategories:
   # Headers in "" with .h extension.
-  - Regex: '"([A-Za-z0-9\/-_])+\.h"'
+  - Regex: '"[-A-Za-z0-9_/]+\.h"'
     Priority: 10
   # Headers in "" with .hpp extension.
-  - Regex: '"([A-Za-z0-9\/-_])+\.hpp"'
+  - Regex: '"[-A-Za-z0-9_/]+\.hpp"'
     Priority: 20
   # Headers in <> with .h extension.
-  - Regex: '<([A-Za-z0-9\/-_])+\.h>'
+  - Regex: '<[-A-Za-z0-9_/]+\.h>'
     Priority: 30
   # Headers in <> with .hpp extension.
-  - Regex: '<([A-Za-z0-9\/-_])+\.hpp>'
+  - Regex: '<[-A-Za-z0-9_/]+\.hpp>'
     Priority: 40
   # Headers in <> without an extension.
-  - Regex: '<([A-Za-z0-9\/-_])+>'
+  - Regex: '<[-A-Za-z0-9_/]+>'
     Priority: 50
 IndentPPDirectives: BeforeHash
 IndentWidth: 4
+InsertNewlineAtEOF: true
 Language: Cpp
 NamespaceIndentation: All
+PackConstructorInitializers: CurrentLine
 PointerAlignment: Middle
+ReferenceAlignment: Middle
 SortIncludes: CaseInsensitive
 SpaceAfterTemplateKeyword: true
 SpaceBeforeParens: ControlStatements
@@ -74,11 +82,10 @@ Standard: c++17
 TabWidth: 4
 UseTab: Always
 WhitespaceSensitiveMacros:
-  # Specific macros that suffer from formatting issues with white spaces
+  # Specific macros that suffer from formatting issues with white spaces.
   - CCM_DISABLE_CLANG_WARNING
   - CCM_ENABLE_CLANG_WARNING_AS_ERROR
   - CCM_DISABLE_GCC_WARNING
   - CCM_ENABLE_GCC_WARNING_AS_ERROR
   - CCM_ENABLE_IGNORE_GCC_WARNING
-  - CCM_DISABLE_IGNORE_GCC_WARNING
-...
+  - CCM_DISABLE_IGNORE_GCC_WARNING

.clang-tidy

@@ -7,20 +7,28 @@ bugprone-*,
 modernize-*,
 -modernize-use-trailing-return-type,
 -modernize-use-constraints,
--modernize-avoid-c-arrays,
+-modernize-use-nodiscard,
+-modernize-use-auto,
 
 performance-*,
 -performance-avoid-endl,
 
 readability-*,
 -readability-identifier-length,
 -readability-magic-numbers,
+-readability-function-cognitive-complexity,
+-readability-uppercase-literal-suffix,
 
 cppcoreguidelines-*,
 -cppcoreguidelines-avoid-magic-numbers,
 -cppcoreguidelines-macro-usage,
 -cppcoreguidelines-non-private-member-variables-in-classes,
 -cppcoreguidelines-special-member-func,
+-cppcoreguidelines-avoid-c-arrays,
+-cppcoreguidelines-pro-bounds-avoid-unchecked-container-access,
+-cppcoreguidelines-pro-bounds-constant-array-index,
+-cppcoreguidelines-pro-bounds-pointer-arithmetic,
+-cppcoreguidelines-pro-bounds-array-to-pointer-decay,
 
 cert-dcl21-cpp,
 cert-dcl58-cpp,
@@ -41,6 +49,7 @@ llvm-namespace-comment,
 hicpp-exception-baseclass,
 hicpp-multiway-paths-covered,
 hicpp-no-assembler,
+-hicpp-uppercase-literal-suffix,
 misc-const-correctness,
 misc-definitions-in-headers,
 misc-header-include-cycle,

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,76 +1,205 @@
 name: Bug Report
-description: Create a report to help us improve
+description: Report incorrect results, build failures, or other defects in ccmath
 title: '[BUG]: '
-labels: ['bug']
+labels: ['T: Bugfix', 'S: Untriaged']
 body:
   - type: checkboxes
     attributes:
-      label: Due Diligence
-      description: Before you submit a bug report, please check the following
+      label: Due diligence
       options:
-        - label: I have searched for similar issues before starting this bug report
+        - label: I searched existing issues and did not find a duplicate
           required: true
+        - label: I reproduced this against the latest main (or a tagged release)
+          required: true
+
+  - type: input
+    id: function
+    attributes:
+      label: Affected function(s)
+      description: 'The ccm:: function(s) involved.'
+      placeholder: ccm::pow, ccm::sin
+    validations:
+      required: true
+
+  - type: dropdown
+    id: family
+    attributes:
+      label: Function family
+      options:
+        - basic
+        - compare
+        - expo
+        - fmanip
+        - hyper
+        - misc
+        - nearest
+        - power
+        - special
+        - trig
+        - not sure
+    validations:
+      required: true
+
+  - type: dropdown
+    id: code-path
+    attributes:
+      label: Code path
+      description: Where the wrong result comes from. Select all that apply.
+      multiple: true
+      options:
+        - constexpr (compile-time)
+        - runtime (scalar kernel)
+        - SIMD (vectorized)
+        - deterministic mode (CCMATH_ENABLE_DETERMINISTIC)
+        - not sure
+    validations:
+      required: true
+
+  - type: dropdown
+    id: scalar-type
+    attributes:
+      label: Scalar type
+      options:
+        - float
+        - double
+        - long double
+        - integral
+        - multiple / not applicable
+    validations:
+      required: true
+
   - type: textarea
     id: description
     attributes:
       label: Describe the bug
-      description: A clear and concise description of what the bug is.
-      placeholder: e.g. ccm::sqrt(4) is incorrectly outputting 1.9999999... instead of 2.0 on clang-12 x86-64
+      description: What is wrong, in one or two sentences.
     validations:
       required: true
+
+  - type: textarea
+    id: input
+    attributes:
+      label: Input value(s)
+      description: Exact inputs. Prefer hex float so no precision is lost.
+      placeholder: 'x = 0x1.0000000000001p+0 (1.0000000000000002)'
+    validations:
+      required: true
+
+  - type: input
+    id: expected
+    attributes:
+      label: Expected result (and source of truth)
+      placeholder: '0x1.5bf0a8b145769p+1, per MPFR / the C++ standard'
+    validations:
+      required: true
+
+  - type: input
+    id: actual
+    attributes:
+      label: Actual result
+      placeholder: '0x1.5bf0a8b14576ap+1 (1 ULP high)'
+    validations:
+      required: true
+
+  - type: input
+    id: error
+    attributes:
+      label: Error magnitude (ULP) if known
+    validations:
+      required: false
+
+  - type: dropdown
+    id: rounding-mode
+    attributes:
+      label: Rounding mode
+      options:
+        - FE_TONEAREST (default)
+        - FE_DOWNWARD
+        - FE_UPWARD
+        - FE_TOWARDZERO
+        - unchanged / not sure
+    validations:
+      required: true
+
   - type: textarea
     id: reproduction
     attributes:
-      label: Steps to reproduce
-      description: Steps used to reproduce the bug.
+      label: Minimal reproduction
+      description: A self-contained snippet. A Godbolt link is ideal. Print exact bits, not via raw std::cout.
+      render: cpp
       placeholder: |
-        1. Set the compiler to clang-12 on x86-64
-        2. Write the following code:
-        ```cpp
-        #include <iostream> // std::cout and std::endl
+        #include <cstdio>
         #include <ccmath/ccmath.hpp>
         int main() {
-          std::cout << ccm::sqrt(4) << std::endl;
+          printf("%a\n", ccm::sqrt(4.0)); // expected 0x1p+1
         }
-        ```
-        3. Execute the program
-        4. See the output
     validations:
       required: true
-  - type: textarea
-    id: expected-behavior
+
+  - type: markdown
     attributes:
-      label: Expected behavior
-      description: A clear and concise description of what you expected to happen.
-      placeholder: The output should be outputting 2.0 as this is the square root of 4, but it is outputting 1.9999999... instead.
+      value: '## Environment'
+
+  - type: input
+    id: ccmath-version
+    attributes:
+      label: ccmath version or commit
+      placeholder: v0.2.0 or commit 65cb8ba9
     validations:
       required: true
-  - type: markdown
-    attributes:
-      value: '# System information'
+
   - type: input
-    id: compiler-version-and-type
+    id: compiler
     attributes:
-      label: Compiler version and type
-      description: The name of your compile and it's version
-      placeholder: GCC 13.2.1 (20230801)
+      label: Compiler and version
+      placeholder: Clang 18.1.0
     validations:
       required: true
+
+  - type: dropdown
+    id: cpp-standard
+    attributes:
+      label: C++ standard
+      options:
+        - 'C++17'
+        - 'C++20'
+        - 'C++23'
+        - 'C++26'
+    validations:
+      required: true
+
+  - type: dropdown
+    id: arch
+    attributes:
+      label: Architecture
+      options:
+        - x86-64
+        - x86
+        - AArch64 / ARM
+        - RISC-V
+        - other
+    validations:
+      required: true
+
+  - type: input
+    id: opt-level
+    attributes:
+      label: Optimization level and relevant flags
+      placeholder: '-O2 -ffp-contract=fast'
+    validations:
+      required: false
+
   - type: input
-    id: operating-system
+    id: os
     attributes:
-      label: Operating System
-      description:
-        If applicable (i.e, an issue with how the code compiles for your OS) the OS version this bug is happening in
-      placeholder: Ubuntu Linux 22.04
+      label: Operating system
+      placeholder: Ubuntu 24.04
     validations:
       required: false
+
   - type: textarea
-    id: screenshots
+    id: context
     attributes:
-      label: Screenshots
-      description: If applicable, add screenshots to help explain your problem.
-      placeholder: As you can see here, the output is not showing up
-      value: Not applicable
+      label: Additional context
     validations:
       required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question or design discussion
+    url: https://discord.gg/p3mVxAbdmc
+    about: Usage questions, design discussion, and general help belong on Discord.
+  - name: Security vulnerability
+    url: https://github.com/Rinzii/ccmath/security/policy
+    about: Report security issues privately as described in SECURITY.md. Do not open a public issue.