ndarray-unit 0.2.2

A package providing a system of units to the ndarray type
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ndarray_unit` crate."><meta name="keywords" content="rust, rustlang, rust-lang, ndarray_unit"><title>ndarray_unit - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../ndarray_unit/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate ndarray_unit</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all ndarray_unit's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'ndarray_unit', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/ndarray_unit/lib.rs.html#1-253' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>ndarray_unit</a></span></h1><div class='docblock'><p>This crate provides a struct representing a <a href="https://docs.rs/ndarray/">multidimensionnal array</a> together with a <code>Unit</code>.<br />
It allows to do computations taking into account the unit of your n-dimensional array.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">ndarray_unit</span>::<span class="kw-2">*</span>;

<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ndarray</span>;
<span class="kw">use</span> <span class="ident">ndarray</span>::<span class="ident">Array</span>;

<span class="kw">fn</span> <span class="ident">main</span>() {
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;meter / second = {}&quot;</span>, <span class="kw-2">&amp;</span><span class="ident">get_meter</span>() <span class="op">/</span> <span class="kw-2">&amp;</span><span class="ident">get_second</span>());

    <span class="kw">let</span> <span class="ident">arr1</span> <span class="op">=</span> <span class="ident">Array</span>::<span class="ident">linspace</span>(<span class="number">30.0</span>, <span class="number">40.0</span>, <span class="number">11</span>);
    <span class="kw">let</span> <span class="ident">arr_u1</span> <span class="op">=</span> <span class="ident">ArrayUnit</span>::<span class="ident">new</span>(<span class="ident">arr1</span>, <span class="ident">get_joule</span>());

    <span class="kw">let</span> <span class="ident">arr2</span> <span class="op">=</span> <span class="ident">Array</span>::<span class="ident">linspace</span>(<span class="number">10.0</span>, <span class="number">60.0</span>, <span class="number">11</span>);
    <span class="kw">let</span> <span class="ident">arr_u2</span> <span class="op">=</span> <span class="ident">ArrayUnit</span>::<span class="ident">new</span>(<span class="ident">arr2</span>, <span class="ident">get_second</span>());

    <span class="kw">let</span> <span class="ident">arr3</span> <span class="op">=</span> <span class="ident">ndarray</span>::<span class="macro">array</span><span class="macro">!</span>[
        [<span class="number">1.0</span>, <span class="number">0.0</span>, <span class="number">2.0</span>, <span class="number">6.0</span>],
        [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>, <span class="number">5.0</span>],
        [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>, <span class="number">6.0</span>]
    ];
    <span class="kw">let</span> <span class="ident">arr_u3</span> <span class="op">=</span> <span class="ident">ArrayUnit</span>::<span class="ident">new</span>(<span class="ident">arr3</span>, <span class="ident">get_meter</span>());

    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;arr_u3 = {}&quot;</span>, <span class="ident">arr_u3</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;==========================================================&quot;</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}\n*{}\n={}&quot;</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u1</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u2</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u1</span> <span class="op">*</span> <span class="kw-2">&amp;</span><span class="ident">arr_u2</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;==========================================================&quot;</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}\n/{}\n={}&quot;</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u1</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u2</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u1</span> <span class="op">/</span> <span class="kw-2">&amp;</span><span class="ident">arr_u2</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;==========================================================&quot;</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}\n+{}\n={}&quot;</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u1</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u1</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u1</span> <span class="op">+</span> <span class="kw-2">&amp;</span><span class="ident">arr_u1</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;==========================================================&quot;</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}\n-{}\n={}&quot;</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u2</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u2</span>, <span class="kw-2">&amp;</span><span class="ident">arr_u2</span> <span class="op">-</span> <span class="kw-2">&amp;</span><span class="ident">arr_u2</span>);
    <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;==========================================================&quot;</span>);
}</pre></div>
<p><strong>Output</strong></p>

<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="comment">// meter / second = m·s⁻¹</span>
<span class="comment">// arr_u3 = [[1, 0, 2, 6],</span>
<span class="comment">//  [1, 2, 3, 5],</span>
<span class="comment">//  [1, 2, 3, 6]] m</span>
<span class="comment">// ==========================================================</span>
<span class="comment">// [30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40] m²·kg·s⁻²</span>
<span class="comment">// *[10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60] s</span>
<span class="comment">// =[300, 465, 640, 825, 1020, 1225, 1440, 1665, 1900, 2145, 2400] m²·kg·s⁻¹</span>
<span class="comment">// ==========================================================</span>
<span class="comment">// [30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40] m²·kg·s⁻²</span>
<span class="comment">// /[10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60] s</span>
<span class="comment">// =[3, 2.0666, 1.6, 1.32, 1.1333, 1, 0.9, 0.8222, 0.76, 0.7090, 0.6666] m²·kg·s⁻³</span>
<span class="comment">// ==========================================================</span>
<span class="comment">// [30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40] m²·kg·s⁻²</span>
<span class="comment">// +[30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40] m²·kg·s⁻²</span>
<span class="comment">// =[60, 62, 64, 66, 68, 70, 72, 74, 76, 78, 80] m²·kg·s⁻²</span>
<span class="comment">// ==========================================================</span>
<span class="comment">// [10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60] s</span>
<span class="comment">// -[10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60] s</span>
<span class="comment">// =[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] s</span>
<span class="comment">// ==========================================================</span></pre></div>
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
<p>The program will panic when you try to add or substract two <code>ArrayUnit</code>s with different <code>Unit</code>s.</p>

<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ndarray</span>;
<span class="kw">use</span> <span class="ident">ndarray</span>::<span class="ident">Array</span>;
<span class="kw">use</span> <span class="ident">ndarray_unit</span>::<span class="kw-2">*</span>;

<span class="kw">let</span> <span class="ident">arr1</span> <span class="op">=</span> <span class="ident">Array</span>::<span class="ident">linspace</span>(<span class="number">30.0</span>, <span class="number">40.0</span>, <span class="number">11</span>);
<span class="kw">let</span> <span class="ident">arr_u1</span> <span class="op">=</span> <span class="ident">ArrayUnit</span>::<span class="ident">new</span>(<span class="ident">arr1</span>, <span class="ident">get_joule</span>());

<span class="kw">let</span> <span class="ident">arr2</span> <span class="op">=</span> <span class="ident">Array</span>::<span class="ident">linspace</span>(<span class="number">10.0</span>, <span class="number">60.0</span>, <span class="number">11</span>);
<span class="kw">let</span> <span class="ident">arr_u2</span> <span class="op">=</span> <span class="ident">ArrayUnit</span>::<span class="ident">new</span>(<span class="ident">arr2</span>, <span class="ident">get_second</span>());

<span class="comment">// let result = &amp;arr_u1 + &amp;arr_u2; // ==&gt; panicking</span></pre></div>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.ArrayUnit.html" title='ndarray_unit::ArrayUnit struct'>ArrayUnit</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Unit.html" title='ndarray_unit::Unit struct'>Unit</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.BaseUnit.html" title='ndarray_unit::BaseUnit enum'>BaseUnit</a></td><td class='docblock-short'><p>An enum representing the seven units of the <strong>International System of Units</strong></p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.get_ampere.html" title='ndarray_unit::get_ampere fn'>get_ampere</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::AMPERE)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_becquerel.html" title='ndarray_unit::get_becquerel fn'>get_becquerel</a></td><td class='docblock-short'><p>Utility method to get the becquerel Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_birth.html" title='ndarray_unit::get_birth fn'>get_birth</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.get_candela.html" title='ndarray_unit::get_candela fn'>get_candela</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::CANDELA)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_coulomb.html" title='ndarray_unit::get_coulomb fn'>get_coulomb</a></td><td class='docblock-short'><p>Utility method to get the Coulomb Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_currency.html" title='ndarray_unit::get_currency fn'>get_currency</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.get_death.html" title='ndarray_unit::get_death fn'>get_death</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.get_farad.html" title='ndarray_unit::get_farad fn'>get_farad</a></td><td class='docblock-short'><p>Utility method to get the Coulomb Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_henry.html" title='ndarray_unit::get_henry fn'>get_henry</a></td><td class='docblock-short'><p>Utility method to get the Henry Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_hertz.html" title='ndarray_unit::get_hertz fn'>get_hertz</a></td><td class='docblock-short'><p>Utility method to get the Hertz Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_inhabitant.html" title='ndarray_unit::get_inhabitant fn'>get_inhabitant</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.get_joule.html" title='ndarray_unit::get_joule fn'>get_joule</a></td><td class='docblock-short'><p>Utility method to get the Joule Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_kelvin.html" title='ndarray_unit::get_kelvin fn'>get_kelvin</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::KELVIN)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_meter.html" title='ndarray_unit::get_meter fn'>get_meter</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::METER)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_mole.html" title='ndarray_unit::get_mole fn'>get_mole</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::MOLE)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_newton.html" title='ndarray_unit::get_newton fn'>get_newton</a></td><td class='docblock-short'><p>Utility method to get the Joule Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_ohm.html" title='ndarray_unit::get_ohm fn'>get_ohm</a></td><td class='docblock-short'><p>Utility method to get the Ohm Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_pascal.html" title='ndarray_unit::get_pascal fn'>get_pascal</a></td><td class='docblock-short'><p>Utility metgod to get the Pascal Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_radian.html" title='ndarray_unit::get_radian fn'>get_radian</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::RADIAN)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_second.html" title='ndarray_unit::get_second fn'>get_second</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::SECOND)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_siemens.html" title='ndarray_unit::get_siemens fn'>get_siemens</a></td><td class='docblock-short'><p>Utility method to get the Siemens Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_steradian.html" title='ndarray_unit::get_steradian fn'>get_steradian</a></td><td class='docblock-short'><p>Utility method to get a Unit from a BaseUnit (BaseUnit::STERADIAN)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_tesla.html" title='ndarray_unit::get_tesla fn'>get_tesla</a></td><td class='docblock-short'><p>Utility method to get the Tesla Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_volt.html" title='ndarray_unit::get_volt fn'>get_volt</a></td><td class='docblock-short'><p>Utility method to get the Volt Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_watt.html" title='ndarray_unit::get_watt fn'>get_watt</a></td><td class='docblock-short'><p>Utility method to get the Watt Unit (composed)</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_weber.html" title='ndarray_unit::get_weber fn'>get_weber</a></td><td class='docblock-short'><p>Utility method to get the Weber Unit (composed)</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "ndarray_unit";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>