etl/docs/utilities/functional.md
John Wellbelove 4a88884b39
Issue/add hugo support for documentation (#1449)
* Add ranges

* Initial Hugo setup

* Work in progress

* Added selection for local or remote site

* Updated to 'light' theme

* Changed to using Hextra Hugo theme

* Changed to using Hextra Hugo theme

* Changed to Hextra Hugo theme

* Change to Hextra Hugo theme

* Updated Hugo setup.

* Updated Hugo setup.

# Conflicts:
#	docs/releases/_index.md

* Work in progress

* Added new fonts

Added new documentation

* Latest documentation updates

* Latest documentation updates

# Conflicts:
#	docs/containers/array.md
#	docs/containers/array_view.md
#	docs/containers/array_wrapper.md
#	docs/containers/bip_buffer_spsc_atomic.md
#	docs/containers/bitset.md
#	docs/containers/indirect_vector.md
#	docs/containers/vector.md
#	docs/getting-started/compilers.md

* Added bloom_filter markdown doc

* Added more documentation

Updated CSS for light and dark modes

* Fixed some menus

Added mode documentation files

* Updated CSS rules

Added badges to home page
Added uniqur_ptr + pool tutorial

* Fixed formatting on the home page markdown

Modified light amd dark code formatting

* Updated unique_ptr-with-pool

* Added container and shared message tutorials

* Updates to documentation

* Added const_multimap

* Updated source-formatting.md

* Added initial raw text files form Web site editor

* Innore coverage build directory

* Exported raw text documentation files from the web site editor

* Hugo updates

* Added Hugo intalation and markdown descriptions

* More addition to the documentation

* Added closure.md and updates to delegate.md

* Added format.md

* Added documentation for etl::delegate_observable, etl::function, Base64 codec

* Added io_port documentation

* Added basic_format_spec

* Added documentation for string_stream and string utilities.

* Added more documentation

Updated the documentation CSS

* Added documentation for clocks, day, duration

* Added more documentation for chrono classes

Updated callouts

* More chrono documentation

* Completed chrono documentation

* Maths functions documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Added multiple documentation files

* Added iterator.md

* Added debug_count.md and versions.md

* Added debug_count.md and versions.md

* Added more documentation

* More documentation

* Added some design pattern documentation

Modified some of the layout files
Modified the About documentation

* Converted more documentation pages

Modified the site CSS

* Added more documentation

Moced some documentation files to new directories

* Added more documentation

Tweaks to CSS

* Added callback_timer_deferred_locked documentation

* Added callback_timer_locked documentation

* More documentation updates

* More documentation updates

* More documentation updates

* New documentation files.

Harmonised file name format

* New documentation files.

* Multiple document updates

* Multiple document updates

* Final conversion of web pages

* Updates before PR

* Updates before PR

* Updates before PR

# Conflicts:
#	docs/blog/_index.md

* Final pre PR updates

* Updates to message framework documentation

* Renamed directory

* Fix spelling

* Added author and date to blog files

Moved documentation files merged from development

* Fixed 'Description' typo

* Fix typos

# Conflicts:
#	docs/IO/io_port.md
#	docs/containers/sets/const-multiset.md
#	docs/containers/sets/const-set.md
#	docs/maths/correlation.md
#	docs/maths/gamma.md

* Renamed two files to lower case

* Minor renaming

* Added author and date

* Updated callout on bresenham_line.md

Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset.
Updated the Python 'update_release.py' to copy 'version.txt'

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

# Conflicts:
#	docs/getting-started/view-the-docs-locally/hugo-commands.md

* Added a link to pseudo_moving_average.md

* Updated title pages for groups

* Fixed missing 404 for non-existent pages

* Fixed coordinate variable names in the 'Calculating the intersection' example

---------

Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
2026-06-06 13:12:44 +01:00

4.4 KiB

title
functional

{{< callout type="info">}} Header: functional.h
{{< /callout >}}

Defines functional classes from the STL.

reference_wrapper

etl::reference_wrapper is a class template that wraps a reference in a copyable, assignable object.
A clone of std::reference_wrapper.

unary_function

template <typename TArgumentType, typename TResultType>
struct unary_function

Typedefs

TArgumentType argument_type
TResultType   result_type

binary_function

template <typename TFirstArgumentType, typename TSecondArgumentType, typename TResultType>
struct binary_function

Typedefs

TFirstArgumentType  first_argument_type
TSecondArgumentType second_argument_type
TResultType         result_type

bind1st

template <typename TFunction>
class binder1st

template <typename F, typename T>
binder1st<F> bind1st(const F& f, const T& x)

Description
Binds a given argument to a first parameter of the given binary function object.

bind2nd

template <typename TFunction>
class binder2nd

template <typename F, typename T>
binder2nd<F> bind2nd(const F& f, const T& x)

Description
Binds a given argument to a second parameter of the given binary function object.

Less

template <typename T = void>
struct less

Description
A function object that performs a strictly less-than comparison a < b) between two values.


template <>
struct less<void> 

Description
A function object that performs a strictly less-than comparison a < b) between two values.
Transparent comparator.
Defines is_transparent.
From: 20.21.0

less_equal

template <typename T = void>
struct less_equal

Description
A function object that performs a strictly less-than-equal comparison a <= b) between two values.


template <>
struct less_equal<void>

Description
A function object that performs a strictly less-than-equal comparison a <= b) between two values.
Transparent comparator. Defines is_transparent. From: 20.21.0

greater

template <typename T = void>
struct greater

Description
A function object that performs a strictly greater-than comparison a > b) between two values.


template <>
struct greater<void>

Description
A function object that performs a strictly greater-than comparison a > b) between two values.
Transparent comparator.
Defines is_transparent. From: 20.21.0

greater_equal

template <typename T = void>
struct greater_equal

Description
A function object that performs a strictly greater-than-equal comparison a >= b) between two values.


template <>
struct greater_equal<void>

Description
A function object that performs a strictly greater-than-equal comparison a >= b) between two values.
Transparent comparator.
Defines is_transparent. From: 20.21.0

equal_to

template <typename T = void>
struct equal_to

Description
A function object that performs a strictly equal-to comparison a == b) between two values.


template <>
struct equal_to<void>

Description
A function object that performs a strictly equal-to comparison a == b) between two values.
Transparent comparator.
Defines is_transparent.
From: 20.21.0

not_equal_to

template <typename T = void>
struct not_equal_to

Description
A function object that performs a strictly not-equal-to comparison a !== b) between two values.


template <>
struct not_equal_to<void>

Description
A function object that performs a strictly not-equal-to comparison a !== b) between two values.
Transparent comparator.
Defines is_transparent.
From: 20.21.0

mem_fn

template <typename TReturnType, typename TClassType, typename... TArgs>
<functor> mem_fn(TReturnType(TClassType::* member_function)(TArgs...))

Description
Returns a functor that wraps a member function of TClassType, taking TArgs and returning TReturnType.
From: 20.38.11


template <typename TReturnType, typename TClassType, typename... TArgs>
<functor> mem_fn(TReturnType(TClassType::* member_function)(TArgs...) const)

Description
Returns a functor that wraps a const member function of TClassType, taking TArgs and returning TReturnType.
From: 20.38.11