forked from boostorg/concept_check
Added Caramel/BoostBook concept documentation (finally)
[SVN r21176]
This commit is contained in:
1 parent
5741cdc2dc
commit
669e6938cc
13 files changed
+1915
No files matched your search
@@ -0,0 +1,59 @@
|
||||
<?xml version="1.0"?>
|
||||
<concept name="Assignable" category="Utility"><!--
|
||||
Based on concepts from the SGI Standard Template Library documentation:
|
||||
Copyright (c) 1996-1999
|
||||
Silicon Graphics Computer Systems, Inc.
|
||||
|
||||
Copyright (c) 1994
|
||||
Hewlett-Packard Company
|
||||
--><!--
|
||||
Copyright 2000-2001 University of Notre Dame du Lac.
|
||||
Copyright 2001-2002 Indiana University.
|
||||
Some concepts based on versions from the MTL draft manual and Boost Graph
|
||||
and Property Map documentation:
|
||||
Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000
|
||||
-->
|
||||
<param name="X" role="assignable-type"/>
|
||||
|
||||
<models-sentence>The type <arg num="1"/> must be a model of <self/>.</models-sentence>
|
||||
|
||||
<description>
|
||||
<para>Assignable types must have copy constructors,
|
||||
<code>operator=</code> for assignment, and the <code>swap()</code>
|
||||
function defined.</para>
|
||||
</description>
|
||||
|
||||
<notation variables="x y">
|
||||
<sample-value>
|
||||
<type name="X"/>
|
||||
</sample-value>
|
||||
</notation>
|
||||
|
||||
<refines const="no" concept="CopyConstructible"/>
|
||||
|
||||
<valid-expression name="Assignment">
|
||||
<assign>
|
||||
<sample-value><reference-to><type name="X"/></reference-to></sample-value>
|
||||
<sample-value><const><reference-to><type name="X"/></reference-to></const></sample-value>
|
||||
</assign>
|
||||
<return-type>
|
||||
<require-same-type testable="yes">
|
||||
<reference-to><type name="X"/></reference-to>
|
||||
</require-same-type>
|
||||
</return-type>
|
||||
<semantics>Require <code>operator=</code></semantics>
|
||||
</valid-expression>
|
||||
|
||||
<valid-expression name="Swap">
|
||||
<apply-function name="swap">
|
||||
<sample-value><reference-to><type name="X"/></reference-to></sample-value>
|
||||
<sample-value><reference-to><type name="X"/></reference-to></sample-value>
|
||||
</apply-function>
|
||||
<return-type><require-same-type><type name="void"/></require-same-type></return-type>
|
||||
<semantics>Require <code>swap()</code> function</semantics>
|
||||
</valid-expression>
|
||||
|
||||
<example-model>
|
||||
<type name="int"/>
|
||||
</example-model>
|
||||
</concept>
|
||||
Reference in new issue
Block a user