mpusz · JohelEGP · Sep 19, 2023 · Sep 21, 2023 · Sep 23, 2023 · Sep 23, 2023
diff --git a/.cmake-format.yaml b/.cmake-format.yaml
@@ -1,3 +1,4 @@
+include: ["cmake/.cmake-format-additional_commands-jegp.cmake_modules.yaml"]
 parse:
  additional_commands:
  add_documentation:

diff --git a/cmake/.cmake-format-additional_commands-jegp.cmake_modules.yaml b/cmake/.cmake-format-additional_commands-jegp.cmake_modules.yaml
@@ -0,0 +1,61 @@
+parse:
+ additional_commands:
+ _jegp_common_yaml_anchors:
+ kwargs:
+ PUBLIC_INTERFACE_PRIVATE: &public_interface_private
+ kwargs:
+ PUBLIC: +
+ INTERFACE: +
+ PRIVATE: +
+ jegp_add_standardese_sources:
+ pargs:
+ nargs: 1
+ flags:
+ - EXCLUDE_PDF_FROM_MAIN
+ - EXCLUDE_HTML_FROM_MAIN
+ - EXCLUDE_FROM_ALL
+ kwargs:
+ LIBRARIES: +
+ APPENDICES: +
+ EXTENSIONS: +
+ CHECKED: 1
+ PDF_PATH: 1
+ HTML_PATH: 1
+ jegp_add_module:
+ pargs: &jegp_add_module_pargs
+ nargs: 1
+ flags:
+ - IMPORTABLE_HEADER
+ kwargs:
+ SOURCES: +
+ COMPILE_OPTIONS: *public_interface_private
+ LINK_LIBRARIES: *public_interface_private
+ jegp_cpp_module:
+ pargs: *jegp_add_module_pargs
+ jegp_target_link_header_units:
+ pargs:
+ nargs: 1+
+ jegp_add_headers_test:
+ pargs:
+ nargs: 1+
+ kwargs:
+ PRIVATE_REGEXES: +
+ jegp_add_test:
+ pargs:
+ nargs: 1+
+ flags:
+ - COMPILE_ONLY
+ kwargs:
+ TYPE: 1
+ SOURCES: +
+ COMPILE_OPTIONS: +
+ LINK_LIBRARIES: +
+ jegp_add_build_error:
+ pargs:
+ nargs: 1+
+ kwargs:
+ AS: 1
+ TYPE: 1
+ SOURCE: 1
+ COMPILE_OPTIONS: +
+ LINK_LIBRARIES: +
diff --git a/docs/reference/CMakeLists.txt b/docs/reference/CMakeLists.txt
@@ -0,0 +1,21 @@
+cmake_minimum_required(VERSION 3.25.0)
+project(mp_units_reference_documentations LANGUAGES NONE)
+
+include(JEGPAddStandardeseSources)
+
+set(pdf_title "Mp-units Library")
+set(page_license "MIT License")
+set(first_library_chapter "nums")
+set(last_library_chapter "qties")
+# set(pdf_creator "Johel Ernesto Guerrero Pe\\~{n}a")
+# set(document_number [[\unspec]])
+# set(previous_document_number [[\unspec]])
+set(cover_title "Mp-units Library Reference Documentations")
+set(reply_to "\\href{${PROJECT_HOMEPAGE_URL}/discussions}{Discussions}, \\href{${PROJECT_HOMEPAGE_URL}/issues}{issues}")
+jegp_add_standardese_sources(
+ mp_units_reference_documentations
+ LIBRARIES intro numbers;quantities
+ EXTENSIONS macros_extensions
+ # CHECKED TRUE
+ PDF_PATH "mp_units.pdf"
+)
diff --git a/docs/reference/codeblock/.clang-format b/docs/reference/codeblock/.clang-format
@@ -0,0 +1,2 @@
+BasedOnStyle: InheritParentConfig
+ColumnLimit: 97
diff --git a/docs/reference/intro.tex b/docs/reference/intro.tex
@@ -0,0 +1,160 @@
+%!TEX root = std.tex
+
+
+\rSec0[scope]{Scope}
+
+\pnum
+\indextext{scope|(}%
+This document describes the contents of the \defn{mp-units library}.
+\indextext{scope|)}
+
+
+\rSec0[refs]{References}
+
+\pnum
+\indextext{references|(}%
+The following documents are referred to in the text
+in such a way that some or all of their content
+constitutes requirements of this document.
+For dated references, only the edition cited applies.
+For undated references,
+the latest edition of the referenced document
+(including any amendments) applies.
+\begin{itemize}
+\item
+The \Cpp{} Standards Committee.
+N4892: \doccite{Working Draft, Standard for Programming Language \Cpp{}}.
+Edited by Thomas K\"{o}ppe.
+Available from: \url{https://wg21.link/N4892}
+\item
+The \Cpp{} Standards Committee.
+P1841R1: \doccite{Wording for Individually Specializable Numeric Traits}.
+Edited by Walter E. Brown.
+Available from: \url{https://wg21.link/P1841R1}
+\item
+The \Cpp{} Standards Committee.
+SD-8: \doccite{Standard Library Compatibility}.
+Edited by Bryce Lelbach.
+Available from: \url{https://wg21.link/SD8}
+\item
+ISO 80000-2:2019, \doccite{Quantities and units --- Part 2: Mathematics}
+\item
+IEC 60050 (all parts),
+\doccite{International Electrotechnical Vocabulary (IEV)}
+\item
+IEC 60050-102:2007/AMD3:2021,
+\doccite{Amendment 3 --- International Electrotechnical Vocabulary (IEV) ---
+Part 102: Mathematics --- General concepts and linear algebra}
+\item
+IEC 60050-112:2010/AMD2:2020,
+\doccite{Amendment 2 --- International Electrotechnical Vocabulary (IEV) ---
+Part 112: Quantities and units}
+\end{itemize}
+
+\pnum
+N4892 is hereinafter called \defn{\Cpp{}}.
+
+\pnum
+IEC 60050 is hereinafter called \defn{IEV}.
+\indextext{references|)}
+
+
+\rSec0[defs]{Terms and definitions}
+
+\pnum
+\indextext{definitions|(}%
+For the purposes of this document,
+the terms and definitions given in
+\Cpp{},
+IEC 60050-102:2007/AMD3:2021,
+IEC 60050-112:2010/AMD2:2020,
+the terms, definitions, and symbols given in
+ISO 80000-2:2019,
+and the following apply.
+
+\pnum
+ISO and IEC maintain terminology databases
+for use in standardization
+at the following addresses:
+\begin{itemize}
+\item ISO Online browsing platform: available at \url{https://www.iso.org/obp}
+\item IEC Electropedia: available at \url{http://www.electropedia.org}
+\end{itemize}
+
+\pnum
+Terms that are used only in a small portion of this document
+are defined where they are used and italicized where they are defined.
+
+\indexdefn{modulo}%
+\definition{modulo}{def.mod}
+operation performed on a set for which a division\irefiev{102-01-21} and an addition are defined,
+the result of which, for elements $a$ and $b$ of the set,
+is the unique element $r$, if it exists in the set,
+such that $a = \lfloor a/b \rfloor b + r$
+
+
+\rSec0[spec]{Specification}
+
+\rSec1[spec.ext]{External}
+
+\pnum
+The specification of the mp-units library subsumes
+\refcpp{description}, \refcpp{requirements}, \refcpp{concepts.equality}, and SD-8,
+all assumingly amended for the context of this library.
+\begin{note}
+This means that, non exhaustively,
+\begin{itemize}
+\item \tcode{::mp_units2} is a reserved namespace, and
+\item
+\tcode{std::vector<mp_units::\placeholdernc{type}>}
+is a program-defined specialization and a library-defined specialization
+from the point of view of \Cpp{} and this library, respectively.
+\end{itemize}
+\end{note}
+
+\pnum
+The mp-units library is not part of the \Cpp{} implementation.
+
+\rSec1[spec.cats]{Categories}
+
+\pnum
+Detailed specifications for each of the components in the library are in
+\ref{\firstlibchapter}--\ref{\lastlibchapter},
+as shown in \tref{lib.cats}.
+
+\begin{floattable}{Library categories}{lib.cats}
+{ll}
+\topline
+\hdstyle{Clause} & \hdstyle{Category} \\ \capsep
+\ref{nums} & Numbers library \\
+\ref{qties} & Quantities library \\
+\end{floattable}
+
+\pnum
+The numbers library\iref{nums}
+describes components for dealing with numbers.
+
+\pnum
+The quantities library\iref{qties}
+describes components for dealing with quantities.
+
+\rSec1[headers]{Headers}
+
+\pnum
+The mp-units library provides the
+\defnx{mp-units library headers}{header!mp-units library},
+shown in \tref{headers.mp.units}.
+
+\begin{multicolfloattable}{mp-units library headers}{headers.mp.units}
+{l}
+\tcode{<mp_units/numbers.h>} \\
+\tcode{<mp_units/quantity.h>} \\
+\end{multicolfloattable}
+
+\rSec1[spec.reqs]{Library-wide requirements}
+
+\rSec2[spec.res.names]{Reserved names}
+
+\pnum
+The mp-units library reserves macro names that start with
+\tcode{MP_UNITS\opt{\gterm{digit-sequence}}_}.
diff --git a/docs/reference/itemdecl/.clang-format b/docs/reference/itemdecl/.clang-format
@@ -0,0 +1,2 @@
+BasedOnStyle: InheritParentConfig
+ColumnLimit: 99
diff --git a/docs/reference/macros_extensions.tex b/docs/reference/macros_extensions.tex
@@ -0,0 +1,20 @@
+% \newcommand{\idxmdl}[1]{#1@\CodeStylex{#1}}
+\newcommand{\idxexposid}[1]{#1@\ExposStylex{#1}}
+
+\newcommand{\indexlibraryspec}[2]{\indexlibrarymisc{#1}{\idxcode{#2}}}
+
+\newcommand{\ExposStylex}[1]{\CodeStylex{\textit{#1}}}
+
+\newnoteenvironment{source}{Source}{end source}
+
+\newcommand{\dvalue}{\Fundesc{Default value}}
+
+%% Inline non-parenthesized C++ reference
+\newcommand{\refcpp}[1]{\href{https://wg21.link/#1}{\Cpp{} [#1]}}
+\newcommand{\irefcpp}[1]{\nolinebreak[3] (\refcpp{#1})}
+\newcommand{\refcppx}[2]{\href{https://wg21.link/#1\##2}{\Cpp{} [#1]}}
+\newcommand{\irefcppx}[2]{\nolinebreak[3] (\refcppx{#1}{#2})}
+
+%% Inline IEV reference
+\newcommand{\refiev}[1]{\href{https://www.electropedia.org/iev/iev.nsf/display?openform&ievref=#1}{IEV #1}}
+\newcommand{\irefiev}[1]{\nolinebreak[3] (\refiev{#1})}