Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/concept_check/doc/reference/LessThanComparable.xml @ 29

Last change on this file since 29 was 29, checked in by landauf, 16 years ago

updated boost from 1_33_1 to 1_34_1

File size: 2.6 KB
Line 
1<?xml version="1.0"?>
2<concept name="LessThanComparable" category="Utility"><!--
3Based on concepts from the SGI Standard Template Library documentation:
4Copyright (c) 1996-1999
5Silicon Graphics Computer Systems, Inc.
6
7Copyright (c) 1994
8Hewlett-Packard Company
9--><!--
10Copyright 2000-2001 University of Notre Dame du Lac.
11Copyright 2001-2002 Indiana University.
12Some concepts based on versions from the MTL draft manual and Boost Graph
13and Property Map documentation:
14Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
15-->
16  <param name="X" role="comparable-type"/>
17
18  <models-sentence>The type <arg num="1"/> must be a model of <self/>.</models-sentence>
19
20  <description><para>LessThanComparable types must have <code>&lt;</code>,
21  <code>&gt;</code>, <code>&lt;=</code>, and <code>&gt;=</code>
22  operators.</para></description>
23
24  <notation variables="x y"><sample-value><type name="X"/></sample-value></notation>
25
26  <valid-expression name="Less than">
27    <less-than>
28      <sample-value><type name="X"/></sample-value>
29      <sample-value><type name="X"/></sample-value>
30    </less-than>
31    <return-type>
32      <convertible-to testable="yes">
33        <type name="bool"/>
34      </convertible-to>
35    </return-type>
36    <semantics>Determine if one value is less than another.</semantics>
37  </valid-expression>
38
39  <valid-expression name="Less than or equal">
40    <less-than-or-equal>
41      <sample-value><type name="X"/></sample-value>
42      <sample-value><type name="X"/></sample-value>
43    </less-than-or-equal>
44    <return-type>
45      <convertible-to testable="yes">
46        <type name="bool"/>
47      </convertible-to>
48    </return-type>
49    <semantics>Determine if one value is less than or equal to another.</semantics>
50  </valid-expression>
51
52  <valid-expression name="Greater than">
53    <greater-than>
54      <sample-value><type name="X"/></sample-value>
55      <sample-value><type name="X"/></sample-value>
56    </greater-than>
57    <return-type>
58      <convertible-to testable="yes">
59        <type name="bool"/>
60      </convertible-to>
61    </return-type>
62    <semantics>Determine if one value is greater than another.</semantics>
63  </valid-expression>
64
65  <valid-expression name="Greater than or equal to">
66    <greater-than-or-equal>
67      <sample-value><type name="X"/></sample-value>
68      <sample-value><type name="X"/></sample-value>
69    </greater-than-or-equal>
70    <return-type>
71      <convertible-to testable="yes">
72        <type name="bool"/>
73      </convertible-to>
74    </return-type>
75    <semantics>Determine if one value is greater than or equal to another.</semantics>
76  </valid-expression>
77
78  <example-model>
79    <type name="int"/>
80  </example-model>
81</concept>
Note: See TracBrowser for help on using the repository browser.