Bring Dev branch into main for v0.1.3 (#26)

Author: Rinzii

.clang-format

@@ -1,11 +1,12 @@
 ---
 Language: Cpp
-BasedOnStyle: Microsoft
+BasedOnStyle: LLVM
 AccessModifierOffset: -4
 AlignConsecutiveAssignments: Consecutive
 AlignConsecutiveMacros: Consecutive
 AlignEscapedNewlines: Right
-AlignTrailingComments: Always
+AlignTrailingComments:
+    Kind: Always
 AllowShortEnumsOnASingleLine: true
 AllowShortCaseLabelsOnASingleLine: true
 AllowShortFunctionsOnASingleLine: InlineOnly
@@ -46,7 +47,7 @@ IncludeCategories:
     # Headers in <> with .hpp extension.
     - Regex: '<([A-Za-z0-9\/-_])+\.hpp>'
       Priority: 20
-    # Headers in <> without extension.
+    # Headers in <> without an extension.
     - Regex: '<([A-Za-z0-9\/-_])+>'
       Priority: 30
 NamespaceIndentation: All

.clang-tidy

@@ -1,56 +1,22 @@
 ---
 Checks: '-*,
-bugprone-argument-comment,
-bugprone-assert-side-effect,
-bugprone-bad-signal-to-kill-thread,
-bugprone-branch-clone,
-bugprone-copy-constructor-init,
-bugprone-dangling-handle,
-bugprone-dynamic-static-initializers,
-bugprone-fold-init-type,
-bugprone-forward-declaration-namespace,
-bugprone-forwarding-reference-overload,
-bugprone-inaccurate-erase,
-bugprone-incorrect-roundings,
-bugprone-integer-division,
-bugprone-lambda-function-name,
-bugprone-macro-parentheses,
-bugprone-macro-repeated-side-effects,
-bugprone-misplaced-operator-in-strlen-in-alloc,
-bugprone-misplaced-pointer-arithmetic-in-alloc,
-bugprone-misplaced-widening-cast,
-bugprone-move-forwarding-reference,
-bugprone-multiple-statement-macro,
-bugprone-no-escape,
-bugprone-not-null-terminated-result,
-bugprone-parent-virtual-call,
-bugprone-posix-return,
-bugprone-reserved-identifier,
-bugprone-sizeof-container,
-bugprone-sizeof-expression,
-bugprone-spuriously-wake-up-functions,
-bugprone-string-constructor,
-bugprone-string-integer-assignment,
-bugprone-string-literal-with-embedded-nul,
-bugprone-suspicious-enum-usage,
-bugprone-suspicious-include,
-bugprone-suspicious-memset-usage,
-bugprone-suspicious-missing-comma,
-bugprone-suspicious-semicolon,
-bugprone-suspicious-string-compare,
-bugprone-suspicious-memory-comparison,
-bugprone-suspicious-realloc-usage,
-bugprone-swapped-arguments,
-bugprone-terminating-continue,
-bugprone-throw-keyword-missing,
-bugprone-too-small-loop-variable,
-bugprone-undefined-memory-manipulation,
-bugprone-undelegated-constructor,
-bugprone-unhandled-self-assignment,
-bugprone-unused-raii,
-bugprone-unused-return-value,
-bugprone-use-after-move,
-bugprone-virtual-near-miss,
+bugprone-*,
+-bugprone-easily-swappable-parameters,
+
+modernize-*,
+-modernize-use-trailing-return-type,
+-modernize-use-constraints,
+
+performance-*,
+-performance-avoid-endl,
+
+readability-*,
+-readability-identifier-length,
+-readability-magic-numbers,
+
+cppcoreguidelines-*,
+-cppcoreguidelines-avoid-magic-numbers,
+
 cert-dcl21-cpp,
 cert-dcl58-cpp,
 cert-err34-c,
@@ -60,88 +26,29 @@ cert-flp30-c,
 cert-msc50-cpp,
 cert-msc51-cpp,
 cert-str34-c,
-cppcoreguidelines-interfaces-global-init,
-cppcoreguidelines-narrowing-conversions,
-cppcoreguidelines-pro-type-member-init,
-cppcoreguidelines-pro-type-static-cast-downcast,
-cppcoreguidelines-slicing,
 google-default-arguments,
 google-explicit-constructor,
 google-runtime-operator,
+google-readability-casting,
+google-upgrade-googletest-case,
+llvm-include-order,
+llvm-namespace-comment,
 hicpp-exception-baseclass,
 hicpp-multiway-paths-covered,
+hicpp-no-assembler,
+misc-const-correctness,
+misc-definitions-in-headers,
+misc-header-include-cycle,
+misc-include-cleaner,
 misc-misplaced-const,
 misc-new-delete-overloads,
 misc-no-recursion,
 misc-non-copyable-objects,
+misc-static-assert,
 misc-throw-by-value-catch-by-reference,
 misc-unconventional-assign-operator,
 misc-uniqueptr-reset-release,
-modernize-avoid-bind,
-modernize-concat-nested-namespaces,
-modernize-deprecated-headers,
-modernize-deprecated-ios-base-aliases,
-modernize-loop-convert,
-modernize-make-shared,
-modernize-make-unique,
-modernize-pass-by-value,
-modernize-raw-string-literal,
-modernize-redundant-void-arg,
-modernize-replace-auto-ptr,
-modernize-replace-disallow-copy-and-assign-macro,
-modernize-replace-random-shuffle,
-modernize-return-braced-init-list,
-modernize-shrink-to-fit,
-modernize-unary-static-assert,
-modernize-use-auto,
-modernize-use-bool-literals,
-modernize-use-emplace,
-modernize-use-equals-default,
-modernize-use-equals-delete,
-modernize-use-nodiscard,
-modernize-use-noexcept,
-modernize-use-nullptr,
-modernize-use-override,
-modernize-use-transparent-functors,
-modernize-use-uncaught-exceptions,
+misc-use-anonymous-namespace,
 mpi-buffer-deref,
 mpi-type-mismatch,
-openmp-use-default-none,
-performance-faster-string-find,
-performance-for-range-copy,
-performance-implicit-conversion-in-loop,
-performance-inefficient-algorithm,
-performance-inefficient-string-concatenation,
-performance-inefficient-vector-operation,
-performance-move-const-arg,
-performance-move-constructor-init,
-performance-no-automatic-move,
-performance-noexcept-move-constructor,
-performance-trivially-destructible,
-performance-type-promotion-in-math-fn,
-performance-unnecessary-copy-initialization,
-performance-unnecessary-value-param,
-portability-simd-intrinsics,
-readability-avoid-const-params-in-decls,
-readability-const-return-type,
-readability-container-size-empty,
-readability-convert-member-functions-to-static,
-readability-delete-null-pointer,
-readability-deleted-default,
-readability-inconsistent-declaration-parameter-name,
-readability-make-member-function-const,
-readability-misleading-indentation,
-readability-misplaced-array-index,
-readability-non-const-parameter,
-readability-redundant-control-flow,
-readability-redundant-declaration,
-readability-redundant-function-ptr-dereference,
-readability-redundant-smartptr-get,
-readability-redundant-string-cstr,
-readability-redundant-string-init,
-readability-simplify-subscript-expr,
-readability-static-accessed-through-instance,
-readability-static-definition-in-anonymous-namespace,
-readability-string-compare,
-readability-uniqueptr-delete-release,
-readability-use-anyofallof'
+openmp-use-default-none'

.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# This file defines the owners of the code in this repository.
+# See https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners for more information.
+
+# Assign @Rinzii as code owner for all files in the repository
+*       @Rinzii

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,76 @@
+name: Bug Report
+description: Create a report to help us improve
+title: '[BUG]: '
+labels: ['bug']
+body:
+  - type: checkboxes
+    attributes:
+      label: Due Diligence
+      description: Before you submit a bug report, please check the following
+      options:
+        - label: I have searched for similar issues before starting this bug report
+          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
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: Steps used to reproduce the bug.
+      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 <ccmath/ccmath.hpp>
+        int main() {
+          std::cout << ccm::sqrt(4) << std::endl;
+        }
+        ```
+        3. Execute the program
+        4. See the output
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    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.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: '# System information'
+  - type: input
+    id: compiler-version-and-type
+    attributes:
+      label: Compiler version and type
+      description: The name of your compile and it's version
+      placeholder: GCC 13.2.1 (20230801)
+    validations:
+      required: true
+  - type: input
+    id: operating-system
+    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
+    validations:
+      required: false
+  - type: textarea
+    id: screenshots
+    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
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1 @@
+<!-- Please target the "dev" branch when creating a pull request to ensure you are using the latest version of ccmath -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.18)
 
-set(CCMATH_BUILD_VERSION 0.1.2)
+set(CCMATH_BUILD_VERSION 0.1.3)
 set(INTERNAL_PROJ_DEFAULT_NAME ccmath)
 
 project(${INTERNAL_PROJ_DEFAULT_NAME} VERSION ${CCMATH_BUILD_VERSION})
@@ -20,6 +20,7 @@ option(CCMATH_BUILD_EXAMPLES "Build ccmath examples" ${is_root_project})
 option(CCMATH_BUILD_BENCHMARKS "Build ccmath benchmarks" ${is_root_project})
 option(CCMATH_INSTALL "Setup install and package steps" ${is_root_project})
 option(CCMATH_USE_SIMD "Use SIMD instructions" OFF) # SIMD is not yet implemented.
+option(CCMATH_ENABLE_EXTENSIONS "Enable the extended ccmath library that adds helpful additional methods that are not defined by the standard" ON)
 
 # include the global configuration file
 include(cmake/GlobalConfig.cmake)
@@ -31,6 +32,7 @@ if(CMAKE_CXX_COMPILER_ID STREQUAL Clang OR CMAKE_CXX_COMPILER_ID STREQUAL GNU)
   target_compile_options(${PROJECT_NAME}-compile-options INTERFACE
           -Wall -Wextra -Wpedantic -Wconversion -Werror=return-type
   )
+
   # TODO: Remove this later.
   #       Some variables have been provided but are not currently being used, but it would not atm make sense to remove them.
   #       So to clean up the warnings we are just silencing these specific cases.
@@ -52,6 +54,11 @@ add_library(${PROJECT_NAME}::${PROJECT_NAME} ALIAS ${PROJECT_NAME})
 
 target_sources(${PROJECT_NAME} INTERFACE "$<BUILD_INTERFACE:${ccmath_headers}>")
 
+if (CCMATH_ENABLE_EXTENSIONS)
+  include(ccmath_extensions_headers.cmake)
+  target_sources(${PROJECT_NAME} INTERFACE "$<BUILD_INTERFACE:${ccmath_extensions_headers}>")
+endif()
+
 target_include_directories(${PROJECT_NAME} INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/>)
 target_include_directories(${PROJECT_NAME} SYSTEM INTERFACE $<INSTALL_INTERFACE:$<INSTALL_PREFIX>/include>)
 
@@ -65,7 +72,7 @@ target_link_libraries(${PROJECT_NAME} INTERFACE
 configure_file(cmake/version.hpp.in "${CMAKE_CURRENT_BINARY_DIR}/include/${PROJECT_NAME}/version.hpp" @ONLY)
 
 if (CCMATH_BUILD_EXAMPLES OR CCMATH_BUILD_BENCHMARKS OR CCMATH_BUILD_TEST)
-  add_subdirectory(ext)
+  add_subdirectory(thirdparty)
 endif()
 
 if (CCMATH_BUILD_EXAMPLES)