The MPL Reference Manual: bitor_

Front Page / Metafunctions / Bitwise Operations / bitor_

# bitor_

### Synopsis

    template<
          typename T1
        , typename T2
        , typename T3 = unspecified
        ...
        , typename Tn = unspecified
        >
    struct bitor_
    {
        typedef unspecified type;
    };

### Description

Returns the result of bitwise or (`|`) operation of its arguments.

### Header

    #include <boost/mpl/bitor.hpp>
    #include <boost/mpl/bitwise.hpp>

### Model of

Numeric Metafunction

### Parameters

Parameter | Requirement | Description
--- | --- | ---
`T1`, `T2`,... `Tn` | Integral Constant | Operation'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 c1,c2,... cn:

    typedef bitor_<c1,...cn>::type r;

Return type: | Integral Constant.
Semantics: | Equivalent to
    typedef integral_c<
          typeof(c1::value | c2::value)
        , ( c1::value | c2::value )
        > c;

    typedef bitor_<c,c3,...cn>::type r;

    typedef bitor_<c1,...cn> r;

Return type: | Integral Constant.
Semantics: | Equivalent to
    struct r : bitor_<c1,...cn>::type {};

### Complexity

Amortized constant time.

### Example

    typedef integral_c<unsigned,0> u0;
    typedef integral_c<unsigned,1> u1;
    typedef integral_c<unsigned,2> u2;
    typedef integral_c<unsigned,8> u8;
    typedef integral_c<unsigned,0xffffffff> uffffffff;

    BOOST_MPL_ASSERT_RELATION( (bitor_<u0,u0>::value), ==, 0 );
    BOOST_MPL_ASSERT_RELATION( (bitor_<u1,u0>::value), ==, 1 );
    BOOST_MPL_ASSERT_RELATION( (bitor_<u0,u1>::value), ==, 1 );
    BOOST_MPL_ASSERT_RELATION( (bitor_<u0,uffffffff>::value), ==, 0xffffffff );
    BOOST_MPL_ASSERT_RELATION( (bitor_<u1,uffffffff>::value), ==, 0xffffffff );
    BOOST_MPL_ASSERT_RELATION( (bitor_<u8,uffffffff>::value), ==, 0xffffffff );

### See also

Bitwise Operations, Numeric Metafunction, numeric_cast, bitand_, bitxor_, shift_left