summaryrefslogtreecommitdiff
path: root/lib/bound.c
blob: b1b67da4e6963c3caf5877ad39c5b2ea271317a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/**
** @file	bound.c
**
** @author	Numerous CSCI-452 classes
**
** @brief	C implementations of common library functions
*/

#ifndef BOUND_SRC_INC
#define BOUND_SRC_INC

#include <common.h>

#include <lib.h>

/**
** bound(min,value,max)
**
** This function confines an argument within specified bounds.
**
** @param min    Lower bound
** @param value  Value to be constrained
** @param max    Upper bound
**
** @return The constrained value
*/
uint32_t bound(uint32_t min, uint32_t value, uint32_t max)
{
	if (value < min) {
		value = min;
	}
	if (value > max) {
		value = max;
	}
	return value;
}

#endif