KDIS  2-8-x
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Math.h
Go to the documentation of this file.
1 /*********************************************************************
2 Copyright 2013 Karl Jones
3 All rights reserved.
4 
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are met:
7 
8 1. Redistributions of source code must retain the above copyright notice, this
9  list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright notice,
11  this list of conditions and the following disclaimer in the documentation
12  and/or other materials provided with the distribution.
13 
14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 
25 For Further Information Please Contact me at
26 Karljj1@yahoo.com
27 http://p.sf.net/kdis/UserGuide
28 *********************************************************************/
29 
30 /********************************************************************
31  Math
32  created: 07/02/2013
33  author: Karl Jones
34 
35  purpose: General math related functions
36 *********************************************************************/
37 
38 #pragma once
39 
40 #include "./../KDefines.h"
41 
42 #ifndef _USE_MATH_DEFINES
43  #define _USE_MATH_DEFINES
44 #endif
45 
46 #include <math.h>
47 
48 namespace KDIS {
49 namespace UTILS {
50 namespace Math {
51 
52 //************************************
53 // FullName: KDIS::UTILS::Math<Type>::EulerToHeadingPitchRoll
54 //!Description: Clamps a value between Min and Max.
55 // Parameter: Type Val
56 // Parameter: Type Min
57 // Parameter: Type Max
58 //************************************
59 
60 template<class Type>
61 inline Type CLamp( Type Val, Type Min, Type Max )
62 {
63  if( Val < Min )
64  {
65  return Min;
66  }
67 
68  if( Val > Max )
69  {
70  return Max );
71  }
72 
73  return Val;
74 }
75 
76 } // END namespace Math
77 } // END namespace UTILS
78 } // END namespace KDIS
Type CLamp(Type Val, Type Min, Type Max)
Description: Clamps a value between Min and Max.
Definition: Math.h:61