Back to Arangodb

divides

3rdParty/boost/1.78.0/libs/mpl/doc/refmanual/divides.html

3.12.9.13.3 KB
Original Source

| Prev Next | Back Along | Up Home | Full TOC | Front Page / Metafunctions / Arithmetic Operations / divides |

divides

Synopsis

template<
      typename T1
    , typename T2
    , typename T3 =_unspecified__..._, typename T_n_=_unspecified_>
struct[divides](./divides.html){
    typedef_unspecified_type;
};

Description

Returns the quotient of its arguments.

#include <[boost/mpl/divides.hpp](../../../../boost/mpl/divides.hpp)>
#include <[boost/mpl/arithmetic.hpp](../../../../boost/mpl/arithmetic.hpp)>

Model of

Numeric Metafunction

Parameters

ParameterRequirementDescription
T1, T2,... TnIntegral ConstantOperation's arguments.

[Note: The requirements listed in this specification are the ones imposed by the default implementation. See Numeric Metafunction concept for the details on how to provide an implementation for a user-defined numeric type that does not satisfy the Integral Constant requirements. — end note]

Expression semantics

For any Integral Constants _c_1,_c_2,... _c_n:

typedef[divides](./divides.html)<c1,_..._c_n_>::type r;

| Return type: |

Integral Constant.

| | Precondition: |

c2::value != 0, ... cn::value != 0.

| | Semantics: |

Equivalent to

typedef[integral\_c](./integral-c.html)<
      typeof(c1::value / c2::value)
    , ( c1::value / c2::value )
    > c;

typedef[divides](./divides.html)<c,c3,_..._c_n_>::type r;

|

typedef[divides](./divides.html)<c1,_..._c_n_> r;

| Return type: |

Integral Constant.

| | Precondition: |

c2::value != 0, ... cn::value != 0.

| | Semantics: |

Equivalent to

struct r :[divides](./divides.html)<c1,_..._c_n_>::type {};

|

Complexity

Amortized constant time.

Example

typedef[divides](./divides.html)<[int\_](./int.html)<-10>,[int\_](./int.html)<3>,[long\_](./long.html)<1> >::type r;[BOOST\_MPL\_ASSERT\_RELATION](./assert-relation.html)( r::value, ==, -3 );[BOOST\_MPL\_ASSERT](./assert.html)(( is_same< r::[value\_type](./value-type.html), long > ));

See also

Arithmetic Operations, Numeric Metafunction, numeric_cast, times, modulus, plus

| Prev Next | Back Along | Up Home | Full TOC |

Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) |