From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/class_NLMISC__CVectorD.html | 1350 ++++++++++++++++++++++++++ 1 file changed, 1350 insertions(+) create mode 100644 docs/doxygen/nel/class_NLMISC__CVectorD.html (limited to 'docs/doxygen/nel/class_NLMISC__CVectorD.html') diff --git a/docs/doxygen/nel/class_NLMISC__CVectorD.html b/docs/doxygen/nel/class_NLMISC__CVectorD.html new file mode 100644 index 00000000..ff4ac99f --- /dev/null +++ b/docs/doxygen/nel/class_NLMISC__CVectorD.html @@ -0,0 +1,1350 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NLMISC::CVectorD Class Reference

A 3D vector of double. +More... +

+#include <vectord.h> +

+Collaboration diagram for NLMISC::CVectorD:

Collaboration graph
+ + +
[legend]
List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

Object.
 CVectorD ()
 Constructor wich do nothing. More...

 CVectorD (double _x, double _y, double _z)
 Constructor . More...

 CVectorD (const CVector &v)
 Constructor with a CVector. More...

 CVectorD (const CVectorD &v)
 Copy Constructor. More...

Base Maths.
CVectorD& operator+= (const CVectorD &v)
CVectorD& operator-= (const CVectorD &v)
CVectorD& operator *= (double f)
CVectorD& operator/= (double f)
CVectorD operator+ (const CVectorD &v) const
CVectorD operator- (const CVectorD &v) const
CVectorD operator * (double f) const
CVectorD operator/ (double f) const
CVectorD operator- () const
Advanced Maths.
double operator * (const CVectorD &v) const
 Dot product. More...

CVectorD operator^ (const CVectorD &v) const
 Cross product. More...

double norm () const
 Return the norm of the vector. More...

double sqrnorm () const
 Return the square of the norm of the vector. More...

void normalize ()
 Normalize the vector. More...

CVectorD normed () const
 Return the vector normalized. More...

Misc.
void set (double _x, double _y, double _z)
bool operator== (const CVectorD &v) const
bool operator!= (const CVectorD &v) const
bool isNull () const
void sphericToCartesian (double r, double theta,double phi)
 Setup the vector with spheric coordinates. More...

void cartesianToSpheric (double &r, double &theta,double &phi) const
 Get the sphreic coordinates of the vector. More...

void serial (IStream &f)
CVectorD& operator= (const CVector &v)
 operator CVector () const

Public Attributes

double x
double y
double z

Static Public Attributes

const CVectorD Null
 Null vector (0,0,0). More...

const CVectorD I
 I vector (1,0,0). More...

const CVectorD J
 J vector (0,1,0). More...

const CVectorD K
 K vector (0,0,1). More...


Friends

CVectorD operator * (double f, const CVectorD &v0)
+

Detailed Description

+A 3D vector of double. +

+

+Author(s):
+ Lionel Berenguier , Nevrax France
+Date:
+ 2000
+

+ +

+Definition at line 44 of file vectord.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + +
+NLMISC::CVectorD::CVectorD ( + +) [inline] +
+
+ + + + + +
+   + + +

+Constructor wich do nothing. +

+ +

+Definition at line 63 of file vectord.h.

+

+ + + + +
+ + + + + + + + + + + + + + +
+NLMISC::CVectorD::CVectorD ( + +double _x, +
+double _y, +
+double _z ) [inline] +
+
+ + + + + +
+   + + +

+Constructor . +

+ +

+Definition at line 65 of file vectord.h.

+

+ + + + +
+ + + + + + +
+NLMISC::CVectorD::CVectorD ( + +const CVector & v ) [inline] +
+
+ + + + + +
+   + + +

+Constructor with a CVector. +

+ +

+Definition at line 67 of file vectord.h.

+

+ + + + +
+ + + + + + +
+NLMISC::CVectorD::CVectorD ( + +const CVectorD & v ) [inline] +
+
+ + + + + +
+   + + +

+Copy Constructor. +

+ +

+Definition at line 69 of file vectord.h.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + +
+void NLMISC::CVectorD::cartesianToSpheric ( + +double & r, +
+double & theta, +
+double & phi ) const [inline] +
+
+ + + + + +
+   + + +

+Get the sphreic coordinates of the vector. +

+See sphericToCartesian() to know coordinates conventions.

+See also:
+ sphericToCartesian()
+

+Definition at line 152 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+bool NLMISC::CVectorD::isNull ( + +) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 148 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+double NLMISC::CVectorD::norm ( + +) const [inline] +
+
+ + + + + +
+   + + +

+Return the norm of the vector. +

+ +

+Definition at line 115 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+void NLMISC::CVectorD::normalize ( + +) [inline] +
+
+ + + + + +
+   + + +

