docs: Documentation now prefers refrences over UDLs

This commit is contained in:
Mateusz Pusz committed 2021-04-02 13:11:20 +02:00
1 parent 7cc34646b9
commit c4e9ff7f66
12 files changed
+211 -175

No files matched your search

+6 -6
View File
@@ -27,9 +27,9 @@ The official :term:`quantity` definition states:
So the most common use case would be to create a vector or matrix of quantities::
fs_vector<si::length<si::metre>, 3> v = { 1_q_m, 2_q_m, 3_q_m };
fs_vector<si::length<si::metre>, 3> u = { 3_q_m, 2_q_m, 1_q_m };
fs_vector<si::length<si::kilometre>, 3> t = { 3_q_km, 2_q_km, 1_q_km };
fs_vector<si::length<si::metre>, 3> v = { 1 * m, 2 * m, 3 * m };
fs_vector<si::length<si::metre>, 3> u = { 3 * m, 2 * m, 1 * m };
fs_vector<si::length<si::kilometre>, 3> t = { 3 * km, 2 * km, 1 * km };
Having such definitions we can perform full dimensional analysis operations for the operations
allowed by the Linear Algebra rules. For example::
@@ -38,7 +38,7 @@ allowed by the Linear Algebra rules. For example::
std::cout << "v + t = " << v + t << "\n";
std::cout << "t[m] = " << fs_vector<si::length<si::metre>, 3>(t) << "\n";
std::cout << "v * u = " << v * u << "\n";
std::cout << "2_q_m * v = " << 2_q_m * v << "\n";
std::cout << "2 * m * v = " << 2 * m * v << "\n";
The above code works as expected and produces the following output:
@@ -48,7 +48,7 @@ The above code works as expected and produces the following output:
v + t = | 3001 m 2002 m 1003 m |
t[m] = | 3000 m 2000 m 1000 m |
v * u = 10 m²
2_q_m * v = | 2 m² 4 m² 6 m² |
2 * m * v = | 2 m² 4 m² 6 m² |
Quantities of Linear Algebra Types
@@ -79,7 +79,7 @@ output:
v + t = | 3001 2002 1003 | m
t[m] = | 3000 2000 1000 | m
v * u = 10 m²
2_q_m * v = | 2 4 6 | m²
2 * m * v = | 2 4 6 | m²
.. seealso::