File: operators.html

package info (click to toggle)
stl-manual 3.30-13
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 5,440 kB
  • ctags: 4,550
  • sloc: cpp: 17,845; ansic: 2,842; makefile: 41
file content (137 lines) | stat: -rw-r--r-- 5,755 bytes parent folder | download | duplicates (7)
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
<HTML>
<!--
  -- Copyright (c) 1996-1999
  -- Silicon Graphics Computer Systems, Inc.
  --
  -- Permission to use, copy, modify, distribute and sell this software
  -- and its documentation for any purpose is hereby granted without fee,
  -- provided that the above copyright notice appears in all copies and
  -- that both that copyright notice and this permission notice appear
  -- in supporting documentation.  Silicon Graphics makes no
  -- representations about the suitability of this software for any
  -- purpose.  It is provided "as is" without express or implied warranty.
  --
  -- Copyright (c) 1994
  -- Hewlett-Packard Company
  --
  -- Permission to use, copy, modify, distribute and sell this software
  -- and its documentation for any purpose is hereby granted without fee,
  -- provided that the above copyright notice appears in all copies and
  -- that both that copyright notice and this permission notice appear
  -- in supporting documentation.  Hewlett-Packard Company makes no
  -- representations about the suitability of this software for any
  -- purpose.  It is provided "as is" without express or implied warranty.
  --
  -->
<Head>
<Title>Relational Operators</Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
	ALINK="#ff0000"> 
<IMG SRC="CorpID.gif" 
     ALT="SGI" HEIGHT="43" WIDTH="151"> 
<!--end header-->
<BR Clear>
<H1>Relational Operators</H1>

<Table CellPadding=0 CellSpacing=0 width=100%>
<TR>
<TD Align=left><Img src = "utilities.gif" Alt=""   WIDTH = "194"  HEIGHT = "38" ></TD>
<TD Align=right><Img src = "function.gif" Alt=""   WIDTH = "194"  HEIGHT = "38" ></TD>
</TR>
<TR>
<TD Align=left VAlign=top><b>Category</b>: utilities</TD>
<TD Align=right VAlign=top><b>Component type</b>: function</TD>
</TR>
</Table>

<h3>Prototype</h3>
<pre>
template &lt;class T&gt; bool operator!=(const T&amp; x, const T&amp; y);
template &lt;class T&gt; bool operator&gt;(const T&amp; x, const T&amp; y);
template &lt;class T&gt; bool operator&lt;=(const T&amp; x, const T&amp; y);
template &lt;class T&gt; bool operator&gt;=(const T&amp; x, const T&amp; y);
</pre>                   
<h3>Description</h3>
The <A href="EqualityComparable.html">Equality Comparable</A> requirements specify that it must be
possible to compare objects using <tt>operator!=</tt> as well as <tt>operator==</tt>;
similarly, the <A href="LessThanComparable.html">LessThan Comparable</A> requirements include
<tt>operator&gt;</tt>, <tt>operator&lt;=</tt> and <tt>operator&gt;=</tt> as well as <tt>operator&lt;</tt>.
Logically, however, most of these operators are redundant: all of
them can be defined in terms of <tt>operator==</tt> and <tt>operator&lt;</tt>.
<P>
These four templates use <tt>operator==</tt> and <tt>operator&lt;</tt> to define the other
four relational operators.  They exist purely for the sake of convenience:
they make it possible to write algorithms in terms of the operators
<tt>!=</tt>, <tt>&gt;</tt>, <tt>&lt;=</tt>, and <tt>&gt;=</tt>, without requiring that those operators be
explicitly defined for every type.
<P>
As specified in the <A href="EqualityComparable.html">Equality Comparable</A> requirements, <tt>x != y</tt> is
equivalent to <tt>!(x == y)</tt>.  As specified in the <A href="LessThanComparable.html">LessThan Comparable</A>
requirements, <tt>x &gt; y</tt> is equivalent to <tt>y &lt; x</tt>, <tt>x &gt;= y</tt> is equivalent
to <tt>!(x &lt; y)</tt>, and <tt>x &lt;= y</tt> is equivalent to <tt>!(y &lt; x)</tt>.
<h3>Definition</h3>
Defined in the standard header <A href="utility">utility</A>, and in the nonstandard
backward-compatibility header <A href="function.h">function.h</A>.
<h3>Requirements on types</h3>
The requirement for <tt>operator!=</tt> is that <tt>x == y</tt> is a valid expression
for objects <tt>x</tt> and <tt>y</tt> of type <tt>T</tt>. 
<P>
The requirement for <tt>operator&gt;</tt> is that <tt>y &lt; x</tt> is a valid expression
for objects <tt>x</tt> and <tt>y</tt> of type <tt>T</tt>. 
<P>
The requirement for <tt>operator&lt;=</tt> is that <tt>y &lt; x</tt> is a valid expression
for objects <tt>x</tt> and <tt>y</tt> of type <tt>T</tt>. 
<P>
The requirement for <tt>operator&gt;=</tt> is that <tt>x &lt; y</tt> is a valid expression
for objects <tt>x</tt> and <tt>y</tt> of type <tt>T</tt>. 
<h3>Preconditions</h3>
The precondition for <tt>operator!=</tt> is that <tt>x</tt> and <tt>y</tt> are in the
domain of <tt>operator==</tt>.
<P>
The precondition for <tt>operator&gt;</tt>, <tt>operator&lt;=</tt>, and <tt>operator&gt;=</tt> is
that <tt>x</tt> and <tt>y</tt> are in the domain of <tt>operator&lt;</tt>.
<h3>Complexity</h3>
<h3>Example</h3>
<pre>
template &lt;class T&gt; void relations(T x, T y)
{
  if (x == y) assert(!(x != y));
  else assert(x != y);

  if (x &lt; y) {
    assert(x &lt;= y);
    assert(y &gt; x);
    assert(y &gt;= x);
  }
  else if (y &lt; x) {
    assert(y &lt;= x);
    assert(x &lt; y);
    assert(x &lt;= y);
  }
  else {
    assert(x &lt;= y);
    assert(x &gt;= y);
  }
}  
</pre>
<h3>Notes</h3>
<h3>See also</h3>
<A href="EqualityComparable.html">Equality Comparable</A>, <A href="LessThanComparable.html">LessThan Comparable</A>

<!--start footer--> 
<HR SIZE="6">
<A href="http://www.sgi.com/"><IMG SRC="surf.gif" HEIGHT="54" WIDTH="54" 
        ALT="[Silicon Surf]"></A>
<A HREF="index.html"><IMG SRC="stl_home.gif" 
        HEIGHT="54" WIDTH="54" ALT="[STL Home]"></A>
<BR>
<FONT SIZE="-2">
<A href="http://www.sgi.com/Misc/sgi_info.html" TARGET="_top">Copyright &copy; 
1999 Silicon Graphics, Inc.</A> All Rights Reserved.</FONT>
<FONT SIZE="-3"><a href="http://www.sgi.com/Misc/external.list.html" TARGET="_top">TrademarkInformation</A>
</FONT>
<P>
</BODY>
</HTML>