They are additionally documented in the online documentation, a copy of which is also shipped with the library source code (in .../docs/html/documentation.html). You can also read the documentation on SGI's site, which is still running even though the code is not maintained.
NB that the following notes are pulled from various comments all over the place, so they may seem stilted.
The identity_element
functions are not part of the C++ standard; SGI provided them as an extension. Its argument is an operation, and its return value is the identity element for that operation. It is overloaded for addition and multiplication, and you can overload it for your own nefarious operations.
As an extension to the binders, SGI provided composition functors and wrapper functions to aid in their creation. The unary_compose
functor is constructed from two functions/functors, f
and g
. Calling operator()
with a single argument x
returns f
(g(x)). The function compose1
takes the two functions and constructs a unary_compose
variable for you.
binary_compose
is constructed from three functors, f
, g1
, and g2
. Its operator()
returns f
(g1(x),g2(x)). The function takes f, g1, and g2, and constructs the binary_compose
instance for you. For example, if f
returns an int, then
int answer = (compose2(f,g1,g2))(x);
int temp1 = g1(x); int temp2 = g2(x); int answer = f(temp1,temp2);
As an extension, SGI provided a functor called identity
. When a functor is required but no operations are desired, this can be used as a pass-through. Its operator()
returns its argument unchanged.
select1st
and select2nd
are extensions provided by SGI. Their operator()s
take a std::pair
as an argument, and return either the first member or the second member, respectively. They can be used (especially with the composition functors) to "strip" data from a sequence before performing the remainder of an algorithm.
The operator()
of the project1st
functor takes two arbitrary arguments and returns the first one, while project2nd
returns the second one. They are extensions provided by SGI.
These three functors are each constructed from a single arbitrary variable/value. Later, their operator()s
completely ignore any arguments passed, and return the stored value.
constant_void_fun's
operator()
takes no argumentsconstant_unary_fun's
operator()
takes one argument (ignored)constant_binary_fun's
operator()
takes two arguments (ignored)
The helper creator functions constant0
, constant1
, and constant2
each take a "result" argument and construct variables of the appropriate functor type.
const _Tp& std::__median | ( | const _Tp & | __a, | |
const _Tp & | __b, | |||
const _Tp & | __c, | |||
_Compare | __comp | |||
) | [inline] |
Find the median of three values using a predicate for comparison.
a | A value. | |
b | A value. | |
c | A value. | |
comp | A binary predicate. |
a
, b
or c
.{l
,m,n} is some convolution of {a
,b,c} such that comp(l,m)
and comp(m,n)
are both true then the value returned will be m
. This is an SGI extension.
Definition at line 121 of file stl_algo.h.
References __glibcxx_function_requires.
const _Tp& std::__median | ( | const _Tp & | __a, | |
const _Tp & | __b, | |||
const _Tp & | __c | |||
) | [inline] |
Find the median of three values.
a | A value. | |
b | A value. | |
c | A value. |
a
, b
or c
.{l
,m,n} is some convolution of {a
,b,c} such that l<=m<=n
then the value returned will be m
. This is an SGI extension.
Definition at line 87 of file stl_algo.h.
References __glibcxx_function_requires.
Referenced by std::__introselect(), and std::__introsort_loop().
size_t std::bitset< _Nb >::_Find_first | ( | ) | const [inline, inherited] |
Finds the index of the first "on" bit.
Definition at line 1129 of file bitset.
References std::_Base_bitset< _Nw >::_M_do_find_first().
size_t std::bitset< _Nb >::_Find_next | ( | size_t | __prev | ) | const [inline, inherited] |
Finds the index of the next "on" bit after prev.
prev | Where to start searching. |
Definition at line 1140 of file bitset.
References std::_Base_bitset< _Nw >::_M_do_find_next().
bitset<_Nb>& std::bitset< _Nb >::_Unchecked_set | ( | size_t | __pos | ) | [inline, inherited] |
These versions of single-bit set, reset, flip, and test are extensions from the SGI version. They do no range checking.
Definition at line 857 of file bitset.
References std::_Base_bitset< _Nw >::_M_getword().
Referenced by std::bitset< _Nb >::_M_copy_from_string(), and std::bitset< _Nb >::set().
unary_compose<_Operation1, _Operation2> __gnu_cxx::compose1 | ( | const _Operation1 & | __fn1, | |
const _Operation2 & | __fn2 | |||
) | [inline] |
binary_compose<_Operation1, _Operation2, _Operation3> __gnu_cxx::compose2 | ( | const _Operation1 & | __fn1, | |
const _Operation2 & | __fn2, | |||
const _Operation3 & | __fn3 | |||
) | [inline] |
constant_void_fun<_Result> __gnu_cxx::constant0 | ( | const _Result & | __val | ) | [inline] |
constant_unary_fun<_Result, _Result> __gnu_cxx::constant1 | ( | const _Result & | __val | ) | [inline] |
constant_binary_fun<_Result,_Result,_Result> __gnu_cxx::constant2 | ( | const _Result & | __val | ) | [inline] |
pair<_InputIterator, _OutputIterator> __gnu_cxx::copy_n | ( | _InputIterator | __first, | |
_Size | __count, | |||
_OutputIterator | __result | |||
) | [inline] |
Copies the range [first,first+count) into [result,result+count).
first | An input iterator. | |
count | The number of elements to copy. | |
result | An output iterator. |
memmove
whenever possible. Failing that, if random access iterators are passed, then the loop count will be known (and therefore a candidate for compiler optimizations such as unrolling).
Definition at line 123 of file ext/algorithm.
References __gnu_cxx::__copy_n(), __glibcxx_function_requires, and std::__iterator_category().
void __gnu_cxx::distance | ( | _InputIterator | __first, | |
_InputIterator | __last, | |||
_Distance & | __n | |||
) | [inline] |
This is an SGI extension.
Definition at line 108 of file ext/iterator.
References __gnu_cxx::__distance(), and std::__iterator_category().
Referenced by __gnu_cxx::hashtable< _Val, _Key, _HashFcn, _ExtractKey, _EqualKey, _Alloc >::insert_equal(), and __gnu_cxx::hashtable< _Val, _Key, _HashFcn, _ExtractKey, _EqualKey, _Alloc >::insert_unique().
_Tp __gnu_cxx::identity_element | ( | std::multiplies< _Tp > | ) | [inline] |
An SGI extension .
Definition at line 96 of file ext/functional.
Referenced by __gnu_cxx::__power().
_Tp __gnu_cxx::identity_element | ( | std::plus< _Tp > | ) | [inline] |
void __gnu_cxx::iota | ( | _ForwardIter | __first, | |
_ForwardIter | __last, | |||
_Tp | __value | |||
) |
This is an SGI extension.
Definition at line 137 of file ext/numeric.
References __glibcxx_function_requires.
bool __gnu_cxx::is_heap | ( | _RandomAccessIterator | __first, | |
_RandomAccessIterator | __last, | |||
_StrictWeakOrdering | __comp | |||
) | [inline] |
This is an SGI extension.
Definition at line 455 of file ext/algorithm.
References __glibcxx_function_requires, __glibcxx_requires_valid_range, and std::__is_heap().
bool __gnu_cxx::is_heap | ( | _RandomAccessIterator | __first, | |
_RandomAccessIterator | __last | |||
) | [inline] |
This is an SGI extension.
Definition at line 436 of file ext/algorithm.
References __glibcxx_function_requires, __glibcxx_requires_valid_range, and std::__is_heap().
bool __gnu_cxx::is_sorted | ( | _ForwardIterator | __first, | |
_ForwardIterator | __last, | |||
_StrictWeakOrdering | __comp | |||
) |
This is an SGI extension.
Definition at line 505 of file ext/algorithm.
References __glibcxx_function_requires, and __glibcxx_requires_valid_range.
bool __gnu_cxx::is_sorted | ( | _ForwardIterator | __first, | |
_ForwardIterator | __last | |||
) |
This is an SGI extension.
Definition at line 480 of file ext/algorithm.
References __glibcxx_function_requires, and __glibcxx_requires_valid_range.
int __gnu_cxx::lexicographical_compare_3way | ( | _InputIterator1 | __first1, | |
_InputIterator1 | __last1, | |||
_InputIterator2 | __first2, | |||
_InputIterator2 | __last2 | |||
) |
memcmp
on steroids.
first1 | An input iterator. | |
last1 | An input iterator. | |
first2 | An input iterator. | |
last2 | An input iterator. |
memcmp
.Definition at line 202 of file ext/algorithm.
References __glibcxx_function_requires, __glibcxx_requires_valid_range, and __gnu_cxx::__lexicographical_compare_3way().
_Tp __gnu_cxx::power | ( | _Tp | __x, | |
_Integer | __n | |||
) | [inline] |
This is an SGI extension.
Definition at line 126 of file ext/numeric.
References __gnu_cxx::__power().
_Tp __gnu_cxx::power | ( | _Tp | __x, | |
_Integer | __n, | |||
_MonoidOperation | __monoid_op | |||
) | [inline] |
This is an SGI extension.
Definition at line 116 of file ext/numeric.
References __gnu_cxx::__power().
Referenced by __gnu_cxx::rope< _CharT, _Alloc >::rope().
_RandomAccessIterator __gnu_cxx::random_sample | ( | _InputIterator | __first, | |
_InputIterator | __last, | |||
_RandomAccessIterator | __out_first, | |||
_RandomAccessIterator | __out_last, | |||
_RandomNumberGenerator & | __rand | |||
) | [inline] |
This is an SGI extension.
Definition at line 412 of file ext/algorithm.
References __glibcxx_function_requires, __glibcxx_requires_valid_range, and __gnu_cxx::__random_sample().
_RandomAccessIterator __gnu_cxx::random_sample | ( | _InputIterator | __first, | |
_InputIterator | __last, | |||
_RandomAccessIterator | __out_first, | |||
_RandomAccessIterator | __out_last | |||
) | [inline] |
This is an SGI extension.
Definition at line 389 of file ext/algorithm.
References __glibcxx_function_requires, __glibcxx_requires_valid_range, and __gnu_cxx::__random_sample().
_OutputIterator __gnu_cxx::random_sample_n | ( | _ForwardIterator | __first, | |
_ForwardIterator | __last, | |||
_OutputIterator | __out, | |||
const _Distance | __n, | |||
_RandomNumberGenerator & | __rand | |||
) |
This is an SGI extension.
Definition at line 302 of file ext/algorithm.
References __glibcxx_function_requires, __glibcxx_requires_valid_range, std::distance(), and std::min().
_OutputIterator __gnu_cxx::random_sample_n | ( | _ForwardIterator | __first, | |
_ForwardIterator | __last, | |||
_OutputIterator | __out, | |||
const _Distance | __n | |||
) |
This is an SGI extension.
Definition at line 268 of file ext/algorithm.
References __glibcxx_function_requires, __glibcxx_requires_valid_range, std::distance(), and std::min().
pair<_InputIter, _ForwardIter> __gnu_cxx::uninitialized_copy_n | ( | _InputIter | __first, | |
_Size | __count, | |||
_ForwardIter | __result | |||
) | [inline] |
Copies the range [first,last) into result.
first | An input iterator. | |
last | An input iterator. | |
result | An output iterator. |
Definition at line 125 of file ext/memory.
References std::__iterator_category(), and __gnu_cxx::__uninitialized_copy_n().
Referenced by __gnu_cxx::__uninitialized_copy_n_a(), __gnu_cxx::rope< _CharT, _Alloc >::_S_destr_leaf_concat_char_iter(), and __gnu_cxx::_Rope_RopeSubstring< _CharT, _Alloc >::operator()().