vec3.h

Go to the documentation of this file.

/*
 * Author: Steven Ludtke, 04/10/2003 (sludtke@bcm.edu)
 * Copyright (c) 2000-2006 Baylor College of Medicine
 *
 * This software is issued under a joint BSD/GNU license. You may use the
 * source code in this file under either license. However, note that the
 * complete EMAN2 and SPARX software packages have some GPL dependencies,
 * so you are responsible for compliance with the licenses of these packages
 * if you opt to use BSD licensing. The warranty disclaimer below holds
 * in either instance.
 *
 * This complete copyright notice must be included in any revised version of the
 * source code. Additional authorship citations may be added, but existing
 * author citations must be preserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * */

#ifndef eman__vec3_h__
#define eman__vec3_h__ 1

#include <vector>
using std::vector;

#include <cmath>

#include <iostream>
using std::cout;
using std::endl;

namespace EMAN
{

        template<typename Type>
        class Vec3
        {
                public:
                typedef Type type;

                Vec3() /*: vec[0](0),vec[1](0),vec[2](0)*/ {

                        vec[0] = static_cast<Type>(0);
                        vec[1] = static_cast<Type>(0);
                        vec[2] = static_cast<Type>(0);
                }

                template<typename Type2, typename Type3, typename Type4>
                Vec3(const Type2& x, const Type3& y, const Type4& z = 0)
                {
                        vec[0] = static_cast<Type>(x);
                        vec[1] = static_cast<Type>(y);
                        vec[2] = static_cast<Type>(z);
                }

                template<typename Type2>
                Vec3(const vector < Type2 > &v)
                {
                        vec[0] = static_cast<Type>(v[0]);
                        vec[1] = static_cast<Type>(v[1]);
                        vec[2] = static_cast<Type>(v[2]);
                }

                template<typename Type2>
                Vec3(const Vec3<Type2> &v)
                {
                        vec[0] = v[0];
                        vec[1] = v[1];
                        vec[2] = v[2];
                }

                ~Vec3() {}


                float normalize()
                {
                        // Warning - float precision
                        float len = length();
                        if (len != 0) {
                                vec[0] = static_cast<Type> (vec[0] / len);
                                vec[1] = static_cast<Type> (vec[1] / len);
                                vec[2] = static_cast<Type> (vec[2] / len);
                        }
                        else {
                                set_value(0, 0, 0);
                        }
                        return len;
                }


                float length() const
                {
                        float t = (float)(vec[0] * vec[0] + vec[1] * vec[1] + vec[2] * vec[2]);
                        return (float)sqrt(t);
                }

                Type squared_length() const
                {
                        return  vec[0] * vec[0] + vec[1] * vec[1] + vec[2] * vec[2] ;
                }

                template<typename Type2>
                Type dot(const Vec3<Type2> & v) const
                {
                        return static_cast<Type>((vec[0] * v[0] + vec[1] * v[1] + vec[2] * v[2]));
                }

                template<typename Type2>
                Vec3<Type> cross(const Vec3<Type2>  & v) const
                {
                        return Vec3<Type>((vec[1] * v[2] - vec[2] * v[1]),
                                                  (vec[2] * v[0] - vec[0] * v[2]),
                                                   (vec[0] * v[1] - vec[1] * v[0]));
                }

                vector<Type> as_list() const
                {
                        vector < Type > v(3);
                        v[0] = vec[0];
                        v[1] = vec[1];
                        v[2] = vec[2];
                        return v;
                }

                template<typename Type2>
                void set_value(const vector < Type2 > &v)
                {
                        vec[0] =  static_cast<Type>(v[0]);
                        vec[1] =  static_cast<Type>(v[1]);
                        vec[2] =  static_cast<Type>(v[2]);
                }

                template<typename Type2>
                void set_value_at(int index, const Type2& value)
                {
                        vec[index] = static_cast<Type>(value);
                }

                void set_value(const Type& x, const Type& y,  const Type& z)
                {
                        vec[0] =  x;
                        vec[1] =  y;
                        vec[2] =  z;
                }

