max_of.hpp File Reference

Go to the source code of this file.

Functions
template<typename T >
constexpr T const &	bsl::max_of (T const &a, T const &b) noexcept
	Returns a if a is larger than b, otherwise returns b. Note that this function is called max_of to prevent a name collision with numeric_limits<>::max(). More...

Detailed Description

Copyright

Copyright (C) 2020 Assured Information Security, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Function Documentation

max_of()

template<typename T >

constexpr T const& bsl::max_of ( T const &  a, T const &  b  )

noexcept

Returns a if a is larger than b, otherwise returns b. Note that this function is called max_of to prevent a name collision with numeric_limits<>::max().

#include <bsl/max_of.hpp>
#include <bsl/debug.hpp>

namespace bsl
{
    inline void
    example_max_of_overview() noexcept
    {
        constexpr bsl::int32 val1{23};
        constexpr bsl::int32 val2{42};

        if (bsl::max_of(val1, val2) == val2) {
            bsl::print() << "success\n";
        }
    }
}

Template Parameters

T	The type that defines both a and b

Parameters

a	the first parameter to compare
b	the second parameter to compare

Returns

Returns a if a is larger than b, otherwise returns b.