include/Vector3D.h

Go to the documentation of this file.

/******************************************************************************\
 * Copyright (c) 2011 Hans-Christian Ahlswede                                 *
 *                                                                            *
 * Redistribution and use in source and binary forms, with or without         *
 * modification, are permitted provided that the following conditions         *
 * are met:                                                                   *
 *                                                                            *
 *  §1 Redistributions of source code must retain the above copyright notice, *
 *     this list of conditions and the following disclaimer.                  *
 *                                                                            *
 *  §2 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.   *
 *                                                                            *
 *  §3 The name of the author may not be used to endorse or promote products  *
 *     derived from this software without specific prior written permission.  *
 *                                                                            *
 *  §4 In the following paragraphs the term ``significant modification'' will *
 *     be used, which is defined as follows from now on:                      *
 *      (1) A significant modification is the modification or extension of    *
 *          functionality of the software by modifying or extending the       *
 *          source code.                                                      *
 *      (2) A significant modification is NOT the reduction of functionality  *
 *          of the software by modifying, extending or reducing the source    *
 *          code or the binary.                                               *
 *                                                                            *
 *  §5 In case of a ``significant modification'' of the software the modifier *
 *     is allowed to append a new line below the copyright line containing    *
 *     the period of modification, his name and other personal information.   *
 *                                                                            *
 *  §6 In case of a ``significant modification'' of the software this list    *
 *     of conditions can be extended to new parapgraphs by the modifier,      *
 *     located below the latest defined paragraph, if the new paragraphs      *
 *     do not affect or modify §1, §2, §3, §4, §5, §6, all paragraphs         *
 *     listed before the new paragraphs as well as the copyright notice       *
 *     and the disclaimer.                                                    *
 *                                                                            *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.               *
\******************************************************************************/

#ifndef VECTOR3D_H
#define VECTOR3D_H


#include <math.h>       // floating point intrinsics
#include <immintrin.h>  // sse intrinsics


#ifdef __GNUC__

#define align16 __attribute__((aligned (16)))

#ifndef __forceinline
#define __forceinline __attribute__((always_inline))
#endif

#elif defined (__MSVC__)

#define align16 __declspec(align (16))

#ifndef __forceinline
#define __forceinline inline
#endif

#endif


#define VECTOR3D_DOTP_MASK 0x71  // dot product selection mask // NEEDS TO BE FIXED!
#define VECTOR3D_ROT1_MASK 0xC9  // first rotation mask
#define VECTOR3D_ROT2_MASK 0xD2  // second rotation mask


#ifdef __SSE__ // SSE enabled
typedef align16 __m128 Vector3D__;
#else // SSE disabled
typedef align16 float Vector3D__[4];
#endif



// cartesian coordinate system element access type
typedef align16 struct {
  float x;
  float y;
  float z;
  float _;
} Vector3D_v;



// cylindrical coordinate system element access type
typedef align16 struct {
  float r;
  float phi;
  float z;
  float _;
} Vector3D_c;



// spherical coordinate system element access type
typedef align16 struct {
  float r;
  float phi;
  float theta;
  float _;
} Vector3D_s;



// vector datatype
typedef align16 union {
  align16 Vector3D__ _; // sse register access (for internal use only!)
  align16 Vector3D_v v; // cartesian coordinate system element access
  align16 Vector3D_c c; // cylindrical coordinate system element access
  align16 Vector3D_s s; // spherical coordinate system element access
} Vector3D_t;



__forceinline
Vector3D_t Vector3D ();



__forceinline
Vector3D_t Vector3D (register float S0);



__forceinline
Vector3D_t Vector3D (register float x, register float y, register float z);



__forceinline
Vector3D_t Vector3DC (register float r, register float phi, register float z);



__forceinline
Vector3D_t Vector3DS (register float r, register float phi, register float theta);



__forceinline
Vector3D_t add (register Vector3D_t L0, register Vector3D_t R0);



__forceinline
void add_ (register Vector3D_t &L0, register Vector3D_t R0);



__forceinline
Vector3D_t sub (register Vector3D_t L0, register Vector3D_t R0);



__forceinline
void sub_ (register Vector3D_t &L0, register Vector3D_t R0);



__forceinline
Vector3D_t mul (register Vector3D_t L0, register float R0);



__forceinline
void mul_ (register Vector3D_t &L0, register float R0);



__forceinline
Vector3D_t div (register Vector3D_t L0, register float R0);



__forceinline
void div_ (register Vector3D_t &L0, register float R0);



__forceinline
float dot (register Vector3D_t L0, register Vector3D_t R0);



__forceinline
Vector3D_t cross (register Vector3D_t L0, register Vector3D_t R0);



__forceinline
void cross_ (register Vector3D_t &L0, register Vector3D_t R0);



__forceinline
float triple (register Vector3D_t L0, register Vector3D_t M0, register Vector3D_t R0);



__forceinline
float abs (register Vector3D_t V0);



__forceinline
float absC (register Vector3D_t V0);



__forceinline
float absS (register Vector3D_t V0);



__forceinline
Vector3D_t unit (register Vector3D_t V0);



__forceinline
void unit_ (register Vector3D_t &V0);



__forceinline
Vector3D_t unitC (register Vector3D_t V0);



__forceinline
void unitC_ (register Vector3D_t &V0);



__forceinline
Vector3D_t unitS (register Vector3D_t V0);



__forceinline
void unitS_ (register Vector3D_t &V0);



__forceinline
Vector3D_t v2c (register Vector3D_t V0);



__forceinline
void v2c_ (register Vector3D_t &V0);



__forceinline
Vector3D_t v2s (register Vector3D_t V0);



__forceinline
void v2s_ (register Vector3D_t &V0);



__forceinline
Vector3D_t c2v (register Vector3D_t V0);



__forceinline
void c2v_ (register Vector3D_t &V0);



__forceinline
Vector3D_t c2s (register Vector3D_t V0);



__forceinline
void c2s_ (register Vector3D_t &V0);



__forceinline
Vector3D_t s2v (register Vector3D_t V0);



__forceinline
void s2v_ (register Vector3D_t &V0);



__forceinline
Vector3D_t s2c (register Vector3D_t V0);



__forceinline
void s2c_ (register Vector3D_t &V0);



#include "Vector3D.hpp"
#endif