summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorClaudius 'keldu' Holeksa <mail@keldu.de>2024-07-29 14:18:30 +0200
committerClaudius 'keldu' Holeksa <mail@keldu.de>2024-07-29 14:18:30 +0200
commit700cde2d499742160deb361f42b7e861ae1db8ed (patch)
treeba796243a94578f9c2105080fa19040a341c4482 /examples
parentfb7dd1c9185da30aed8645c084be0722e061a867 (diff)
Renaming to new standard
Diffstat (limited to 'examples')
-rw-r--r--examples/basic.cpp55
1 files changed, 55 insertions, 0 deletions
diff --git a/examples/basic.cpp b/examples/basic.cpp
new file mode 100644
index 0000000..d322ac7
--- /dev/null
+++ b/examples/basic.cpp
@@ -0,0 +1,55 @@
+#include "../c++/kelunit/distance/meter.hpp"
+#include "../c++/kelunit/time/second.hpp"
+
+#include "../c++/kelunit/unit_print.hpp"
+
+#include <iostream>
+
+int main(){
+ /**
+ * The definition is a bit convoluted, so I leave it in the hands of the headers themselves and define a convenience alias for the user.
+ * meter e.g. is defined by
+ *
+ * namespace unit_type {
+ * struct meter {};
+ * }
+ * template<typename S>
+ * using meter = unit<S, unit_base<unit_type::meter, 1>>;
+ *
+ * which then can be used as follows
+ */
+ using scalar = kel::scalar<float>;
+ using meter = kel::meter<float>;
+ using square_meter = kel::square_meter<float>;
+ using second = kel::second<float>;
+
+ meter a = 6.f;
+
+ meter b = 3.f;
+
+ second s = 10.f;
+
+ // Since it is not compileable I cannot show it, but c + s would throw a compilation error.
+ meter c = a+b;
+ meter d = a-b;
+
+ // Auto deduced type. Based on the template parameters automatically stitches together a valid unit
+ auto mps = b / s;
+
+ // Technically auto deduced, but predefined for convenience.
+ square_meter e = a*b;
+ //
+ scalar f = a/b;
+
+ std::cout<<"Values:\n";
+ std::cout<<"a: "<<a<<"\n";
+ std::cout<<"b: "<<b<<"\n";
+ std::cout<<"c: "<<c<<"\n";
+ std::cout<<"d: "<<d<<"\n";
+ std::cout<<"e: "<<e<<"\n";
+ std::cout<<"f: "<<f<<"\n";
+ std::cout<<"mps: "<<mps<<"\n";
+ std::cout<<std::endl;
+
+ return 0;
+}