3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is part of the SourceMod/SourcePawn SDK. This file may only be used
8 * or modified under the Terms and Conditions of its License Agreement, which is found
9 * in LICENSE.txt. The Terms and Conditions for making SourceMod extensions/plugins
10 * may change at any time. To view the latest information, see:
11 * http://www.sourcemod.net/license.php
16 #if defined _float_included
19 #define _float_included
23 * All the trigonometric functions take in or return its values in RADIANS.
24 * Use DegToRad or RadToDeg stocks to convert the radix units.
27 /* Different methods of rounding */
28 enum floatround_method
37 * Converts an integer into a floating point value.
39 * @param value Integer to convert.
40 * @return Floating point value.
42 native Float:float(value);
45 * Multiplies two floats together.
47 * @param oper1 First value.
48 * @param oper2 Second value.
49 * @return oper1*oper2.
51 native Float:FloatMul(Float:oper1, Float:oper2);
54 * Divides the dividend by the divisor.
56 * @param dividend First value.
57 * @param divisor Second value.
58 * @return dividend/divisor.
60 native Float:FloatDiv(Float:dividend, Float:divisor);
63 * Adds two floats together.
65 * @param oper1 First value.
66 * @param oper2 Second value.
67 * @return oper1+oper2.
69 native Float:FloatAdd(Float:oper1, Float:oper2);
72 * Subtracts oper2 from oper1.
74 * @param oper1 First value.
75 * @param oper2 Second value.
76 * @return oper1-oper2.
78 native Float:FloatSub(Float:oper1, Float:oper2);
81 * Returns the decimal part of a float.
83 * @param value Input value.
84 * @return Decimal part.
86 native Float:FloatFraction(Float:value);
89 * Rounds a float into an integer number.
91 * @param value Input value to be rounded.
92 * @param method Rounding method to use.
93 * @return Rounded value.
95 native FloatRound(Float:value, floatround_method:method=floatround_round);
98 * Compares two floats.
100 * @param fOne First value.
101 * @param fTwo Second value.
102 * @return Returns 1 if the first argument is greater than the second argument.
103 * Returns -1 if the first argument is smaller than the second argument.
104 * Returns 0 if both arguments are equal.
106 native FloatCompare(Float:fOne, Float:fTwo);
109 * Returns the square root of the input value, equivalent to floatpower(value, 0.5).
111 * @param value Input value.
112 * @return Square root of the value.
114 native Float:SquareRoot(Float:value);
117 * Returns the value raised to the power of the exponent.
119 * @param value Value to be raised.
120 * @param exponent Value to raise the base.
121 * @return value^exponent.
123 native Float:Pow(Float:value, Float:exponent);
126 * Returns the value of raising the input by e.
128 * @param value Input value.
129 * @return exp(value).
131 native Float:Exponential(Float:value);
134 * Returns the logarithm of any base specified.
136 * @param value Input value.
137 * @param base Logarithm base to use, default is 10.
138 * @return log(value)/log(base).
140 native Float:Logarithm(Float:value, Float:base=10.0);
143 * Returns the sine of the argument.
145 * @param value Input value in radians.
146 * @return sin(value).
148 native Float:Sine(Float:value);
151 * Returns the cosine of the argument.
153 * @param value Input value in radians.
154 * @return cos(value).
156 native Float:Cosine(Float:value);
159 * Returns the tangent of the argument.
161 * @param value Input value in radians.
162 * @return tan(value).
164 native Float:Tangent(Float:value);
167 * Returns the absolute value.
169 * @param value Input value.
170 * @return abs(value).
172 native Float:FloatAbs(Float:value);
175 * Returns the arctangent of the input value.
177 * @param angle Input value.
178 * @return atan(value) in radians.
180 native Float:ArcTangent(Float:angle);
183 * Returns the arccosine of the input value.
185 * @param angle Input value.
186 * @return acos(value) in radians.
188 native Float:ArcCosine(Float:angle);
191 * Returns the arcsine of the input value.
193 * @param angle Input value.
194 * @return asin(value) in radians.
196 native Float:ArcSine(Float:angle);
199 * Returns the arctangent2 of the input values.
201 * @param x Horizontal value.
202 * @param y Vertical value.
203 * @return atan2(value) in radians.
205 native Float:ArcTangent2(Float:x, Float:y);
208 * User defined operators.
211 #pragma rational Float
213 native Float:operator*(Float:oper1, Float:oper2) = FloatMul;
214 native Float:operator/(Float:oper1, Float:oper2) = FloatDiv;
215 native Float:operator+(Float:oper1, Float:oper2) = FloatAdd;
216 native Float:operator-(Float:oper1, Float:oper2) = FloatSub;
218 stock Float:operator++(Float:oper)
221 stock Float:operator--(Float:oper)
224 stock Float:operator-(Float:oper)
225 return oper^Float:((-1)^((-1)/2)); /* IEEE values are sign/magnitude */
227 stock Float:operator*(Float:oper1, oper2)
228 return FloatMul(oper1, float(oper2)); /* "*" is commutative */
230 stock Float:operator/(Float:oper1, oper2)
231 return FloatDiv(oper1, float(oper2));
233 stock Float:operator/(oper1, Float:oper2)
234 return FloatDiv(float(oper1), oper2);
236 stock Float:operator+(Float:oper1, oper2)
237 return FloatAdd(oper1, float(oper2)); /* "+" is commutative */
239 stock Float:operator-(Float:oper1, oper2)
240 return FloatSub(oper1, float(oper2));
242 stock Float:operator-(oper1, Float:oper2)
243 return FloatSub(float(oper1), oper2);
245 stock bool:operator==(Float:oper1, Float:oper2)
246 return FloatCompare(oper1, oper2) == 0;
248 stock bool:operator==(Float:oper1, oper2)
249 return FloatCompare(oper1, float(oper2)) == 0; /* "==" is commutative */
251 stock bool:operator!=(Float:oper1, Float:oper2)
252 return FloatCompare(oper1, oper2) != 0;
254 stock bool:operator!=(Float:oper1, oper2)
255 return FloatCompare(oper1, float(oper2)) != 0; /* "==" is commutative */
257 stock bool:operator>(Float:oper1, Float:oper2)
258 return FloatCompare(oper1, oper2) > 0;
260 stock bool:operator>(Float:oper1, oper2)
261 return FloatCompare(oper1, float(oper2)) > 0;
263 stock bool:operator>(oper1, Float:oper2)
264 return FloatCompare(float(oper1), oper2) > 0;
266 stock bool:operator>=(Float:oper1, Float:oper2)
267 return FloatCompare(oper1, oper2) >= 0;
269 stock bool:operator>=(Float:oper1, oper2)
270 return FloatCompare(oper1, float(oper2)) >= 0;
272 stock bool:operator>=(oper1, Float:oper2)
273 return FloatCompare(float(oper1), oper2) >= 0;
275 stock bool:operator<(Float:oper1, Float:oper2)
276 return FloatCompare(oper1, oper2) < 0;
278 stock bool:operator<(Float:oper1, oper2)
279 return FloatCompare(oper1, float(oper2)) < 0;
281 stock bool:operator<(oper1, Float:oper2)
282 return FloatCompare(float(oper1), oper2) < 0;
284 stock bool:operator<=(Float:oper1, Float:oper2)
285 return FloatCompare(oper1, oper2) <= 0;
287 stock bool:operator<=(Float:oper1, oper2)
288 return FloatCompare(oper1, float(oper2)) <= 0;
290 stock bool:operator<=(oper1, Float:oper2)
291 return FloatCompare(float(oper1), oper2) <= 0;
293 stock bool:operator!(Float:oper)
294 return (_:oper & ((-1)/2)) == 0; /* -1 = all bits to 1; /2 = remove most significant bit (sign)
295 works on both 32bit and 64bit systems; no constant required */
298 * Forbidden operators.
301 forward operator%(Float:oper1, Float:oper2);
302 forward operator%(Float:oper1, oper2);
303 forward operator%(oper1, Float:oper2);
305 #define FLOAT_PI 3.1415926535897932384626433832795
307 stock Float:DegToRad(Float:angle)
309 return (angle*FLOAT_PI)/180;
312 stock Float:RadToDeg(Float:angle)
314 return (angle*180)/FLOAT_PI;