utils.h File Reference

Contains a collection of miscellaneous functions. More...

#include <stdbool.h>

Go to the source code of this file.

Macros
#define	MAX(a, b)   (a > b ? a : b)
	Quick generic macro for getting the larger number.
#define	MIN(a, b)   (a < b ? a : b)
	Quick generic macro for getting the smaller number.

Functions
int	mathClamp (int, int, int)
	Clamps a value to be constrained in a range.
int	randRange (int, int)
	Randomizes an integer from a given inclusive range.
int	mathMax (int,...)
	Returns the greatest integer provided in arguments.
int	mathMin (int,...)
	Returns the smallest integer provided in arguments.

Detailed Description

Contains a collection of miscellaneous functions.

Function Documentation

mathClamp()

int mathClamp	(	int	val,
		int	min,
		int	max )

Clamps a value to be constrained in a range.

Parameters

val	The value to clamp.
min	The minimum value that can be returned.
max	The maximum value that can be returned.

Returns

The value if it's within the specified range. Otherwise, it returns the closest range boundary.

mathMax()

int mathMax	(	int	count,
			... )

Returns the greatest integer provided in arguments.

Parameters

count	Amount of integers in the arguments.
...	Integers to compare.

Warning

This function is redundant because MAX(a,b) exists, but I'm keeping it in case I ever need an example of a function with variadic arguments.

Returns

The largest of the provided integers, excluding the count parameter.

mathMin()

int mathMin	(	int	count,
			... )

Returns the smallest integer provided in arguments.

Parameters

count	Amount of integers in the arguments.
...	Integers to compare.

Warning

This function is redundant because MIN(a,b) exists, but I'm keeping it in case I ever need an example of a function with variadic arguments.

Returns

The smallest of the provided integers, excluding the count parameter.

randRange()

int randRange	(	int	lower_inc_bound,
		int	upper_inc_bound )

Randomizes an integer from a given inclusive range.

Parameters

lower_inc_bound	Lower inclusive bound, clamped to be in range of (0, upper_inc_bound); both ends inclusive.
upper_inc_bound	Upper inclusive bound, clamped to be in range of (lower_inc_bound, RAND_MAX); both ends inclusive.

Returns

A random integer from range of (lower_inc_bound, upper_inc_bound), both ends inclusive.

Make sure you call 'srand(time(NULL))' once and before ever calling this method!