Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/utility/functional/multiplies"

From cppreference.com
< cpp‎ | utility‎ | functional
m (Text replace - "/sidebar" to "/navbar")
m (~)
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{cpp/title|multiplies}}
 
{{cpp/title|multiplies}}
 
{{cpp/utility/functional/navbar}}
 
{{cpp/utility/functional/navbar}}
{{ddcl list begin}}
+
{{dcl begin}}
{{ddcl list header | functional }}
+
{{dcl header|functional}}
{{ddcl list item |
+
{{dcl rev begin}}
 +
{{dcl|until=c++14|
 
template< class T >
 
template< class T >
 
struct multiplies;
 
struct multiplies;
 
}}
 
}}
{{ddcl list end}}
+
{{dcl|since=c++14|
 +
template< class T {{=}} void >
 +
struct multiplies;
 +
}}
 +
{{dcl rev end}}
 +
{{dcl end}}
  
Function object for performing multiplication. Effectively calls {{c|operator*}} on type {{tt|T}}.
+
Function object for performing multiplication. Effectively calls {{c|operator*}} on two instances of type {{tt|T}}.
  
===Member types===
+
===Specializations===
{{dcl list begin}}
+
{{rev begin}}
{{dcl list hitem | Type | Definition }}
+
{{rev|since=c++14|
{{dcl list item | {{tt|result_type}} | {{tt|T}}}}
+
The standard library provides a specialization of {{tt|std::multiplies}} when {{tt|T}} is not specified, which leaves the parameter types and return type to be deduced.
{{dcl list item | {{tt|first_argument_type}} | {{tt|T}} }}
+
{{dsc begin}}
{{dcl list item | {{tt|second_argument_type}} | {{tt|T}} }}
+
{{dsc inc|cpp/utility/functional/dsc multiplies_void}}
{{dcl list end}}
+
{{dsc end}}
 +
}}
 +
{{rev end}}
 +
 
 +
{{cpp/utility/functional/member types|result=T|arg1=T|arg2=T}}
  
 
===Member functions===
 
===Member functions===
{{dcl list begin}}
+
{{dsc begin}}
{{dcl list mem fun | operator() | nolink=true | returns the product of two arguments}}
+
{{dsc mem fun|operator()|nolink=true|returns the product of two arguments}}
{{dcl list end}}
+
{{dsc end}}
  
{{member | {{small|std::multiplies::}}operator() | 2=
+
{{member|{{small|std::multiplies::}}operator()|2=
{{ddcl | 1=
+
{{dcl begin}}
 +
{{dcla|constexpr=c++14|1=
 
T operator()( const T& lhs, const T& rhs ) const;
 
T operator()( const T& lhs, const T& rhs ) const;
 
}}
 
}}
 +
{{dcl end}}
  
Returns the product of {{tt|lhs}} and {{tt|rhs}}.
+
Returns the product of {{c|lhs}} and {{c|rhs}}.
  
 
===Parameters===
 
===Parameters===
{{param list begin}}
+
{{par begin}}
{{param list item | lhs, rhs | values to multiply}}
+
{{par|lhs, rhs|values to multiply}}
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
 
The result of {{c|lhs * rhs}}.
 
The result of {{c|lhs * rhs}}.
  
===Exceptions===
+
{{cpp/impldef exception}}
(none)
+
  
 
===Possible implementation===
 
===Possible implementation===
{{eq fun cpp | 1=
+
{{eq fun|1=
T operator()(const T &lhs, const T &rhs) const  
+
constexpr T operator()(const T& lhs, const T& rhs) const  
 
{
 
{
 
     return lhs * rhs;
 
     return lhs * rhs;
Line 50: Line 61:
 
}}
 
}}
 
}}
 
}}
 +
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 21:07, 13 July 2024

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Function objects
Function invocation
(C++17)(C++23)
Identity function object
(C++20)
Transparent operator wrappers
(C++14)
(C++14)
(C++14)
(C++14)  
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)

Old binders and adaptors
(until C++17*)
(until C++17*)
(until C++17*)
(until C++17*)  
(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
(until C++17*)(until C++17*)
(until C++17*)(until C++17*)

(until C++17*)
(until C++17*)(until C++17*)(until C++17*)(until C++17*)
(until C++20*)
(until C++20*)
 
Defined in header <functional>
template< class T >
struct multiplies;
(until C++14)
template< class T = void >
struct multiplies;
(since C++14)

Function object for performing multiplication. Effectively calls operator* on two instances of type T.

Contents

[edit] Specializations

The standard library provides a specialization of std::multiplies when T is not specified, which leaves the parameter types and return type to be deduced.

function object implementing x * y deducing parameter and return types
(class template specialization) [edit]
(since C++14)

[edit] Member types

Type Definition
result_type (deprecated in C++17)(removed in C++20) T
first_argument_type (deprecated in C++17)(removed in C++20) T
second_argument_type (deprecated in C++17)(removed in C++20) T

These member types are obtained via publicly inheriting std::binary_function<T, T, T>.

(until C++11)

[edit] Member functions

operator()
returns the product of two arguments
(public member function)

std::multiplies::operator()

T operator()( const T& lhs, const T& rhs ) const;
(constexpr since C++14)

Returns the product of lhs and rhs.

Parameters

lhs, rhs - values to multiply

Return value

The result of lhs * rhs.

[edit] Exceptions

May throw implementation-defined exceptions.

Possible implementation

constexpr T operator()(const T& lhs, const T& rhs) const 
{
    return lhs * rhs;
}