mirror of
				https://github.com/boostorg/unordered.git
				synced 2025-11-04 01:31:41 +01:00 
			
		
		
		
	Update reference docs to include contains()
				
					
				
			This commit is contained in:
		
							
								
								
									
										33
									
								
								doc/ref.php
									
									
									
									
									
								
							
							
						
						
									
										33
									
								
								doc/ref.php
									
									
									
									
									
								
							@@ -1406,6 +1406,39 @@ EOL;
 | 
			
		||||
                </para>
 | 
			
		||||
              </notes>
 | 
			
		||||
            </overloaded-method>            
 | 
			
		||||
            <overloaded-method name="contains">
 | 
			
		||||
              <signature cv="const">
 | 
			
		||||
                <parameter name="key">
 | 
			
		||||
                  <paramtype>key_type const&</paramtype>
 | 
			
		||||
                </parameter>
 | 
			
		||||
                <type>bool</type>
 | 
			
		||||
              </signature>
 | 
			
		||||
              <signature>
 | 
			
		||||
                <template>
 | 
			
		||||
                  <template-type-parameter name="K" />
 | 
			
		||||
                </template>
 | 
			
		||||
                <parameter name="key">
 | 
			
		||||
                  <paramtype>K const&</paramtype>
 | 
			
		||||
                </parameter>
 | 
			
		||||
                <type>bool</type>
 | 
			
		||||
              </signature>
 | 
			
		||||
              <returns>
 | 
			
		||||
                <para>
 | 
			
		||||
                  A boolean indicating whether or not there is an element with key equal to <code>key</code> in the container
 | 
			
		||||
                </para>
 | 
			
		||||
              </returns>
 | 
			
		||||
              <notes>
 | 
			
		||||
                <para>
 | 
			
		||||
                  The <code>template <typename K></code> overload only participates
 | 
			
		||||
                  in overload resolution if <code>Hash::is_transparent</code> and
 | 
			
		||||
                  <code>Pred::is_transparent</code> are valid member typedefs. The
 | 
			
		||||
                  library assumes that <code>Hash</code> is callable with both
 | 
			
		||||
                  <code>K</code> and <code>Key</code> and that <code>Pred</code> is
 | 
			
		||||
                  transparent. This enables heterogeneous lookup which avoids the cost of
 | 
			
		||||
                  instantiating an instance of the <code>Key</code> type.
 | 
			
		||||
                </para>
 | 
			
		||||
              </notes>
 | 
			
		||||
            </overloaded-method>
 | 
			
		||||
            <overloaded-method name="count">
 | 
			
		||||
              <signature cv="const">
 | 
			
		||||
                <parameter name="k">
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user