File: Comparison-Ops.html

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (227 lines) | stat: -rw-r--r-- 13,557 bytes parent folder | download | duplicates (2)
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Comparison Ops (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Comparison Ops (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Comparison Ops (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Expressions.html" rel="up" title="Expressions">
<link href="Boolean-Expressions.html" rel="next" title="Boolean Expressions">
<link href="Arithmetic-Ops.html" rel="prev" title="Arithmetic Ops">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="section-level-extent" id="Comparison-Ops">
<div class="nav-panel">
<p>
Next: <a href="Boolean-Expressions.html" accesskey="n" rel="next">Boolean Expressions</a>, Previous: <a href="Arithmetic-Ops.html" accesskey="p" rel="prev">Arithmetic Operators</a>, Up: <a href="Expressions.html" accesskey="u" rel="up">Expressions</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Comparison-Operators"><span>8.4 Comparison Operators<a class="copiable-link" href="#Comparison-Operators"> &para;</a></span></h3>
<a class="index-entry-id" id="index-comparison-expressions"></a>
<a class="index-entry-id" id="index-expressions_002c-comparison"></a>
<a class="index-entry-id" id="index-relational-operators"></a>
<a class="index-entry-id" id="index-operators_002c-relational"></a>
<a class="index-entry-id" id="index-less-than-operator"></a>
<a class="index-entry-id" id="index-greater-than-operator"></a>
<a class="index-entry-id" id="index-equality-operator"></a>
<a class="index-entry-id" id="index-tests-for-equality"></a>
<a class="index-entry-id" id="index-equality_002c-tests-for"></a>

<p><em class="dfn">Comparison operators</em> compare numeric values for relationships
such as equality.  They are written using
<em class="emph">relational operators</em>.
</p>
<p>All of Octave&rsquo;s comparison operators return a value of 1 if the
comparison is true, or 0 if it is false.  For matrix values, they all
work on an element-by-element basis.  Broadcasting rules apply.
See <a class="xref" href="Broadcasting.html">Broadcasting</a>.  For example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">[1, 2; 3, 4] == [1, 3; 2, 4]
     &rArr;  1  0
         0  1
</pre></div></div>

<p>According to broadcasting rules, if one operand is a scalar and the
other is a matrix, the scalar is compared to each element of the matrix
in turn, and the result is the same size as the matrix.
</p>
<dl class="table">
<dt><a id="index-_003c"></a><span><code class="code"><var class="var">x</var> &lt; <var class="var">y</var></code><a class="copiable-link" href="#index-_003c"> &para;</a></span></dt>
<dd><p>True if <var class="var">x</var> is less than <var class="var">y</var>.
</p>
</dd>
<dt><a id="index-_003c_003d"></a><span><code class="code"><var class="var">x</var> &lt;= <var class="var">y</var></code><a class="copiable-link" href="#index-_003c_003d"> &para;</a></span></dt>
<dd><p>True if <var class="var">x</var> is less than or equal to <var class="var">y</var>.
</p>
</dd>
<dt><a id="index-_003d_003d"></a><span><code class="code"><var class="var">x</var> == <var class="var">y</var></code><a class="copiable-link" href="#index-_003d_003d"> &para;</a></span></dt>
<dd><p>True if <var class="var">x</var> is equal to <var class="var">y</var>.
</p>
</dd>
<dt><a id="index-_003e_003d"></a><span><code class="code"><var class="var">x</var> &gt;= <var class="var">y</var></code><a class="copiable-link" href="#index-_003e_003d"> &para;</a></span></dt>
<dd><p>True if <var class="var">x</var> is greater than or equal to <var class="var">y</var>.
</p>
</dd>
<dt><a id="index-_003e"></a><span><code class="code"><var class="var">x</var> &gt; <var class="var">y</var></code><a class="copiable-link" href="#index-_003e"> &para;</a></span></dt>
<dd><p>True if <var class="var">x</var> is greater than <var class="var">y</var>.
</p>
</dd>
<dt><a class="index-entry-id" id="index-_007e_003d"></a>
<a id="index-_0021_003d"></a><span><code class="code"><var class="var">x</var> != <var class="var">y</var></code><a class="copiable-link" href="#index-_0021_003d"> &para;</a></span></dt>
<dt><code class="code"><var class="var">x</var> ~= <var class="var">y</var></code></dt>
<dd><p>True if <var class="var">x</var> is not equal to <var class="var">y</var>.
</p></dd>
</dl>

<p>For complex numbers, the following ordering is defined:
<var class="var">z1</var> &lt; <var class="var">z2</var>
if and only if
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">  abs (<var class="var">z1</var>) &lt; abs (<var class="var">z2</var>)
  || (abs (<var class="var">z1</var>) == abs (<var class="var">z2</var>) &amp;&amp; arg (<var class="var">z1</var>) &lt; arg (<var class="var">z2</var>))
</pre></div></div>

<p>This is consistent with the ordering used by <em class="dfn">max</em>, <em class="dfn">min</em> and
<em class="dfn">sort</em>, but is not consistent with <small class="sc">MATLAB</small>, which only compares the real
parts.
</p>
<p>String comparisons may also be performed with the <code class="code">strcmp</code>
function, not with the comparison operators listed above.
See <a class="xref" href="Strings.html">Strings</a>.
</p>
<a class="index-entry-id" id="index-_003d_003d-1"></a>
<a class="anchor" id="XREFeq"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-eq"><span><code class="def-type"><var class="var">TF</var> =</code> <strong class="def-name">eq</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">B</var>)</code><a class="copiable-link" href="#index-eq"> &para;</a></span></dt>
<dd><p>Return true if the two inputs are equal.
</p>
<p>This function is equivalent to <code class="code"><var class="var">A</var>&nbsp;==&nbsp;<var class="var">B</var></code><!-- /@w -->.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFne">ne</a>, <a class="ref" href="#XREFisequal">isequal</a>, <a class="ref" href="#XREFle">le</a>, <a class="ref" href="#XREFge">ge</a>, <a class="ref" href="#XREFgt">gt</a>, <a class="ref" href="#XREFne">ne</a>, <a class="ref" href="#XREFlt">lt</a>.
</p></dd></dl>


<a class="index-entry-id" id="index-_003e_003d-1"></a>
<a class="anchor" id="XREFge"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-ge"><span><code class="def-type"><var class="var">TF</var> =</code> <strong class="def-name">ge</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">B</var>)</code><a class="copiable-link" href="#index-ge"> &para;</a></span></dt>
<dd><p>This function is equivalent to <code class="code"><var class="var">A</var>&nbsp;&gt;=&nbsp;<var class="var">B</var></code><!-- /@w -->.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFle">le</a>, <a class="ref" href="#XREFeq">eq</a>, <a class="ref" href="#XREFgt">gt</a>, <a class="ref" href="#XREFne">ne</a>, <a class="ref" href="#XREFlt">lt</a>.
</p></dd></dl>


<a class="index-entry-id" id="index-_003e-1"></a>
<a class="anchor" id="XREFgt"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-gt"><span><code class="def-type"><var class="var">TF</var> =</code> <strong class="def-name">gt</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">B</var>)</code><a class="copiable-link" href="#index-gt"> &para;</a></span></dt>
<dd><p>This function is equivalent to <code class="code"><var class="var">A</var>&nbsp;&gt;&nbsp;<var class="var">B</var></code><!-- /@w -->.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFle">le</a>, <a class="ref" href="#XREFeq">eq</a>, <a class="ref" href="#XREFge">ge</a>, <a class="ref" href="#XREFne">ne</a>, <a class="ref" href="#XREFlt">lt</a>.
</p></dd></dl>


