[PATCH v10 06/11] math.h: Add macros for rounding to closest value

[Andy Shevchenko]

On Thu, May 30, 2024 at 10:42:25PM +0530, Devarsh Thakkar wrote:
> Add below rounding related macros:
> 
> round_closest_up(x, y) : Rounds x to closest multiple of y where y is a
> power of 2, with a preference to round up in case two nearest values are
> possible.
> 
> round_closest_down(x, y) : Rounds x to closest multiple of y where y is a
> power of 2, with a preference to round down in case two nearest values are
> possible.
> 
> roundclosest(x, y) : Rounds x to closest multiple of y, this macro should
> generally be used only when y is not multiple of 2 as otherwise
> round_closest* macros should be used which are much faster.
> 
> Examples:
>  * round_closest_up(17, 4) = 16
>  * round_closest_up(15, 4) = 16
>  * round_closest_up(14, 4) = 16
>  * round_closest_down(17, 4) = 16
>  * round_closest_down(15, 4) = 16
>  * round_closest_down(14, 4) = 12
>  * roundclosest(21, 5) = 20
>  * roundclosest(19, 5) = 20
>  * roundclosest(17, 5) = 15

...

> + * Examples :

It's inconsistent with the other one below.

> + * 	round_closest_up(17, 4) = 16
> + *
> + * 	round_closest_up(15, 4) = 16
> + *
> + * 	round_closest_up(14, 4) = 16

The three have TABs/spaces mixture.

I believe you wanted:

 * Examples::
 * * round_closest_up(17, 4) = 16
 * * round_closest_up(15, 4) = 16
 * * round_closest_up(14, 4) = 16

...

> + * Examples:
> + *
> + * 	round_closest_down(17, 4) = 16
> + *
> + * 	round_closest_down(15, 4) = 16
> + *
> + * 	round_closest_down(14, 4) = 12

As per above

...

> + * Examples :
> + *
> + * 	roundclosest(21, 5) = 20
> + *
> + * 	roundclosest(19, 5) = 20
> + *
> + * 	roundclosest(17, 5) = 15

As per above.

-- 
With Best Regards,
Andy Shevchenko