+Normalize the vector. +

+ +

+Definition at line 119 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD NLMISC::CVectorD::normed ( + +) const [inline] +
+
+ + + + + +
+   + + +

+Return the vector normalized. +

+ +

+Definition at line 125 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+double NLMISC::CVectorD::operator * ( + +const CVectorD & v ) const [inline] +
+
+ + + + + +
+   + + +

+Dot product. +

+ +

+Definition at line 97 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD NLMISC::CVectorD::operator * ( + +double f ) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 75 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD & NLMISC::CVectorD::operator *= ( + +double f ) [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 54 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+NLMISC::CVectorD::operator CVector ( + +) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 184 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+bool NLMISC::CVectorD::operator!= ( + +const CVectorD & v ) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 144 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD NLMISC::CVectorD::operator+ ( + +const CVectorD & v ) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 65 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD & NLMISC::CVectorD::operator+= ( + +const CVectorD & v ) [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 40 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD NLMISC::CVectorD::operator- ( + +) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 84 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD NLMISC::CVectorD::operator- ( + +const CVectorD & v ) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 70 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD & NLMISC::CVectorD::operator-= ( + +const CVectorD & v ) [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 47 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD NLMISC::CVectorD::operator/ ( + +double f ) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 80 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD & NLMISC::CVectorD::operator/= ( + +double f ) [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 61 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD & NLMISC::CVectorD::operator= ( + +const CVector & v ) [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 177 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+bool NLMISC::CVectorD::operator== ( + +const CVectorD & v ) const [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 140 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+CVectorD NLMISC::CVectorD::operator^ ( + +const CVectorD & v ) const [inline] +
+
+ + + + + +
+   + + +

+Cross product. +

+compute the cross product *this ^ v. +

+Definition at line 101 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+void NLMISC::CVectorD::serial ( + +IStream & f ) [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 188 of file vectord_inline.h.

+

+ + + + +
+ + + + + + + + + + + + + + +
+void NLMISC::CVectorD::set ( + +double _x, +
+double _y, +
+double _z ) [inline] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 136 of file vectord_inline.h.

+

+ + + + +
+ + + + + + + + + + + + + + +
+void NLMISC::CVectorD::sphericToCartesian ( + +double r, +
+double theta, +
+double phi ) [inline] +
+
+ + + + + +
+   + + +

+Setup the vector with spheric coordinates. +

+sphericToCartesian(1,0,0) build the I vector ((1,0,0)). the formula is:
+ x= r*cos(theta)*cos(phi)
+ y= r*sin(theta)*cos(phi)
+ z= r*sin(phi)
+

+See also:
+ cartesianToSpheric()
+

+Definition at line 166 of file vectord_inline.h.

+

+ + + + +
+ + + + + + +
+double NLMISC::CVectorD::sqrnorm ( + +) const [inline] +
+
+ + + + + +
+   + + +

+Return the square of the norm of the vector. +

+ +

+Definition at line 111 of file vectord_inline.h.

+

Friends And Related Function Documentation

+

+ + + + +
+ + + + + + + + + + +
+CVectorD operator * ( + +double f, +
+const CVectorD & v ) [friend] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 88 of file vectord_inline.h.

+

Member Data Documentation

+

+ + + + +
+ + + + + +
+const CVectorD NLMISC::CVectorD::I [static] +
+
+ + + + + +
+   + + +

+I vector (1,0,0). +

+ +

+Definition at line 53 of file vectord.h.

+

+ + + + +
+ + + + + +
+const CVectorD NLMISC::CVectorD::J [static] +
+
+ + + + + +
+   + + +

+J vector (0,1,0). +

+ +

+Definition at line 55 of file vectord.h.

+

+ + + + +
+ + + + + +
+const CVectorD NLMISC::CVectorD::K [static] +
+
+ + + + + +
+   + + +

+K vector (0,0,1). +

+ +

+Definition at line 57 of file vectord.h.

+

+ + + + +
+ + + + + +
+const CVectorD NLMISC::CVectorD::Null [static] +
+
+ + + + + +
+   + + +

+Null vector (0,0,0). +

+ +

+Definition at line 51 of file vectord.h.

+

+ + + + +
+ + + + + +
+double NLMISC::CVectorD::x +
+
+ + + + + +
+   + + +

+ +

+Definition at line 47 of file vectord.h.

+

+ + + + +
+ + + + + +
+double NLMISC::CVectorD::y +
+
+ + + + + +
+   + + +

+ +

+Definition at line 47 of file vectord.h.

+

+ + + + +
+ + + + + +
+double NLMISC::CVectorD::z +
+
+ + + + + +
+   + + +

+ +

+Definition at line 47 of file vectord.h.

+

The documentation for this class was generated from the following files: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1