vector_gen.h 6.38 KB
Newer Older
Pierre Kraemer's avatar
Pierre Kraemer committed
1 2 3
/*******************************************************************************
 * CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
 * version 0.1                                                                  *
4
 * Copyright (C) 2009-2011, IGG Team, LSIIT, University of Strasbourg           *
Pierre Kraemer's avatar
Pierre Kraemer committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *                                                                              *
 * This library is free software; you can redistribute it and/or modify it      *
 * under the terms of the GNU Lesser General Public License as published by the *
 * Free Software Foundation; either version 2.1 of the License, or (at your     *
 * option) any later version.                                                   *
 *                                                                              *
 * This library 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 Lesser General Public License  *
 * for more details.                                                            *
 *                                                                              *
 * You should have received a copy of the GNU Lesser General Public License     *
 * along with this library; if not, write to the Free Software Foundation,      *
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.           *
 *                                                                              *
20
 * Web site: http://cgogn.u-strasbg.fr/                                         *
Pierre Kraemer's avatar
Pierre Kraemer committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
 * Contact information: cgogn@unistra.fr                                        *
 *                                                                              *
 *******************************************************************************/

#ifndef __VECTOR_GEN__
#define __VECTOR_GEN__

#include <cassert>
#include <iostream>
#include <math.h>
#include <string.h>

#include "Utils/static_assert.h"
#include "Utils/nameTypes.h"

namespace CGoGN
{

namespace Geom
{

/*
 * Class for the representation of vectors
 */
template <unsigned int DIM, typename T>
class Vector
{
public:
	typedef T DATA_TYPE ;
	enum { DIMENSION = DIM } ;

	static std::string CGoGNnameOfType() ;

	/**********************************************/
	/*                CONSTRUCTORS                */
	/**********************************************/

	Vector() ;

	Vector(const Vector<DIM,T>& v) ;

62 63 64
	template <typename T2>
	Vector(const Vector<DIM,T2>& v) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
	Vector(T x, T y) ;

	Vector(T x, T y, T z) ;

	Vector(T x, T y, T z, T w) ;

	/**
	 * constructor that initialize all component to a given value
	 * @param x the value to assign to all component
	 */
	Vector(T x) ;

	void set(T a) ;

	void zero() ;

	/**********************************************/
	/*                 ACCESSORS                  */
	/**********************************************/

	T& operator[](unsigned int index) ;

	const T& operator[](unsigned int index) const ;

	unsigned int dimension() const ;

	T* data() ;

	const T* data() const ;

	/**********************************************/
	/*         ARITHMETIC SELF-OPERATORS          */
	/**********************************************/

	Vector<DIM,T>& operator+=(const Vector<DIM,T>& v) ;

	Vector<DIM,T>& operator-=(const Vector<DIM,T>& v) ;

	Vector<DIM,T> operator*=(T a) ;

	Vector<DIM,T> operator/=(T a) ;

	/**********************************************/
	/*            ARITHMETIC OPERATORS            */
	/**********************************************/

	Vector<DIM,T> operator+(const Vector<DIM,T>& v) const ;

	Vector<DIM,T> operator-(const Vector<DIM,T>& v) const ;

	Vector<DIM,T> operator*(T a) const ;

	Vector<DIM,T> operator/(T a) const ;

	/**********************************************/
	/*             UTILITY FUNCTIONS              */
	/**********************************************/

	T norm2() const ;

	double norm() const ;

	double normalize() ;

	// dot product
	T operator*(const Vector<DIM,T> v) const ;

	// cross product
	Vector<DIM,T> operator^(const Vector<DIM,T> v) const ;

	// Equal
	bool operator==(const Vector<DIM,T>& v) const ;

Pierre Kraemer's avatar
Pierre Kraemer committed
138 139 140
	// Different
	bool operator!=(const Vector<DIM,T>& v) const ;

Pierre Kraemer's avatar
Pierre Kraemer committed
141 142
	bool hasNan() const ;

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
	/**
	 * Tests if the vector is normalized
	 * @param epsilon tolerated error
	 * @return true if the given vector has a unit norm +/- epsilon
	 */
	bool isNormalized(const T& epsilon) const ;

	/**
	 * Tests if current and given vectors are orthogonal
	 * @param V a vector
	 * @param epsilon tolerated error
	 * @return true if orthogonal
	 */
	bool isOrthogonal(const Vector<DIM,T>& V, const T& epsilon = 1e-5) const ;


Pierre Kraemer's avatar
Pierre Kraemer committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
	/**********************************************/
	/*             STREAM OPERATORS               */
	/**********************************************/

	template <unsigned int DD, typename TT>
	friend std::ostream& operator<< (std::ostream& out, const Vector<DD,TT>& v) ;

	template <unsigned int DD, typename TT>
	friend std::istream& operator>> (std::istream& in, Vector<DD,TT>& v) ;

private:
	T m_data[DIM] ;
};


template <unsigned int DIM, typename T>
Vector<DIM,T> operator*(T a, const Vector<DIM,T>& v) ;

template <unsigned int DIM, typename T>
Vector<DIM,T> operator/(T a, const Vector<DIM,T>& v) ;

// returns the signed volume of the parallelepiped spanned by vectors v1, v2 and v3
template <unsigned int DIM, typename T>
T tripleProduct(const Vector<DIM,T>& v1, const Vector<DIM,T>& v2, const Vector<DIM,T>& v3) ;

// returns a spherical interpolation of two vectors considering parameter t ((0 <= t <= 1) => result between v1 and v2)
template <unsigned int DIM, typename T>
Vector<DIM,T> slerp(const Vector<DIM,T> &v1, const Vector<DIM,T> &v2, const T &t) ;

/**********************************************/
/*           SOME USEFUL TYPEDEFS             */
/**********************************************/

typedef Vector<2,float> Vec2f ;
typedef Vector<2,double> Vec2d ;
typedef Vector<2,unsigned int> Vec2ui ;
typedef Vector<2,int> Vec2i ;
typedef Vector<2,unsigned char> Vec2uc ;

typedef Vector<3,float> Vec3f ;
typedef Vector<3,double> Vec3d ;
typedef Vector<3,unsigned int> Vec3ui ;
typedef Vector<3,int> Vec3i ;
typedef Vector<3,unsigned char> Vec3uc ;

typedef Vector<4,float> Vec4f ;
typedef Vector<4,double> Vec4d ;
typedef Vector<4,unsigned int> Vec4ui ;
typedef Vector<4,int> Vec4i ;
typedef Vector<4,unsigned char> Vec4uc ;

}

}

#include "vector_gen.hpp"

#endif