<a class="anchor" id="XREFisequal"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-isequal"><span><code class="def-type"><var class="var">tf</var> =</code> <strong class="def-name">isequal</strong> <code class="def-code-arguments">(<var class="var">x1</var>, <var class="var">x2</var>, &hellip;)</code><a class="copiable-link" href="#index-isequal"> &para;</a></span></dt>
<dd><p>Return true if all of <var class="var">x1</var>, <var class="var">x2</var>, &hellip; are equal.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFisequaln">isequaln</a>.
</p></dd></dl>


<a class="anchor" id="XREFisequaln"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-isequaln"><span><code class="def-type"><var class="var">tf</var> =</code> <strong class="def-name">isequaln</strong> <code class="def-code-arguments">(<var class="var">x1</var>, <var class="var">x2</var>, &hellip;)</code><a class="copiable-link" href="#index-isequaln"> &para;</a></span></dt>
<dd><p>Return true if all of <var class="var">x1</var>, <var class="var">x2</var>, &hellip; are equal under the
additional assumption that NaN == NaN (no comparison of NaN placeholders
in dataset).
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFisequal">isequal</a>.
</p></dd></dl>


<a class="index-entry-id" id="index-_003c_003d-1"></a>
<a class="anchor" id="XREFle"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-le"><span><code class="def-type"><var class="var">TF</var> =</code> <strong class="def-name">le</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">B</var>)</code><a class="copiable-link" href="#index-le"> &para;</a></span></dt>
<dd><p>This function is equivalent to <code class="code"><var class="var">A</var>&nbsp;&lt;=&nbsp;<var class="var">B</var></code><!-- /@w -->.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFeq">eq</a>, <a class="ref" href="#XREFge">ge</a>, <a class="ref" href="#XREFgt">gt</a>, <a class="ref" href="#XREFne">ne</a>, <a class="ref" href="#XREFlt">lt</a>.
</p></dd></dl>


<a class="index-entry-id" id="index-_003c-1"></a>
<a class="anchor" id="XREFlt"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-lt"><span><code class="def-type"><var class="var">TF</var> =</code> <strong class="def-name">lt</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">B</var>)</code><a class="copiable-link" href="#index-lt"> &para;</a></span></dt>
<dd><p>This function is equivalent to <code class="code"><var class="var">A</var>&nbsp;&lt;&nbsp;<var class="var">B</var></code><!-- /@w -->.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFle">le</a>, <a class="ref" href="#XREFeq">eq</a>, <a class="ref" href="#XREFge">ge</a>, <a class="ref" href="#XREFgt">gt</a>, <a class="ref" href="#XREFne">ne</a>.
</p></dd></dl>


<a class="index-entry-id" id="index-_0021_003d-1"></a>
<a class="index-entry-id" id="index-_007e_003d-1"></a>
<a class="anchor" id="XREFne"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-ne"><span><code class="def-type"><var class="var">TF</var> =</code> <strong class="def-name">ne</strong> <code class="def-code-arguments">(<var class="var">A</var>, <var class="var">B</var>)</code><a class="copiable-link" href="#index-ne"> &para;</a></span></dt>
<dd><p>Return true if the two inputs are not equal.
</p>
<p>This function is equivalent to <code class="code"><var class="var">A</var>&nbsp;!=&nbsp;<var class="var">B</var></code><!-- /@w -->.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFeq">eq</a>, <a class="ref" href="#XREFisequal">isequal</a>, <a class="ref" href="#XREFle">le</a>, <a class="ref" href="#XREFge">ge</a>, <a class="ref" href="#XREFlt">lt</a>.
</p></dd></dl>


</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Boolean-Expressions.html">Boolean Expressions</a>, Previous: <a href="Arithmetic-Ops.html">Arithmetic Operators</a>, Up: <a href="Expressions.html">Expressions</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>