Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ref): document mp_units.core #628

Draft
wants to merge 180 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 177 commits
Commits
Show all changes
180 commits
Select commit Hold shift + click to select a range
644b8d1
docs(ref): document `mp_units.core`
JohelEGP Oct 13, 2024
600a69b
docs(ref): document `mp_units.core`
JohelEGP Oct 13, 2024
e819430
docs(ref): document `mp_units.core`
JohelEGP Oct 13, 2024
9a9c343
docs(ref): document `mp_units.core`
JohelEGP Oct 13, 2024
543254a
docs(ref): document `mp_units.core`
JohelEGP Oct 13, 2024
d454ccc
docs(ref): document `mp_units.core`
JohelEGP Oct 13, 2024
60dd2cb
docs(ref): fill [qty.ref]
JohelEGP Oct 24, 2024
d9248b1
[mp.units.core.syn] Update pi's UCN
JohelEGP Oct 25, 2024
824f0c1
[qty.unit.types] Update `Magnitude * Unit`
JohelEGP Oct 25, 2024
8bce9c6
[qty.dim.types] Fix `derived_dimension` example
JohelEGP Oct 25, 2024
58487d6
[qty.spec.concepts] Update _`QuantityKindSpec`_
JohelEGP Oct 25, 2024
0cab71d
Merge branch 'master' into ref_docs
JohelEGP Oct 25, 2024
1f6be11
[mp.units.core.syn] Add \u03C0
JohelEGP Oct 26, 2024
17585ce
[qty.spec.types] Improve description of `kind_of`
JohelEGP Oct 26, 2024
9b35ad4
[qty.unit.types] Fix `named_unit` description of "kind" parameter
JohelEGP Oct 26, 2024
ae58e6c
[qty.unit.types] Improve `named_unit` example comment
JohelEGP Oct 26, 2024
14c0ee6
[qty.unit.types] Further improve `named_unit` example comments
JohelEGP Oct 26, 2024
f542ffb
[qty.unit.types] Mark `derived_unit` as `final`
JohelEGP Oct 26, 2024
24842ca
[qty] Avoid idiom in detailed specifications
JohelEGP Oct 26, 2024
ac09cec
[qty.ratio] Implement `common_ratio` in terms of `std::`
JohelEGP Oct 26, 2024
399dcd0
[qty.spec] Update for removal of _`DerivedQuantitySpecExpr`_
JohelEGP Oct 26, 2024
2f8c2b1
[qty.unit] Update for removal of _`DerivedUnitExpr`_
JohelEGP Oct 26, 2024
aa5aa63
[qty.mag] Update for removal of _`MagnitudeSpecExpr`_
JohelEGP Oct 26, 2024
9ecd87e
[qty.spec] Update for removal of _`QuantitySpecWithNoSpecifiers`_
JohelEGP Oct 26, 2024
49cb247
[qty.mag] Update for parameter renames
JohelEGP Oct 26, 2024
0248136
[qty.dim] Update for removal of _`DerivedDimensionExpr`_
JohelEGP Oct 26, 2024
04eab10
Merge branch 'master' into ref_docs
JohelEGP Oct 26, 2024
71bfcf8
[qty.ratio] Fix "Equivalent to:" formatting
JohelEGP Oct 26, 2024
b94ec34
[qty.spec.types] Improve the kind of quantity hierarchy function
JohelEGP Oct 26, 2024
1917e12
[qty.ref] Avoid adjacent `itemdecl` `codeblock` environments
JohelEGP Oct 26, 2024
2b23001
[qty.val.traits] Do not use `std::chrono::duration_values<Rep>::one()`
JohelEGP Oct 26, 2024
df90897
[mp.units.core.syn] Fix `derived_quantity_spec`'s template parameter
JohelEGP Oct 26, 2024
ca30d46
docs(ref): Fill [qty]
JohelEGP Oct 28, 2024
faf6d4b
[qty] Add `value_cast`
JohelEGP Oct 29, 2024
be4944a
Merge branch 'master' into ref_docs
JohelEGP Oct 29, 2024
0de0ba8
[qty.assign.ops] Add missing `std::remove_cvref_t`
JohelEGP Oct 29, 2024
fbd3369
[qty.common.type] Inline *`require-clause`*s
JohelEGP Oct 29, 2024
bdd715c
[qty.assign.ops] Update `@=`s
JohelEGP Oct 30, 2024
c4d49c2
[qty.compat.traits] Update to use concepts
JohelEGP Oct 30, 2024
c51bf1f
[qty.chrono] Update
JohelEGP Oct 30, 2024
0e93d30
[qty.compat.traits] Remove wrong `typename`
JohelEGP Oct 30, 2024
b28abe1
Merge branch 'master' into ref_docs
JohelEGP Oct 31, 2024
e781fa7
[qty.assign.ops] Update `@=`
JohelEGP Oct 31, 2024
ffbe386
[qty.assign.ops] Rename _RHS_ to `common_rhs`
JohelEGP Oct 31, 2024
1e7ae08
[qty.ratio] Reword to not depend on `std::chrono::duration` being a f…
JohelEGP Oct 31, 2024
f1d493e
[qty] Account for SG16 recommendation
JohelEGP Oct 31, 2024
5e9dac1
[qty.assign.ops] Restore `!Quantity` condition
JohelEGP Oct 31, 2024
e281f6c
[mp.units.core.syn] Update `per_mille`
JohelEGP Nov 1, 2024
8add724
[mp.units.core.syn] Put units of dimension one together
JohelEGP Nov 1, 2024
bd2fa77
[qty.syn] Remove optimized branch in _`integral-conversion-factor`_
JohelEGP Nov 1, 2024
a2bef08
docs(ref): Fill [qty.pt.orig]
JohelEGP Nov 2, 2024
3f73b37
docs(ref): Fill [qty.pt]
JohelEGP Nov 2, 2024
888fae4
[qty.pt.conv] Simplify presentation
JohelEGP Nov 2, 2024
0423cdf
[qty.pt.orig] Update `operator-`
JohelEGP Nov 2, 2024
591324b
[qty.val.cmp] Avoid `<=>` for equality case
JohelEGP Nov 2, 2024
a4502de
[qty.compat.traits] Update requirements
JohelEGP Nov 2, 2024
111f24a
Merge branch 'master' into ref_docs
JohelEGP Nov 2, 2024
80e3811
Merge branch 'master' into ref_docs
JohelEGP Nov 3, 2024
c8dd134
[qty] Update to `Mutable`
JohelEGP Nov 3, 2024
2003f0b
[qty.arith.ops] Use `is_neq_zero`
JohelEGP Nov 3, 2024
50b2b8e
[qty.pt.orig] Add missing _requires-clause_ specification
JohelEGP Nov 3, 2024
b7bdf07
[qty.assign.ops] Use item lists
JohelEGP Nov 3, 2024
ea17218
docs(ref): Fill [qty.pt.non.mem.conv]
JohelEGP Nov 3, 2024
27498ca
[qty.{,pt.}non.mem.conv] Add `quantity_cast`
JohelEGP Nov 3, 2024
0e6c675
[qty.pt.orig] Improve definition of origin
JohelEGP Nov 3, 2024
eff3799
[qty.spec.types] Fix level of abstraction to quantity character
JohelEGP Nov 3, 2024
9e8343e
[qty.fp.traits] Update initializer
JohelEGP Nov 3, 2024
7a98c1b
[qty.spec.types] Remove _`quantity-spec-interface-base`_
JohelEGP Nov 3, 2024
f075c84
[qty] Make IFNDR some program instantiations
JohelEGP Nov 3, 2024
39dda27
[qty.spec.types] Fix constraints of `quantity_spec`
JohelEGP Nov 3, 2024
7b2ada4
[qty] Improve `is-{,derived-from-}specialization-of`
JohelEGP Nov 3, 2024
9b539f7
[qty] Rename to _`TagType`_
JohelEGP Nov 3, 2024
f22c0aa
[qty] Avoid easy uses of `^` for reflection
JohelEGP Nov 3, 2024
bc2a8f6
[qty.expr.temp.algo] Avoid uses of `^` for reflection
JohelEGP Nov 3, 2024
937d7ef
[qty.unit.types] Avoid uses of `^` for reflection
JohelEGP Nov 3, 2024
4683064
[qty.spec.types] Avoid uses of reflection
JohelEGP Nov 3, 2024
014dec9
[qty] Reword introductions
JohelEGP Nov 3, 2024
6dd5453
[qty.{spec,unit}.types] Avoid equation terms
JohelEGP Nov 3, 2024
be47b8c
[qty.spec.types] Move _`to-dimension`_ next to its use
JohelEGP Nov 4, 2024
b7b7872
[qty.expr.temp.algo] Document algorithms other than _`expr-map`_
JohelEGP Nov 4, 2024
2c2377e
[qty.{,pt.}.syn] Remove wording about aggregates/destructuring
JohelEGP Nov 4, 2024
6539b40
[qty.expr.temp.algo] Document the use of `Pred`
JohelEGP Nov 4, 2024
d7f27c4
[qty.expr.temp.algo] Clarify arity and sources of inputs to operations
JohelEGP Nov 4, 2024
7acbae7
[qty.expr.temp.algo] Clarify how template argument lists are formed
JohelEGP Nov 4, 2024
932796e
[qty.expr.temp.algo] Fix a result of 1
JohelEGP Nov 4, 2024
1da0161
[qty.expr.temp.algo] Avoid possible ambiguity of "constant"
JohelEGP Nov 4, 2024
9b6dac8
[qty.expr.temp.algo] Replace "constant" with "symbol"
JohelEGP Nov 4, 2024
36b8c0e
[qty.expr.temp.algo] Clarify when 1 can be present
JohelEGP Nov 4, 2024
096c699
[qty.expr.temp.algo] Replace "symbol" with "symbolic constant"
JohelEGP Nov 4, 2024
20a6081
[qty.expr.temp.algo] Detail first step example
JohelEGP Nov 4, 2024
c2e4cfc
[qty.expr.temp.algo] Clarify position of `per`
JohelEGP Nov 4, 2024
8d7bd67
Merge branch 'master' into ref_docs
JohelEGP Nov 6, 2024
746beb0
[qty.helpers.non.types] Update `SymbolicConstant`
JohelEGP Nov 6, 2024
aff1be9
[qty] Fix formatting of spaces before `&&`/`*`
JohelEGP Nov 6, 2024
04d3a69
[qty.expr.temp.algo] Improve requirements on `Pred` and _`type-less`_
JohelEGP Nov 6, 2024
d69e852
[qty.expr.temp.algo] Reword first step to avoid variables
JohelEGP Nov 6, 2024
976786f
[qty.expr.temp.algo] Fix constant font style
JohelEGP Nov 6, 2024
05121e8
[qty.expr.temp.algo] Better exemplify simplification
JohelEGP Nov 6, 2024
95ab773
[qty.expr.temp.algo] Use conventional constant letters
JohelEGP Nov 7, 2024
ed702c3
[qty.expr.temp.algo] Clarify variable of the operation's result
JohelEGP Nov 7, 2024
3540bdc
[qty.expr.temp.general] Extend example with kilogram
JohelEGP Nov 7, 2024
271231b
[qty.expr.temp.algo] Use a more precise article
JohelEGP Nov 7, 2024
09035d6
[qty.expr.temp.algo] Avoid terms out of the numerator
JohelEGP Nov 7, 2024
a03ff3d
[qty.expr.temp.algo] Use full term symbolic constant
JohelEGP Nov 7, 2024
86839a2
[qty.unit.types] Add missing _`get-associated-quantity`_ placeholder
JohelEGP Nov 7, 2024
f7fd8bb
[qty.dim.types] Mark `base_dimension::symbol` `\expos`
JohelEGP Nov 8, 2024
cf3cb37
[qty] Mark `quantity_spec` members `\expos`
JohelEGP Nov 8, 2024
aad49c3
[qty.unit.types] Mark `scaled_unit::reference_unit` `\expos`
JohelEGP Nov 8, 2024
d904dd4
[qty.pt.orig] Mark `relative_point_origin::quantity_point` `\expos`
JohelEGP Nov 8, 2024
1c15f0c
[qty.pt.orig] Mark `relative_point_origin::absolute_point_origin` `\e…
JohelEGP Nov 8, 2024
96e8429
[qty.unit.types] Mark `named_unit::point_origin` `\expos`
JohelEGP Nov 8, 2024
7fa80ac
[qty.unit.types] Mark `scaled_unit::mag` `\expos`
JohelEGP Nov 8, 2024
6a4f957
[qty.unit.types] Mark `symbol` of `named_unit` and `prefixed_unit` `\…
JohelEGP Nov 8, 2024
6824068
[qty.unit.types] Mark `scaled_unit::point_origin` `\expos`
JohelEGP Nov 8, 2024
a2f1b31
Merge branch 'master' into ref_docs
JohelEGP Nov 8, 2024
315d4e1
[qty.char.traits] Retitle subclause to "Quantity character"
JohelEGP Nov 8, 2024
a39acbb
docs(ref): Fill [qty.fixed.string]
JohelEGP Nov 8, 2024
d75d845
docs(ref): Fill [qty.sym.txt]
JohelEGP Nov 9, 2024
3a66fed
Merge branch 'master' into ref_docs
JohelEGP Nov 10, 2024
47a4f2e
[qty.unit.types] Reword canonical unit specification
JohelEGP Nov 10, 2024
5893f62
docs(ref): Use P3094R5
JohelEGP Nov 10, 2024
8406086
[qty] Make `symbol_text` non-`\expos`
JohelEGP Nov 10, 2024
2e600c0
[qty.sym.txt] Index members
JohelEGP Nov 10, 2024
fdd59bc
[qty.sym.txt] Order members conventionally
JohelEGP Nov 10, 2024
4303674
[qty.spec.types] Fix presentation of `is_kind`
JohelEGP Nov 10, 2024
3a770b3
[mp.units.core.syn] Move `quantity_character` under [qty.rep]
JohelEGP Nov 10, 2024
feee47d
[qty.mag.types] Specify _`is-positive-integral-power`_
JohelEGP Nov 11, 2024
6de3c59
[qty.expr.temp.algo] Specify _`expr-map`_
JohelEGP Nov 12, 2024
4eb663f
[qty] Fix indexing of `covertible(Unit)`
JohelEGP Nov 12, 2024
79d26fe
[qty.unit.types] Specify _`get-common-scaled-unit`_
JohelEGP Nov 12, 2024
fc7a3b6
[qty.unit.types] Fix indexing of `covertible(Unit)`
JohelEGP Nov 12, 2024
f50b228
[qty.mag.types] Specify _`get-base-value`_
JohelEGP Nov 12, 2024
8c29b93
[qty.mag.types] Specify implementation-defined limits
JohelEGP Nov 12, 2024
45691c6
[qty.mag.types] Specify _`common-magnitude`_
JohelEGP Nov 12, 2024
a7b2ea1
[qty.unit.types] Specify `get_quantity_spec(AssociatedUnit)`
JohelEGP Nov 12, 2024
cd78849
[qty.unit.types] Specify _`get-associated-quantity`_
JohelEGP Nov 12, 2024
4bc5c10
Merge branch 'master' into ref_docs
JohelEGP Nov 13, 2024
9829c96
[mp.units.core.syn] Update `is_complex`
JohelEGP Nov 13, 2024
d00d65b
docs(ref): Update [qty{,.expr.temp}]
JohelEGP Nov 13, 2024
6d64c98
[qty.expr.temp.types] Specify the constraints of `power`
JohelEGP Nov 13, 2024
57bb450
[qty.expr.temp.algo] Allow $r = 1$
JohelEGP Nov 13, 2024
30600d2
[qty.expr.temp.algo] Avoid clash of term and concept
JohelEGP Nov 13, 2024
733568c
[qty] Replace `std::remove_X_t<decltype` with `decltype(auto`
JohelEGP Nov 13, 2024
8ad43f7
[qty] Remove _`SymbolicArg`_
JohelEGP Nov 13, 2024
8b341e2
[qty.expr.type.concepts] Describe _`SymbolicConstant`_ precisely
JohelEGP Nov 13, 2024
4dda428
[qty.unit.types] Add IEV reference to use of "base units"
JohelEGP Nov 13, 2024
0e0b5c8
[qty.spec.types] Update _`make-reference`_
JohelEGP Nov 14, 2024
c5538dd
[qty] Update representation concepts
JohelEGP Nov 14, 2024
15c5e4d
[qty.rep.concepts] Fix number
JohelEGP Nov 15, 2024
9ed0455
Merge branch 'master' into ref_docs
JohelEGP Nov 24, 2024
d17991d
[qty] Update `dimension_symbol` and `unit_symbol`
JohelEGP Nov 24, 2024
cd857ae
[qty.expr.temp.concepts] Update _`SymbolicConstant`_
JohelEGP Nov 24, 2024
75cfc93
[qty.unit.types] Update `equivalent`
JohelEGP Nov 24, 2024
f97c057
[qty.ref][qty] Update `operator/`
JohelEGP Nov 24, 2024
6cd95f6
[qties] Update `character_set`
JohelEGP Nov 24, 2024
59913be
[qties] Update `UnitMagnitude`/`unit_magnitude`
JohelEGP Nov 24, 2024
aa7a18d
[qties] Update to remove _`SameQuantitySpec`_
JohelEGP Nov 24, 2024
d14abc4
[qty.spec] Update _`QSProperty`_
JohelEGP Nov 24, 2024
3b04b7e
[qty.rep] Update representation concepts with CPOs
JohelEGP Nov 24, 2024
a8daee3
[qty.cmp][qty.pt.cmp] Use `_with` concepts as appropriate
JohelEGP Nov 24, 2024
ae96518
Merge branch 'master' into ref_docs
JohelEGP Nov 24, 2024
4e8fdab
[qty.unit.types] Specify the point origin argument
JohelEGP Nov 24, 2024
2f4f4f2
ref(docs): document `delta` and `point`
JohelEGP Nov 24, 2024
93b8607
docs(ref): Review [qty.helpers.non.types]
JohelEGP Nov 25, 2024
6544b9f
[qty.compat.traits] Reword to avoid "quantity type"
JohelEGP Nov 25, 2024
9c3526b
docs(ref): Review [qty.ratio]
JohelEGP Nov 25, 2024
6eff5ed
[qties] Remove `explicit(false)`
JohelEGP Nov 25, 2024
4012e2e
docs(ref): Review [qty.sym.txt]
JohelEGP Nov 25, 2024
f5f4a75
[qties] Order arguments of `\indexlibrarymember` conventionally
JohelEGP Nov 25, 2024
45f183b
docs(ref): Review [qty.expr.temp]
JohelEGP Nov 25, 2024
83cf005
[qty.expr.temp.algo] Simplify _`expr-fractions`_
JohelEGP Nov 25, 2024
1204fbd
[qty.expr.temp.algo] Improve requirements on `Pred`
JohelEGP Nov 25, 2024
04f7c18
[qty.expr.temp.algo] Add missing *elaborated-type-specifier*s
JohelEGP Nov 25, 2024
09b3fca
[qty.expr.temp.algo] Move description before declaration
JohelEGP Nov 25, 2024
b089dae
[qty.expr.temp.algo] Update constraints of _`expr-map`_
JohelEGP Nov 25, 2024
7195c84
[qty.expr.temp.algo] Use "is of the form"
JohelEGP Nov 25, 2024
e54a860
[qty.expr.temp] Add missing index entries
JohelEGP Nov 25, 2024
8f91cd3
[qties] Use indexlibraryglobalexpos
JohelEGP Nov 25, 2024
9ada586
docs(ref): review [qty.dim]
JohelEGP Nov 25, 2024
b77f2bc
[qty.expr.temp.algo] Remark error condition
JohelEGP Nov 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api_reference/src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jegp_add_standardese_sources(
# Latex commands.
[[\\href{([^}]+)}{([^}]+)};HREF(\1)(\2)]]
# Macros extensions.
[[\\txtrm;\\textrm]]
[[\\refcpp{([^}]+)};REFCPP(\1)]]
[[\\irefcpp{([^}]+)};~(REFCPP(\1))]]
[[\\refcppx{([^}]+)}{([^}]+)};REFCPPX(\1)(\2)]]
Expand Down
5 changes: 5 additions & 0 deletions docs/api_reference/src/intro.tex
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@
Available from: \url{https://wg21.link/\IsoCpp{}}
\item
The \Cpp{} Standards Committee.
P3094R5: \doccite{\tcode{std::basic_fixed_string}}.
Edited by Mateusz Pusz.
Available from: \url{https://wg21.link/P3094R5}
\item
The \Cpp{} Standards Committee.
SD-8: \doccite{Standard Library Compatibility}.
Edited by Bryce Lelbach.
Available from: \url{https://wg21.link/SD8}
Expand Down
22 changes: 21 additions & 1 deletion docs/api_reference/src/macros_extensions.tex
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
\newcommand{\IsoCpp}{N4971}

\newcommand{\txtrm}[1]{\textnormal{\textrm{#1}}}

\newcommand{\stdconcept}[1]{#1}

\newcommand{\indexlibraryglobalexpos}[1]{\indexlibrary{#1@\exposid{#1}}}
\newcommand{\indexlibraryctorexpos}[1]{\indexlibrarymisc{#1@\exposid{#1}}{constructor}}

\newcommand{\liboverload}[2]{\indexlibraryglobal{#1(#2)}#1}

%% Inline non-parenthesized C++ reference
\newcommand{\refcpp}[1]{\href{https://wg21.link/#1}{\IsoCpp{}, [#1]}}
\newcommand{\irefcpp}[1]{\nolinebreak[3] (\refcpp{#1})}
Expand All @@ -8,4 +17,15 @@

%% Inline IEV reference
\newcommand{\refiev}[1]{\href{https://www.electropedia.org/iev/iev.nsf/display?openform&ievref=#1}{IEC 60050, #1}}
\newcommand{\irefiev}[1]{\nolinebreak[3] (\refiev{#1})}
\ExplSyntaxOn
\NewDocumentCommand \irefiev { m } {
\clist_set:Nx \l_tmpa_clist { #1 }
\nolinebreak[3] ~ (
\clist_map_inline:Nn \l_tmpa_clist {
\clist_put_right:Nn \g_tmpa_clist { \refiev{##1} }
}
\clist_use:Nn \g_tmpa_clist { ,~ }
)
\clist_clear:N \g_tmpa_clist
}
\ExplSyntaxOff
Loading