-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdip-Distribution-Sample.html
190 lines (188 loc) · 14.3 KB
/
dip-Distribution-Sample.html
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::Distribution::Sample class | DIPlib | a library for quantitative image analysis</title>
<link rel="stylesheet" href="m-dip+documentation.compiled.css" />
<link rel="icon" href="DIPlib_logo_32.png" type="image/png" />
<link rel="search" type="application/opensearchdescription+xml" href="opensearch.xml" title="Search DIPlib documentation" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#ffffff" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
<a href="https://diplib.org"><img src="DIPlib_logo.svg" alt="" />DIPlib</a><span class="m-breadcrumb">┃</span><a href="index.html" class="m-thin">a library for quantitative image analysis</a><span class="m-breadcrumb">┃</span><a href="https://github.com/DIPlib/diplib/releases/tag/3.5.2" class="m-thin">version 3.5.2</a> </span>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
</svg></a>
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="pages.html">Pages</a></li>
<li><a href="modules.html">Modules</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li><a href="classes.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<div class="m-doc-include m-thin m-right-m m-text-right">
<span class="m-code m-thin">#include <a href="file--diplib--distribution-h.html">"diplib/distribution.h"</a></span> </div>
<span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span><span class="m-breadcrumb"><a href="dip-Distribution.html">Distribution</a>::<wbr/></span>Sample <span class="m-thin">class</span> </h1>
<p>One sample of a distribution.</p>
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#typeless-methods">Constructors, destructors, assignment and conversion operators</a></li>
<li><a href="#function-members">Functions</a></li>
<li><a href="#operator-members">Operators</a></li>
</ul>
</li>
</ul>
</div>
<p>A sample implicitly converts to <a href="pixeltypes.html#dip-dfloat"><code>dip::dfloat</code></a>, evaluating to the value of <em>y</em> for
the sample. For multi-valued samples, evaluates to the first <em>y</em> value.</p>
<p>Given a <code>Sample</code> <code>s</code>, <code>s.X()</code> accesses the <em>x</em>-value of the sample, <code>s.Y()</code> accesses
the (first) <em>y</em>-value, <code>s.Y(ii)</code> accesses the <code>(ii+1)</code>-th <em>y</em> value, and <code>s.Y(ii,jj)</code> accesses
the element at (<code>ii</code>,<code>jj</code>). <code>s.Y(ii,jj)</code> is equivalent to <code>s.Y(ii+jj*nRows)</code>, where <code>nRows</code>
is the number of rows in the matrix. None of these accessors test for out-of-bounds accesses.</p>
<aside class="m-note m-warning">
<h4>Warning</h4>
<p>Note that <code>Sample</code> references the <a href="dip-Distribution.html"><code>dip::Distribution</code></a> it is created from, which must therefore
exist while the sample is used. Copying a <code>Sample</code> does not create new storage, the copy will
reference the same data. Therefore, things like the following will not work:</p>
<div class="m-code"><pre><span></span><span class="n">Distribution</span><span class="w"> </span><span class="n">d</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">...;</span>
<span class="k">auto</span><span class="w"> </span><span class="n">tmp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d</span><span class="p">[</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">];</span>
<span class="n">d</span><span class="p">[</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d</span><span class="p">[</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">];</span><span class="w"> </span><span class="c1">// `tmp` changes along with `d[ 2 ]`, since they reference the same data</span>
<span class="n">d</span><span class="p">[</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tmp</span><span class="p">;</span>
</pre></div>
<p>Instead, use <code>swap</code>. Do note that some algorithms in the C++ Standard Library expect the above
to work.</p>
</aside>
<section id="typeless-methods">
<h2>Constructors, destructors, assignment and conversion operators</h2>
<dl class="m-doc">
<dt id="dip-Distribution-Sample-Sample">
<span class="m-doc-wrap-bumper"><a href="#dip-Distribution-Sample-Sample" class="m-doc-self">Sample</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-danger">deleted</span></span>
</dt>
<dd>Not default constructable</dd>
<dt id="dip-Distribution-Sample-Sample-Sample-R">
<span class="m-doc-wrap-bumper"><a href="#dip-Distribution-Sample-Sample-Sample-R" class="m-doc-self">Sample</a>(</span><span class="m-doc-wrap"><a href="dip-Distribution-Sample.html" class="m-doc">dip::Distribution::Sample</a>&& ) <span class="m-label m-flat m-info">defaulted</span></span>
</dt>
<dd>Move constructor</dd>
<dt id="dip-Distribution-Sample-Sample-Sample-CL">
<span class="m-doc-wrap-bumper"><a href="#dip-Distribution-Sample-Sample-Sample-CL" class="m-doc-self">Sample</a>(</span><span class="m-doc-wrap"><a href="dip-Distribution-Sample.html" class="m-doc">dip::Distribution::Sample</a> const& ) <span class="m-label m-flat m-info">defaulted</span></span>
</dt>
<dd>Copy constructor, references the same data. Careful!</dd>
<dt id="dip-Distribution-Sample-operator%3D-Sample-R">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Distribution-Sample-operator%3D-Sample-R" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-Distribution-Sample.html" class="m-doc">dip::Distribution::Sample</a>&& other) -> <a href="dip-Distribution-Sample.html" class="m-doc">dip::Distribution::Sample</a>&</span>
</dt>
<dd>Move assignment actually copies value over to sample referenced</dd>
<dt id="dip-Distribution-Sample-operator%3D-Sample-CL">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Distribution-Sample-operator%3D-Sample-CL" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="dip-Distribution-Sample.html" class="m-doc">dip::Distribution::Sample</a> const& other) -> <a href="dip-Distribution-Sample.html" class="m-doc">dip::Distribution::Sample</a>&</span>
</dt>
<dd>Copy assignment, data is copied to sample referenced</dd>
</dl>
</section>
<section id="function-members">
<h2>Functions</h2>
<dl class="m-doc">
<dt id="dip-Distribution-Sample-X">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Distribution-Sample-X" class="m-doc-self">X</a>(</span><span class="m-doc-wrap">) -> <a href="dip-Distribution.html#dip-Distribution-ValueType" class="m-doc">dip::Distribution::ValueType</a>&</span>
</dt>
<dd>Returns reference to sample’s <em>x</em> value.</dd>
<dt id="dip-Distribution-Sample-Y-dip-uint-">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Distribution-Sample-Y-dip-uint-" class="m-doc-self">Y</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> index = 0) -> <a href="dip-Distribution.html#dip-Distribution-ValueType" class="m-doc">dip::Distribution::ValueType</a>&</span>
</dt>
<dd>Returns reference to sample’s <code>(index+1)</code>-th <em>y</em> value.</dd>
<dt id="dip-Distribution-Sample-Y-dip-uint--dip-uint-">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Distribution-Sample-Y-dip-uint--dip-uint-" class="m-doc-self">Y</a>(</span><span class="m-doc-wrap"><a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> row,
<a href="supporttypes.html#dip-uint" class="m-doc">dip::uint</a> col) -> <a href="dip-Distribution.html#dip-Distribution-ValueType" class="m-doc">dip::Distribution::ValueType</a>&</span>
</dt>
<dd>Returns reference to sample’s <em>y</em> value at (<code>row</code>,<code>col</code>).</dd>
<dt id="dip-Distribution-Sample-swap-Sample-L">
<span class="m-doc-wrap-bumper">void <a href="#dip-Distribution-Sample-swap-Sample-L" class="m-doc-self">swap</a>(</span><span class="m-doc-wrap"><a href="dip-Distribution-Sample.html" class="m-doc">dip::Distribution::Sample</a>& other)</span>
</dt>
<dd>Swaps two samples, copying the data from <code>other</code> to <code>*this</code>, and that from <code>*this</code> to <code>other</code>.
Both must have the same number of values.</dd>
</dl>
</section>
<section id="operator-members">
<h2>Operators</h2>
<dl class="m-doc">
<dt id="dip-Distribution-Sample-operator%20dfloat-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Distribution-Sample-operator%20dfloat-C" class="m-doc-self">operator dfloat</a>(</span><span class="m-doc-wrap">) const -> <a href="pixeltypes.html#dip-dfloat" class="m-doc">dip::dfloat</a></span>
</dt>
<dd>Implicitly casts to sample’s first <em>y</em> value.</dd>
</dl>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">…</div>
</div>
<div class="m-doc-search-content">
<form action="https://diplib.org/diplib-docs/#search">
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript. Enable it or <a href="https://google.com/search?q=site:diplib.org+">use an external search engine</a>.</noscript>
<div id="search-help" class="m-text m-dim m-text-center">
<p class="m-noindent">Search for symbols, directories, files, pages or modules.
You can omit any prefix from the symbol or file path; adding a <code>:</code> or
<code>/</code> suffix lists all members of given symbol or directory.</p>
<p class="m-noindent">Use <span class="m-label m-dim">↓</span> / <span class="m-label m-dim">↑</span> to navigate through the list,
<span class="m-label m-dim">Enter</span> to go.
<span class="m-label m-dim">Tab</span> autocompletes common prefix.
You can copy a link to the result using <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">L</span>,
or <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">M</span> to copy a Markdown link.</p>
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.<br />Maybe try a full-text <a href="#" id="search-external" data-search-engine="https://google.com/search?q=site:diplib.org+{query}">search with external engine</a>?</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v1.js"></script>
<script src="searchdata-v1.js" async="async"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<p>DIPlib, a library for quantitative image analysis. Documentation compiled with <a href="https://crisluengo.github.io/doxpp/">dox++</a> and styled with <a href="https://mcss.mosra.cz/">m.css</a>.</p>
</div>
</div>
</div>
</nav></footer>
</body>
</html>