new classes; yajl library

[chaz/yoink] / src / math.hh

diff --git a/src/math.hh b/src/math.hh
new file mode 100644 (file)
index 0000000..78f4efd
--- /dev/null
+++ b/src/math.hh
@@ -0,0 +1,66 @@
+
+/*******************************************************************************
+
+ Copyright (c) 2009, Charles McGarvey
+ All rights reserved.
+ 
+ Redistribution   and   use  in  source  and  binary  forms,  with  or  without
+ modification, are permitted provided that the following conditions are met:
+ 
+   * Redistributions  of  source  code  must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+   * Redistributions  in binary form must reproduce the above copyright notice,
+     this  list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+ 
+ THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+*******************************************************************************/
+
+/**
+ * @file math.hh
+ * General math-related types and functions.
+ */
+
+#ifndef _MATH_HH_
+#define _MATH_HH_
+
+#include <cmath>
+
+
+namespace dc {
+
+
+typedef double scalar;         ///< Scalar variable.
+
+
+// Here's a simple way to check the equality of floating-point variables more
+// reliably using approximation.
+
+const scalar default_epsilon = 0.00001;                ///< @see equals()
+
+
+/**
+ * Check the equality of scalars with a certain degree of error allowed.
+ */
+
+inline bool equals(scalar a, scalar b, scalar epsilon = default_epsilon)
+{
+       return std::abs(a - b) < epsilon;
+}
+
+
+} // namespace dc
+
+
+#endif // _MATH_HH_
+