cvector Class Reference

3 element cartesian vector More...

#include <vector.h>

Collaboration diagram for cvector:

Public Member Functions
	cvector ()
	cvector (double tx, double ty, double tz)
void	normalize (double scale=1.)
	Normalize cartesian vector in place, i.e. divides it by its own norm. More...
double	length ()
double	norm ()
double	norm2 ()
cvector	normalized (double scale=1.)
	Normalize cartesian vector. More...
double &	operator[] (const int index)
	Index into cvector. More...
json11::Json	to_json () const
	Convert class contents to JSON object. More...
void	from_json (const string &s)
	Set class contents from JSON string. More...

Public Attributes
double	x = 0.
	X value. More...
double	y = 0.
	Y value. More...
double	z = 0.
	Z value. More...

Detailed Description

3 element cartesian vector

3 double precision numbers representing a vector in a right handed cartesian space

Constructor & Destructor Documentation

cvector::cvector ( )

inline

{}

cvector::cvector ( double  tx, double  ty, double  tz  )

inline

                                             {
        x = tx;
        y = ty;
        z = tz;
    }

Member Function Documentation

json11::Json cvector::to_json ( ) const

inline

Convert class contents to JSON object.

Returns a json11 JSON object of the class

Returns

A json11 JSON object containing every member variable within the class

                               {
        return json11::Json::object {
            { "x" , x },
            { "y" , y },
            { "z" , z }
        };
    }

void cvector::from_json ( const string &  s )

inline

Set class contents from JSON string.

Parses the provided JSON-formatted string and sets the class data. String should be formatted like the string returned from to_json()

Parameters

s	JSON-formatted string to set class contents to

Returns

n/a

                                    {
        string error;
        json11::Json parsed = json11::Json::parse(s,error);
        if(error.empty()) {
            if(!parsed["x"].is_null())  x = parsed["x"].number_value();
            if(!parsed["y"].is_null())  y = parsed["y"].number_value();
            if(!parsed["z"].is_null())  z = parsed["z"].number_value();
        } else  {
            cerr<<"ERROR: <"<<error<<">"<<endl;
        }
        return;
    }

Member Data Documentation

double cvector::x = 0.

X value.

double cvector::y = 0.

Y value.

double cvector::z = 0.

Z value.

---

The documentation for this class was generated from the following files:

• vector.h
• vector.cpp