std::multiplies (3) - Linux Manuals

std::multiplies: std::multiplies

NAME

std::multiplies - std::multiplies

Synopsis


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


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

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 argument and return types (since C++14)
multiplies<void> (class template specialization)

Member types


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

Member functions


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


 std::multiplies::operator()


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


Returns the product of lhs and rhs.

Parameters


lhs, rhs - values to multiply

Return value


The result of lhs * rhs.

Exceptions


(none)

Possible implementation


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