                inline Type operator[] (int i) const
                {
                        return vec[i];
                }

                inline Type& operator[] (int i)
                {
                        return vec[i];
                }

                inline Type at(int i)
                {
                        return vec[i];
                }


                template<typename Type2>
                Vec3<Type>& operator +=(const Vec3<Type2> &v) {
                        vec[0] = static_cast<Type>(vec[0]+v[0]);
                        vec[1] = static_cast<Type>(vec[1]+v[1]);
                        vec[2] = static_cast<Type>(vec[2]+v[2]);
                        return *this;
                }

                template<typename Type2>
                Vec3<Type>  &operator +=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]+d);
                        vec[1] = static_cast<Type>(vec[1]+d);
                        vec[2] = static_cast<Type>(vec[2]+d);
                        return *this;
                }

                template<typename Type2>
                Vec3<Type>  &operator -=(const Vec3<Type2> &v) {
                        vec[0] = static_cast<Type>(vec[0]-v[0]);
                        vec[1] = static_cast<Type>(vec[1]-v[1]);
                        vec[2] = static_cast<Type>(vec[2]-v[2]);
                        return *this;
                }

                template<typename Type2>
                Vec3<Type>& operator -=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]-d);
                        vec[1] = static_cast<Type>(vec[1]-d);
                        vec[2] = static_cast<Type>(vec[2]-d);
                        return *this;
                }

                template<typename Type2>
                Vec3<Type>  &operator *=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]*d);
                        vec[1] = static_cast<Type>(vec[1]*d);
                        vec[2] = static_cast<Type>(vec[2]*d);
                        return *this;
                }

                template<typename Type2>
                Vec3<Type>  &operator /=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]/d);
                        vec[1] = static_cast<Type>(vec[1]/d);
                        vec[2] = static_cast<Type>(vec[2]/d);
                        return *this;
                }

                template<typename Type2>
                operator vector<Type2>() const {
                        vector<Type2> v(vec,vec+3);
                        return v;
                }


                private:
                        Type vec[3];
        };

        template<typename Type,typename Type2>
        inline Vec3<Type> operator +(const Vec3<Type> &v1, const Vec3<Type2> &v2)
        {

                return Vec3<Type>(static_cast<Type>(v1[0] + v2[0]), static_cast<Type>(v1[1] + v2[1]),static_cast<Type>(v1[2] + v2[2]));;
        }

        template<typename Type,typename Type2>
        inline Vec3<Type> operator +(const Vec3<Type> &v, const Type2& n)
        {
                Vec3<Type> v1(v);
                v1 += n;
                return v1;
        }

//      template<typename Type,typename Type2>
//      inline Vec3<Type> operator +(const Type2& n, const Vec3<Type> &v)
//      {
//              Vec3<Type> v1(v);
//              v1 += n;
//              return v1;
//      }

        template<typename Type,typename Type2>
        inline Vec3<Type> operator -(const Vec3<Type> &v1, const Vec3<Type2> &v2)
        {
                return Vec3<Type>(static_cast<Type>(v1[0] - v2[0]),
                                                  static_cast<Type>(v1[1] - v2[1]),
                                                  static_cast<Type>(v1[2] - v2[2]));
        }

        template<typename Type,typename Type2>
        inline Vec3<Type> operator -(const Vec3<Type> &v, const Type2& n)
        {
                Vec3<Type> v1(v);
                v1 -= n;
                return v1;
        }
        template<typename Type>
        inline Vec3<Type> operator -(const Vec3<Type> &v)
        {
                return Vec3<Type>(-v[0],-v[1],-v[2]);
        }

