1 //=================================================================================================
2 /*!
3 // \file blaze/math/shims/NextMultiple.h
4 // \brief Header file for the nextMultiple shim
5 //
6 // Copyright (C) 2012-2020 Klaus Iglberger - All Rights Reserved
7 //
8 // This file is part of the Blaze library. You can redistribute it and/or modify it under
9 // the terms of the New (Revised) BSD License. Redistribution and use in source and binary
10 // forms, with or without modification, are permitted provided that the following conditions
11 // are met:
12 //
13 // 1. Redistributions of source code must retain the above copyright notice, this list of
14 // conditions and the following disclaimer.
15 // 2. Redistributions in binary form must reproduce the above copyright notice, this list
16 // of conditions and the following disclaimer in the documentation and/or other materials
17 // provided with the distribution.
18 // 3. Neither the names of the Blaze development group nor the names of its contributors
19 // may be used to endorse or promote products derived from this software without specific
20 // prior written permission.
21 //
22 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 // SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
27 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28 // BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 */
33 //=================================================================================================
34
35 #ifndef _BLAZE_MATH_SHIMS_NEXTMULTIPLE_H_
36 #define _BLAZE_MATH_SHIMS_NEXTMULTIPLE_H_
37
38
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42
43 #include <blaze/system/Inline.h>
44
45
46 namespace blaze {
47
48 //=================================================================================================
49 //
50 // NEXTMULTIPLE SHIM
51 //
52 //=================================================================================================
53
54 //*************************************************************************************************
55 /*!\brief Rounds up an integral value to the next multiple of a given factor.
56 // \ingroup math
57 //
58 // \param value The integral value to be rounded up \f$[1..\infty)\f$.
59 // \param factor The factor of the multiple \f$[1..\infty)\f$.
60 // \return The next multiple of the given factor.
61 //
62 // This function rounds up the given integral value to the next multiple of the given integral
63 // factor. In case the integral value is already a multiple of the given factor, the value itself
64 // is returned. Note that the attempt to use the function with non-integral types results in a
65 // compilation error!
66 */
67 template< typename T1, typename T2 >
nextMultiple(T1 value,T2 factor)68 BLAZE_ALWAYS_INLINE constexpr auto nextMultiple( T1 value, T2 factor ) noexcept
69 {
70 return ( value + ( factor - ( value % factor ) ) % factor );
71 }
72 //*************************************************************************************************
73
74 } // namespace blaze
75
76 #endif
77