Initial commit

Lib/Include/CML/mathlib/misc.h

@@ -0,0 +1,210 @@
+/* -*- C++ -*- ------------------------------------------------------------
+ 
+Copyright (c) 2007 Jesse Anders and Demian Nave http://cmldev.net/
+
+The Configurable Math Library (CML) is distributed under the terms of the
+Boost Software License, v1.0 (see cml/LICENSE for details).
+
+ *-----------------------------------------------------------------------*/
+/** @file
+ *  @brief
+ */
+
+#ifndef misc_h
+#define misc_h
+
+#include <cml/mathlib/checking.h>
+
+/* A few miscellaneous functions and helper classes.
+ *
+ * @note: This is somewhat ad-hoc and will probably all be replaced in a future
+ * version of the CML (I don't think I even bothered to document these functions
+ * on the website).
+ */
+
+namespace cml {
+
+//////////////////////////////////////////////////////////////////////////////
+// N-d functions
+//////////////////////////////////////////////////////////////////////////////
+
+/** Return an N-d zero vector */
+template < size_t N >
+vector< double, fixed<N> > zero()
+{
+    typedef vector< double, fixed<N> > vector_type;
+
+    vector_type result;
+    result.zero();
+    return result;
+}
+
+/** Return an N-d cardinal axis by index */
+template < size_t N >
+vector< double, fixed<N> > axis(size_t i)
+{
+    /* Checking */
+    detail::CheckValidArg(i < N);
+
+    typedef vector< double, fixed<N> > vector_type;
+    vector_type result;
+    result.cardinal(i);
+    return result;
+}
+
+/** Return an NxM zero matrix */
+template < size_t N, size_t M >
+matrix< double, fixed<N,M>, row_basis, row_major > zero()
+{
+    typedef matrix< double, fixed<N,M>, row_basis, row_major > matrix_type;
+
+    matrix_type result;
+    result.zero();
+    return result;
+}
+
+/** Return an NxN identity matrix */
+template < size_t N >
+matrix< double, fixed<N,N>, row_basis, row_major > identity()
+{
+    typedef matrix< double, fixed<N,N>, row_basis, row_major > matrix_type;
+
+    matrix_type result;
+    result.identity();
+    return result;
+}
+
+/** Return an NxM identity transform */
+template < size_t N, size_t M >
+matrix< double, fixed<N,M>, row_basis, row_major > identity_transform()
+{
+    typedef matrix< double, fixed<N,M>, row_basis, row_major > matrix_type;
+
+    matrix_type result;
+    identity_transform(result);
+    return result;
+}
+
+//////////////////////////////////////////////////////////////////////////////
+// Zero vector
+//////////////////////////////////////////////////////////////////////////////
+
+/** Return the 2D zero vector */
+inline vector< double, fixed<2> > zero_2D() {
+    return zero<2>();
+}
+
+/** Return the 3D zero vector */
+inline vector< double, fixed<3> > zero_3D() {
+    return zero<3>();
+}
+
+/** Return the 4D zero vector */
+inline vector< double, fixed<4> > zero_4D() {
+    return zero<4>();
+}
+
+//////////////////////////////////////////////////////////////////////////////
+// Cardinal axis
+//////////////////////////////////////////////////////////////////////////////
+
+/** Return a 2D cardinal axis by index */
+inline vector< double, fixed<2> > axis_2D(size_t i) {
+    return axis<2>(i);
+}
+
+/** Return a 3D cardinal axis by index */
+inline vector< double, fixed<3> > axis_3D(size_t i) {
+    return axis<3>(i);
+}
+
+/** Return a the 2D x cardinal axis */
+inline vector< double, fixed<2> > x_axis_2D() {
+    return axis_2D(0);
+}
+
+/** Return a the 2D y cardinal axis */
+inline vector< double, fixed<2> > y_axis_2D() {
+    return axis_2D(1);
+}
+
+/** Return a the 3D x cardinal axis */
+inline vector< double, fixed<3> > x_axis_3D() {
+    return axis_3D(0);
+}
+
+/** Return a the 3D y cardinal axis */
+inline vector< double, fixed<3> > y_axis_3D() {
+    return axis_3D(1);
+}
+
+/** Return a the 3D z cardinal axis */
+inline vector< double, fixed<3> > z_axis_3D() {
+    return axis_3D(2);
+}
+
+//////////////////////////////////////////////////////////////////////////////
+// Zero matrix
+//////////////////////////////////////////////////////////////////////////////
+
+/** Return the 2x2 zero matrix */
+inline matrix< double, fixed<2,2>, row_basis, row_major > zero_2x2() {
+    return zero<2,2>();
+}
+
+/** Return the 3x3 zero matrix */
+inline matrix< double, fixed<3,3>, row_basis, row_major > zero_3x3() {
+    return zero<3,3>();
+}
+
+/** Return the 4x4 zero matrix */
+inline matrix< double, fixed<4,4>, row_basis, row_major > zero_4x4() {
+    return zero<4,4>();
+}
+
+//////////////////////////////////////////////////////////////////////////////
+// Identity matrix
+//////////////////////////////////////////////////////////////////////////////
+
+/** Return the 2x2 identity matrix */
+inline matrix< double, fixed<2,2>, row_basis, row_major > identity_2x2() {
+    return identity<2>();
+}
+
+/** Return the 3x3 identity matrix */
+inline matrix< double, fixed<3,3>, row_basis, row_major > identity_3x3() {
+    return identity<3>();
+}
+
+/** Return the 4x4 identity matrix */
+inline matrix< double, fixed<4,4>, row_basis, row_major > identity_4x4() {
+    return identity<4>();
+}
+
+//////////////////////////////////////////////////////////////////////////////
+// Identity transform matrix
+//////////////////////////////////////////////////////////////////////////////
+
+/** Return a 3x2 identity transform */
+inline matrix< double,fixed<3,2>,row_basis,row_major > identity_transform_3x2() {
+    return identity_transform<3,2>();
+}
+
+/** Return a 2x3 identity transform */
+inline matrix< double,fixed<2,3>,col_basis,col_major > identity_transform_2x3() {
+    return identity_transform<2,3>();
+}
+
+/** Return a 4x3 identity transform */
+inline matrix< double,fixed<4,3>,row_basis,row_major > identity_transform_4x3() {
+    return identity_transform<4,3>();
+}
+
+/** Return a 3x4 identity transform */
+inline matrix< double,fixed<3,4>,col_basis,col_major > identity_transform_3x4() {
+    return identity_transform<3,4>();
+}
+
+} // namespace cml
+
+#endif