//      template<typename Type,typename Type2>
//      inline Vec3<Type> operator -(const Type2& n, const Vec3<Type> &v)
//      {
//              Vec3<Type> v1(v);
//              v1 -= n;
//              return v1;
//      }

        template<typename Type,typename Type2>
        inline Type operator *(const Vec3<Type> &v1, const Vec3<Type2> &v2)
        {
                return v1.dot(v2);
        }

        template<typename Type,typename Type2>
        inline Vec3<Type2> operator *(const Type& d, const Vec3<Type2> & v)
        {
                // Preserve the vector type
                Vec3<Type2> v1(v);
                v1 *= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline Vec3<Type> operator *(const Vec3<Type> & v,const Type2& d) {
                // Preserve the vector type
                Vec3<Type> v1(v);
                v1 *= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline Vec3<Type2> operator /(const Type& d, const Vec3<Type2> & v)
        {
                // Preserve the vector type
                Vec3<Type2> v1(v);
                v1 /= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline Vec3<Type> operator /(const Vec3<Type> & v,const Type2& d) {
                // Preserve the vector type
                Vec3<Type> v1(v);
                v1 /= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline bool operator ==(const Vec3<Type> &v1, const Vec3<Type2> &v2) {
                if (v1[0] == v2[0] && v1[1] == v2[1] && v1[2] == v2[2]) {
                        return true;
                }
                return false;
        }

        template<typename Type,typename Type2>
        inline bool operator !=(const Vec3<Type> &v1, const Vec3<Type2> &v2) {
                if (v1[0] != v2[0] || v1[1] != v2[1] || v1[2] != v2[2]) {
                        return true;
                }
                return false;
        }

        typedef Vec3<float> Vec3f;
        typedef Vec3<int> Vec3i;
        typedef Vec3<double> Vec3d;


        template<typename Type>
        class Vec2
        {
                public:
                typedef Type type;

                Vec2() /*: vec[0](0),vec[1](0),vec[2](0)*/ {
                        vec[0] = static_cast<Type>(0);
                        vec[1] = static_cast<Type>(0);
                }

                template<typename Type2, typename Type3>
                Vec2(const Type2& x, const Type3& y)
                {
                        vec[0] = static_cast<Type>(x);
                        vec[1] = static_cast<Type>(y);
                }

                template<typename Type2>
                Vec2(const vector < Type2 > &v)
                {
                        vec[0] = static_cast<Type>(v[0]);
                        vec[1] = static_cast<Type>(v[1]);
                }

                template<typename Type2>
                Vec2(const Vec2<Type2> &v)
                {
                        vec[0] = static_cast<Type>(v[0]);
                        vec[1] = static_cast<Type>(v[1]);
                }

                ~Vec2() {}


                float normalize()
                {
                // Warning - float precision
                        float len = length();
                        if (len != 0) {
                                vec[0] = static_cast<Type> (vec[0] / len);
                                vec[1] = static_cast<Type> (vec[1] / len);
                        }
                        else {
                                set_value(0, 0);
                        }
                        return len;
                }


                float length() const
                {
                        float t = (float)(vec[0] * vec[0] + vec[1] * vec[1]);
                        return (float)sqrt(t);
                }

                Type squared_length() const
                {
                        return  vec[0] * vec[0] + vec[1] * vec[1] ;
                }

                template<typename Type2>
                Type dot(const Vec2<Type2> & v) const
                {
                        return static_cast<Type>((vec[0] * v[0] + vec[1] * v[1]));
                }

                vector<Type> as_list() const
                {
                        vector < Type > v(2);
                        v[0] = vec[0];
                        v[1] = vec[1];
                        return v;
                }

                template<typename Type2>
                void set_value(const vector < Type2 > &v)
                {
                        vec[0] =  static_cast<Type>(v[0]);
                        vec[1] =  static_cast<Type>(v[1]);;
                }

                template<typename Type2>
                void set_value_at(int index, const Type2& value)
                {
                        vec[index] = static_cast<Type>(value);
                }

                void set_value(const Type& x, const Type& y)
                {
                        vec[0] =  x;
                        vec[1] =  y;
                }

                inline Type operator[] (int i) const { return vec[i]; }

                inline Type& operator[] (int i) { return vec[i]; }

                inline Type at(int i) { return vec[i]; }


                template<typename Type2>
                Vec2<Type>& operator +=(const Vec2<Type2> &v) {
                        vec[0] = static_cast<Type>(vec[0]+v[0]);
                        vec[1] = static_cast<Type>(vec[1]+v[1]);
                        return *this;
                }

                template<typename Type2>
                Vec2<Type>& operator +=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]+d);
                        vec[1] = static_cast<Type>(vec[1]+d);
                        return *this;
                }

                template<typename Type2>
                Vec2<Type>& operator -=(const Vec2<Type2> &v) {
                        vec[0] = static_cast<Type>(vec[0]-v[0]);
                        vec[1] = static_cast<Type>(vec[1]-v[1]);
                        return *this;
                }

                template<typename Type2>
                Vec2<Type>& operator -=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]-d);
                        vec[1] = static_cast<Type>(vec[1]-d);
                        return *this;
                }

                template<typename Type2>
                Vec2<Type>& operator *=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]*d);
                        vec[1] = static_cast<Type>(vec[1]*d);
                        return *this;
                }

                template<typename Type2>
                Vec2<Type>& operator /=(const Type2& d) {
                        vec[0] = static_cast<Type>(vec[0]/d);
                        vec[1] = static_cast<Type>(vec[1]/d);
                        return *this;
                }


                private:
                        Type vec[2];
        };

        template<typename Type,typename Type2>
        inline Vec2<Type> operator +(const Vec2<Type> &v1, const Vec2<Type2> &v2)
        {
                return Vec2<Type>(static_cast<Type>(v1[0] + v2[0]), static_cast<Type>(v1[1] + v2[1]));;
        }

        template<typename Type,typename Type2>
        inline Vec2<Type> operator +(const Vec2<Type> &v, const Type2& n)
        {
                Vec2<Type> v1(v);
                v1 += n;
                return v1;
        }

        template<typename Type,typename Type2>
        inline Vec2<Type> operator -(const Vec2<Type> &v1, const Vec2<Type2> &v2)
        {
                return Vec2<Type>(static_cast<Type>(v1[0] - v2[0]),     static_cast<Type>(v1[1] - v2[1]));
        }

        template<typename Type,typename Type2>
        inline Vec2<Type> operator -(const Vec2<Type> &v, const Type2& n)
        {
                Vec2<Type> v1(v);
                v1 -= n;
                return v1;
        }

        template<typename Type>
        inline Vec2<Type> operator -(const Vec2<Type> &v)
        {
                return Vec2<Type>(-v[0],-v[1]);
        }


        template<typename Type,typename Type2>
        inline Type operator *(const Vec2<Type> &v1, const Vec2<Type2> &v2)
        {
                return v1.dot(v2);
        }

        template<typename Type,typename Type2>
        inline Vec2<Type2> operator *(const Type& d, const Vec2<Type2> & v)
        {
                // Preserve the vector type
                Vec2<Type2> v1(v);
                v1 *= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline Vec2<Type> operator *(const Vec2<Type> & v,const Type2& d) {
        // Preserve the vector type
                Vec2<Type> v1(v);
                v1 *= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline Vec2<Type2> operator /(const Type& d, const Vec2<Type2> & v)
        {
        // Preserve the vector type
                Vec2<Type2> v1(v);
                v1 /= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline Vec2<Type> operator /(const Vec2<Type> & v,const Type2& d) {
                // Preserve the vector type
                Vec2<Type> v1(v);
                v1 /= d;
                return v1;
        }

        template<typename Type,typename Type2>
        inline bool operator ==(const Vec2<Type> &v1, const Vec2<Type2> &v2) {
                if (v1[0] == v2[0] && v1[1] == v2[1] ) {
                        return true;
                }
                return false;
        }

        template<typename Type,typename Type2>
        inline bool operator !=(const Vec2<Type> &v1, const Vec2<Type2> &v2) {
                if (v1[0] != v2[0] || v1[1] != v2[1] ) {
                        return true;
                }
                return false;
        }

        typedef Vec2<float> Vec2f;
        typedef Vec2<int> Vec2i;
        typedef Vec2<double> Vec2d;
}
#endif