scifir::vector_unit_3d Class Reference

Class that creates a vector unit in 3D. The vector is in spherical coordinates with a value and dimensions of the scalar_unit, and an angle theta and another angle phi for his direction. All base and derived vectorial unit classes in 3D inherit from vector_unit_3d, and add the suffix **_3d** in their name. Initialization string example: "1 N 20θ 30Φ". 'θ' is the Unicode Character U+03B8. 'Φ' is the Unicode Character U+03A6. More...

#include <vector_unit_3d.hpp>

Inheritance diagram for scifir::vector_unit_3d:

Collaboration diagram for scifir::vector_unit_3d:

Public Member Functions
	vector_unit_3d ()
	Default constructor. The value is set to 0, the dimensions are empty and theta and phi are 0.
	vector_unit_3d (const vector_unit_3d &x)
	Copy constructor. The member-variables are copied from vector_unit_3d x.
	vector_unit_3d (vector_unit_3d &&x)
	Move constructor. The member-variables are moved from vector_unit_3d x.
	vector_unit_3d (float new_value, dimension::type new_dimension, prefix::type new_prefix, float new_theta, float new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (float new_value, dimension::type new_dimension, prefix::type new_prefix, const angle &new_theta, const angle &new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (double new_value, dimension::type new_dimension, prefix::type new_prefix, float new_theta, float new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (double new_value, dimension::type new_dimension, prefix::type new_prefix, const angle &new_theta, const angle &new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (long double new_value, dimension::type new_dimension, prefix::type new_prefix, float new_theta, float new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (long double new_value, dimension::type new_dimension, prefix::type new_prefix, const angle &new_theta, const angle &new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (int new_value, dimension::type new_dimension, prefix::type new_prefix, float new_theta, float new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (int new_value, dimension::type new_dimension, prefix::type new_prefix, const angle &new_theta, const angle &new_phi, dimension::position new_position=dimension::NUMERATOR)
	vector_unit_3d (float new_value, const string &init_dimensions, float new_theta, float new_phi)
	The value is new_value, the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (float new_value, const string &init_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value, the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (double new_value, const string &init_dimensions, float new_theta, float new_phi)
	The value is new_value (the double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (double new_value, const string &init_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value (the double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (long double new_value, const string &init_dimensions, float new_theta, float new_phi)
	The value is new_value (the long double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (long double new_value, const string &init_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value (the long double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (int new_value, const string &init_dimensions, float new_theta, float new_phi)
	The value is new_value (the int is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (int new_value, const string &init_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value (the int is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (float new_value, const vector< dimension > &new_dimensions, float new_theta, float new_phi)
	The value is new_value, the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (float new_value, const vector< dimension > &new_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value, the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (double new_value, const vector< dimension > &new_dimensions, float new_theta, float new_phi)
	The value is new_value (the double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (double new_value, const vector< dimension > &new_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value (the double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (long double new_value, const vector< dimension > &new_dimensions, float new_theta, float new_phi)
	The value is new_value (the long double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (long double new_value, const vector< dimension > &new_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value (the long double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (int new_value, const vector< dimension > &new_dimensions, float new_theta, float new_phi)
	The value is new_value (the int is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (int new_value, const vector< dimension > &new_dimensions, const angle &new_theta, const angle &new_phi)
	The value is new_value (the int is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.
	vector_unit_3d (const scalar_unit &x, float new_theta, float new_phi)
	The value and the dimensions are copied from the scalar_unit x, theta is new_theta, phi is new_phi.
	vector_unit_3d (const scalar_unit &x, const angle &new_theta, const angle &new_phi)
	The value and the dimensions are copied from the scalar_unit x, theta is new_theta, phi is new_phi.
	vector_unit_3d (const string &init_scalar, float new_theta, float new_phi)
	The value and the dimensions are copied from the initialization string of scalar_unit init_scalar, theta is new_theta, phi is new_phi.
	vector_unit_3d (const string &init_scalar, const angle &new_theta, const angle &new_phi)
	The value and the dimensions are copied from the initialization string of scalar_unit init_scalar, theta is new_theta, phi is new_phi.
	vector_unit_3d (const string &init_vector_3d)
	The value, the dimensions, theta and phi are initialized from the initialization string of vector_unit_3d init_vector_3d.
vector_unit_3d &	operator= (const vector_unit_3d &x)
	Copy assignment. The member-variables are copied from the vector_unit_3d x.
vector_unit_3d &	operator= (vector_unit_3d &&x)
	Move assignment. The member-variables are moved from the vector_unit_3d x.
vector_unit_3d &	operator= (const scalar_unit &x)
	The value and the dimensions are copied from the scalar_unit x, theta and phi are not changed.
vector_unit_3d &	operator= (scalar_unit &&x)
	The value and the dimensions are moved from the scalar_unit x, theta and phi are not changed.
vector_unit_3d &	operator= (const string &init_vector_3d)
	The value, the dimensions, theta and phi are set from the initialization string init_vector_3d.
bool	operator== (vector_unit_3d x) const
	Comparison operator. Two vector_unit_3d are equal if their value, dimensions, theta and phi are the same.
void	point_to (direction::name x)
	Theta is set to the direction specified in 3D. Possible values are LEFT, RIGHT, TOP, BOTTOM, LEFT_TOP, RIGHT_TOP, RIGHT_BOTTOM, LEFT_BOTTOM, FRONT, BACK, LEFT_FRONT, RIGHT_FRONT, TOP_FRONT, BOTTOM_FRONT, LEFT_BACK, RIGHT_BACK, TOP_BACK, BOTTOM_BACK, LEFT_TOP_FRONT, RIGHT_TOP_FRONT, LEFT_BOTTOM_FRONT, RIGHT_BOTTOM_FRONT, LEFT_TOP_BACK, RIGHT_TOP_BACK, LEFT_BOTTOM_BACK, RIGHT_BOTTOM_BACK.
void	operator+= (const vector_unit_3d &x)
	The vector_unit_3d is summed as vector, in spherical coordinates. The addition of vectors is used for the calculation.
void	operator-= (vector_unit_3d x)
	The vector_unit_3d is substracted as vector, in spherical coordinates. The substraction of vectors is used for the calculation.
vector_unit_3d	operator+ (const vector_unit_3d &x) const
	Addition of vectors in 3D. It creates a new vector as the addition of the other two.
vector_unit_3d	operator- (vector_unit_3d x) const
	Substraction of vectors in 3D. It creates a new vector as the difference of the other two.
vector_unit_3d	operator* (const scalar_unit &x) const
	It creates a new vector_unit_3d scaling a vector_unit_3d by the scalar_unit x.
vector_unit_3d	operator/ (const scalar_unit &x) const
	It creates a new vector_unit_3d scaling a vector_unit_3d by the inverse of the scalar_unit x.
vector_unit_3d	operator^ (const scalar_unit &x) const
	It powers a vector by a scalar_unit x if that scalar_unit has empty dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
vector_unit_3d	operator+ (T x) const
	It creates a new vector as the addition of the numeric type x to the value. Theta and phi are not changed.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
vector_unit_3d	operator- (T x) const
	It creates a new vector as the substraction of the numeric type x to the value. Theta and phi are not changed.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
vector_unit_3d	operator* (T x) const
	It creates a new vector as the multiplication of the numeric type x to the value. Theta and phi are not changed.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
vector_unit_3d	operator/ (T x) const
	It creates a new vector as the division of the value with the numeric type x. Theta and phi are not changed.
template<typename T , typename = typename enable_if<is_integer_number<T>::value>::type>
vector_unit_3d	operator^ (T x) const
	It creates a new vector as the power of the value with the numeric type x. Theta and phi are not changed.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator+= (T x)
	It sums the numeric type x to the value. Theta and phi are not changed.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator-= (T x)
	It substracts the numeric type x to the value. Theta and phi are not changed.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator*= (T x)
	It multiplies the numeric type x to the value. Theta and phi are not changed.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator/= (T x)
	It divides the numeric type x to the value. Theta and phi are not changed.
scalar_unit	x_projection () const
	It creates the x projection of the vector, returning it as a scalar_unit of the same dimensions, and the value corresponds to the projection.
scalar_unit	y_projection () const
	It creates the y projection of the vector, returning it as a scalar_unit of the same dimensions, and the value corresponds to the projection.
scalar_unit	z_projection () const
	It creates the z projection of the vector, returning it as a scalar_unit of the same dimensions, and the value corresponds to the projection.
void	invert ()
	Changes the direction of the vector to the opposite direction. It does that by adding 180 degrees to theta and calculating the new phi as "180 - phi".
string	vectorial_display (int number_of_decimals=2) const
	Displays the vector as the string representation of the scalar unit adding also the angle theta and the angle phi.
string	vectorial_base_display (int number_of_decimals=2) const
	Displays the vector as the string representation of the scalar unit adding also the angle theta and the angle phi. It displays the dimensions with its base dimensions.
string	vectorial_custom_display (const string &init_dimensions, int number_of_decimals=2) const
	Displays the vector as the string representation of the scalar unit adding also the angle theta and the angle phi. It displays the vector in the dimensions specified in the initialization string of dimensions init_dimensions.
Public Member Functions inherited from scifir::scalar_unit
	scalar_unit ()
	Default constructor, the value is 0 and the dimensions are empty.
	scalar_unit (const scalar_unit &x)
	Copy constructor, copies the value and the dimensions.
	scalar_unit (scalar_unit &&x)
	Move constructor, moves the value and the dimensions.
	scalar_unit (float new_value, dimension::type new_dimension, prefix::type new_prefix, dimension::position new_position=dimension::NUMERATOR)
	scalar_unit (double new_value, dimension::type new_dimension, prefix::type new_prefix, dimension::position new_position=dimension::NUMERATOR)
	scalar_unit (long double new_value, dimension::type new_dimension, prefix::type new_prefix, dimension::position new_position=dimension::NUMERATOR)
	scalar_unit (int new_value, dimension::type new_dimension, prefix::type new_prefix, dimension::position new_position=dimension::NUMERATOR)
	scalar_unit (float new_value, const string &init_dimensions)
	Creates a new scalar_unit with the value and with the dimensions specified in the string.
	scalar_unit (double new_value, const string &init_dimensions)
	Creates a new scalar_unit, the double is casted to a float.
	scalar_unit (long double new_value, const string &init_dimensions)
	Creates a new scalar_unit, the long double is casted to a float.
	scalar_unit (int new_value, const string &init_dimensions)
	Creates a new scalar_unit, the int is casted to a float.
	scalar_unit (float new_value, const vector< dimension > &new_dimensions)
	Creates a new scalar_unit with the value given and copying the dimensions.
	scalar_unit (double new_value, const vector< dimension > &new_dimensions)
	Creates a new scalar_unit, the double is casted to a float, the dimensions are copied.
	scalar_unit (long double new_value, const vector< dimension > &new_dimensions)
	Creates a new scalar_unit, the long double is casted to a float, the dimensions are copied.
	scalar_unit (int new_value, const vector< dimension > &new_dimensions)
	Creates a new scalar_unit, the int is casted to a float, the dimensions are copied.
	scalar_unit (const string &init_scalar)
	Creates a new scalar_unit, the initialization string specifies both the value and the dimensions.
scalar_unit &	operator= (const scalar_unit &x)
	Copy assignment, it assigns a copy of the scalar_unit.
scalar_unit &	operator= (scalar_unit &&x)
	Move assignment, it moves the scalar_unit.
scalar_unit &	operator= (const string &init_scalar)
	Assignment with an initialization string, the value and the dimensions are both specified.
	operator float () const
	Cast the scalar_unit to their float equivalent, it discards the dimensions and copies the value to a float.
bool	operator== (scalar_unit x) const
	Comparison operator, two scalar_unit classes are considered equivalent if they have the same value given the same dimensions.
scalar_unit	operator+ (scalar_unit x) const
	Addition operator, it sums two scalar_unit classes, their dimensions are changed to be equal first. If the basic dimensions are different, it returns an empty scalar_unit class.
scalar_unit	operator- (scalar_unit x) const
	Substraction operator, it substracts one scalar_unit from the other, their dimensions are changed to be equal first. If the basic dimensions are different, it returns an empty scalar_unit class.
scalar_unit	operator* (scalar_unit x) const
	Multiplication operator, it multiplies two scalar_unit classes, their dimensions are also multiplied.
scalar_unit	operator/ (scalar_unit x) const
	Division operator, it divides one scalar_unit class with the other, their dimensions are also divided.
scalar_unit	operator^ (const scalar_unit &x) const
	Power operator, it powers a scalar_unit class with another, if that second scalar_unit class, which is the exponent, as empty dimensions. If the exponent doesn't has empty dimensions it returns an empty scalar_unit class.
void	operator+= (scalar_unit x)
	Addition operator, it adds a scalar_unit class to another, by converting their dimensions to be equal first. If their basic dimensions are different, it doesn't sums to the value.
void	operator-= (scalar_unit x)
	Substraction operator, it substracts a scalar_unit class to another, by converting their dimensions to be equal first. If their basic dimensions are different, it doesn't substracts to the value.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
scalar_unit	operator+ (T y) const
	Addition operator, it sums the numeric type to the value, independent of the dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
scalar_unit	operator- (T y) const
	Substraction operator, it substracts the numeric type to the value, independent of the dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
scalar_unit	operator* (T y) const
	Multiplication operator, it multiplies the numeric type with the value, independent of the dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
scalar_unit	operator/ (T y) const
	Division operator, it divides the value with the numeric type, independent of the dimensions.
template<typename T , typename = typename enable_if<is_integer_number<T>::value>::type>
scalar_unit	operator^ (T y) const
	Power operator, it powers the value with the numeric type, independent of the dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator+= (T y)
	Addition operator, it adds the numeric type to the value, independent of the dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator-= (T y)
	Substraction operator, it substracts the numeric type to the value, independent of the dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator*= (T y)
	Multiplication operator, it multiplies the numeric type to the value, independent of the dimensions.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator/= (T y)
	Division operator, it divides the numeric type to the value, independent of the dimensions.
scalar_unit &	operator++ ()
	Increment operator, it increases the value by one.
scalar_unit &	operator++ (int)
	Increment operator, it increases the value by one.
scalar_unit &	operator-- ()
	Decrement operator, it decreases the value by one.
scalar_unit &	operator-- (int)
	Decrement operator, it decreases the value by one.
void	change_dimensions (const string &init_dimensions)
	Changes the dimensions to the dimensions specified by the initialization string of dimensions.
void	change_dimensions (const scalar_unit &x)
	Changes the dimensions to the same dimensions of the scalar_unit.
bool	has_dimensions (const string &init_dimensions) const
	Checks if the basic dimensions are the same as the initialization string of dimensions.
bool	has_dimensions (const vector< dimension > &x_dimensions) const
	Checks if the basic dimensions are the same as some set of dimensions.
bool	has_dimensions (const scalar_unit &x) const
	Checks if the basic dimensions are the same as other scalar_unit.
bool	has_empty_dimensions () const
	Checks if there aren't base dimensions.
bool	is_dimensionless () const
	Returns true if there aren't dimensions or if all dimensions are dimensionless.
bool	has_simple_dimensions () const
	Returns true if there's only a simple dimension.
bool	has_single_dimensions () const
	Returns true if there's only one dimension, which can be simple or composite.
bool	has_composite_dimensions () const
	Returns true is there's more than one simple dimension.
string	display_dimensions () const
	Generates an string of the dimensions of the scalar_unit, with the same format as the initialization string of dimensions.
dimension::type	get_single_dimension_type () const
	Returns the dimension::type if there's only one dimension, returns dimension::NONE if there's more than one dimension or if the dimensions are empty.
vector< dimension >	get_base_dimensions () const
	Generates a set of the base dimensions of the dimensions of the scalar_unit.
const vector< dimension > &	get_dimensions () const
	Read-only getter of the dimensions.
const float &	get_value () const
	Read-only getter of the value.
string	display (int number_of_decimals=2, bool with_brackets=false, bool use_close_prefix=false) const
	Generates a string representation of the scalar_unit, with the value and the dimensions. The dimensions can be enclosed by brackets, and the value can be set to have the closest prefix.
string	base_display (int number_of_decimals=2, bool with_brackets=false, bool use_close_prefix=false) const
	Generates a string representation of the scalar_unit, with its dimensions converted to their base counterpart.
string	custom_display (const string &init_dimensions, int number_of_decimals=2, bool with_brackets=false) const
	Generates a string representation of the scalar_unit, with the dimensions changed to any set of dimensions, specified by an initialization string of dimensions.
string	to_latex (const string &init_dimensions, int number_of_decimals=2, bool with_brackets=false) const

Static Public Member Functions
static vector_unit_3d	cartesian_3d (const string &init_dimensions, float new_x, float new_y, float new_z)
	The dimensions are initialized from the initialization string of dimensions new_dimensions, the cartesian coordinates new_x, new_y and new_z are converted to spherical coordinates and then set the value, theta and phi.
static vector_unit_3d	cylindrical (const string &init_dimensions, float new_p, angle new_theta, float new_z)
	The dimensions are initialized from the initialization string of dimensions new_dimensions, the cylindrical coordinates new_p, new_theta and new_z are converted to spherical coordinates and then set the value, theta and phi.

Public Attributes
angle	theta
	Angle theta of the vector in 3D space, in spherical coordinates. As all angles of scifir-units, it's stored in degrees.
angle	phi
	Angle phi of the vector in 3D space, in spherical coordinates. As all angles of scifir-units, it's stored in degrees.

Protected Member Functions
void	initialize_from_string (string init_vector_3d)
	Initializes the member-variables with the initialization string of vector_unit_3d init_vector_3d.
Protected Member Functions inherited from scifir::scalar_unit
void	add_dimension (const dimension &new_dimension)
	Internal function. It adds a dimension, changing the value according to the conversion factor of the added dimension and the prefix.
void	remove_dimension (const dimension &old_dimension)
	Internal function. It removes a dimension, changing the value according to the conversion factor of the removed dimension and the prefix.
void	initialize_from_string (string init_scalar, const vector< dimension > &real_dimensions)
	Internal function. It sets the value and the dimensions of the scalar_unit to the value and dimensions specified by the initialization string of scalar_unit.
void	check_dimensions (const vector< dimension > &real_dimensions)

Additional Inherited Members
Protected Attributes inherited from scifir::scalar_unit
vector< dimension >	dimensions
	Dimensions of the scalar_unit. They can be simple dimensions, composite dimensions or special names.
float	value
	Value of the scalar_unit. It changes automatically when the dimensions change.

Detailed Description

Class that creates a vector unit in 3D. The vector is in spherical coordinates with a value and dimensions of the scalar_unit, and an angle theta and another angle phi for his direction. All base and derived vectorial unit classes in 3D inherit from vector_unit_3d, and add the suffix **_3d** in their name. Initialization string example: "1 N 20θ 30Φ". 'θ' is the Unicode Character U+03B8. 'Φ' is the Unicode Character U+03A6.

Definition at line 302 of file vector_unit_3d.hpp.

Constructor & Destructor Documentation

vector_unit_3d() [1/32]

vector_unit_3d::vector_unit_3d

(

)

Default constructor. The value is set to 0, the dimensions are empty and theta and phi are 0.

Definition at line 10 of file vector_unit_3d.cpp.

                                   : scalar_unit(),theta(),phi()
    {}

vector_unit_3d() [2/32]

vector_unit_3d::vector_unit_3d

(

const vector_unit_3d &

x

)

Copy constructor. The member-variables are copied from vector_unit_3d x.

Definition at line 13 of file vector_unit_3d.cpp.

                                                          : scalar_unit(x),theta(x.theta),phi(x.phi)
    {}

vector_unit_3d() [3/32]

vector_unit_3d::vector_unit_3d

(

vector_unit_3d &&

x

)

Move constructor. The member-variables are moved from vector_unit_3d x.

Definition at line 16 of file vector_unit_3d.cpp.

                                                     : scalar_unit(std::move(x)),theta(std::move(x.theta)),phi(std::move(x.phi))
    {}

vector_unit_3d() [4/32]

scifir::vector_unit_3d::vector_unit_3d ( float  new_value, dimension::type  new_dimension, prefix::type  new_prefix, float  new_theta, float  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 19 of file vector_unit_3d.cpp.

                                                                                                                                                                      : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [5/32]

scifir::vector_unit_3d::vector_unit_3d ( float  new_value, dimension::type  new_dimension, prefix::type  new_prefix, const angle &  new_theta, const angle &  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 22 of file vector_unit_3d.cpp.

                                                                                                                                                                                    : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [6/32]

scifir::vector_unit_3d::vector_unit_3d ( double  new_value, dimension::type  new_dimension, prefix::type  new_prefix, float  new_theta, float  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 25 of file vector_unit_3d.cpp.

                                                                                                                                                                       : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [7/32]

scifir::vector_unit_3d::vector_unit_3d ( double  new_value, dimension::type  new_dimension, prefix::type  new_prefix, const angle &  new_theta, const angle &  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 28 of file vector_unit_3d.cpp.

                                                                                                                                                                                     : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [8/32]

scifir::vector_unit_3d::vector_unit_3d ( long double  new_value, dimension::type  new_dimension, prefix::type  new_prefix, float  new_theta, float  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 31 of file vector_unit_3d.cpp.

                                                                                                                                                                            : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [9/32]

scifir::vector_unit_3d::vector_unit_3d ( long double  new_value, dimension::type  new_dimension, prefix::type  new_prefix, const angle &  new_theta, const angle &  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 34 of file vector_unit_3d.cpp.

                                                                                                                                                                                          : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [10/32]

scifir::vector_unit_3d::vector_unit_3d ( int  new_value, dimension::type  new_dimension, prefix::type  new_prefix, float  new_theta, float  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 37 of file vector_unit_3d.cpp.

                                                                                                                                                                    : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [11/32]

scifir::vector_unit_3d::vector_unit_3d ( int  new_value, dimension::type  new_dimension, prefix::type  new_prefix, const angle &  new_theta, const angle &  new_phi, dimension::position  new_position = dimension::NUMERATOR  )

explicit

Definition at line 40 of file vector_unit_3d.cpp.

                                                                                                                                                                                  : scalar_unit(new_value,new_dimension,new_prefix,new_position),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [12/32]

vector_unit_3d::vector_unit_3d ( float  new_value, const string &  init_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value, the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 43 of file vector_unit_3d.cpp.

                                                                                                              : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [13/32]

vector_unit_3d::vector_unit_3d ( float  new_value, const string &  init_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value, the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 46 of file vector_unit_3d.cpp.

                                                                                                                            : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [14/32]

vector_unit_3d::vector_unit_3d ( double  new_value, const string &  init_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value (the double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 49 of file vector_unit_3d.cpp.

                                                                                                               : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [15/32]

vector_unit_3d::vector_unit_3d ( double  new_value, const string &  init_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value (the double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 52 of file vector_unit_3d.cpp.

                                                                                                                             : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [16/32]

vector_unit_3d::vector_unit_3d ( long double  new_value, const string &  init_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value (the long double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 55 of file vector_unit_3d.cpp.

                                                                                                                    : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [17/32]

vector_unit_3d::vector_unit_3d ( long double  new_value, const string &  init_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value (the long double is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 58 of file vector_unit_3d.cpp.

                                                                                                                                  : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [18/32]

vector_unit_3d::vector_unit_3d ( int  new_value, const string &  init_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value (the int is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 61 of file vector_unit_3d.cpp.

                                                                                                            : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [19/32]

vector_unit_3d::vector_unit_3d ( int  new_value, const string &  init_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value (the int is casted to a float), the dimensions are initialized with the initialization string of dimensions, theta is new_theta and phi is new_phi.

Definition at line 64 of file vector_unit_3d.cpp.

                                                                                                                          : scalar_unit(new_value,init_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [20/32]

vector_unit_3d::vector_unit_3d ( float  new_value, const vector< dimension > &  new_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value, the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 67 of file vector_unit_3d.cpp.

                                                                                                                        : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [21/32]

vector_unit_3d::vector_unit_3d ( float  new_value, const vector< dimension > &  new_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value, the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 70 of file vector_unit_3d.cpp.

                                                                                                                                      : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [22/32]

vector_unit_3d::vector_unit_3d ( double  new_value, const vector< dimension > &  new_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value (the double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 73 of file vector_unit_3d.cpp.

                                                                                                                         : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [23/32]

vector_unit_3d::vector_unit_3d ( double  new_value, const vector< dimension > &  new_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value (the double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 76 of file vector_unit_3d.cpp.

                                                                                                                                       : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [24/32]

vector_unit_3d::vector_unit_3d ( long double  new_value, const vector< dimension > &  new_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value (the long double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 79 of file vector_unit_3d.cpp.

                                                                                                                              : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [25/32]

vector_unit_3d::vector_unit_3d ( long double  new_value, const vector< dimension > &  new_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value (the long double is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 82 of file vector_unit_3d.cpp.

                                                                                                                                            : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [26/32]

vector_unit_3d::vector_unit_3d ( int  new_value, const vector< dimension > &  new_dimensions, float  new_theta, float  new_phi  )

explicit

The value is new_value (the int is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 85 of file vector_unit_3d.cpp.

                                                                                                                      : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [27/32]

vector_unit_3d::vector_unit_3d ( int  new_value, const vector< dimension > &  new_dimensions, const angle &  new_theta, const angle &  new_phi  )

explicit

The value is new_value (the int is casted to a float), the dimensions are initialized with a vector of dimensions, theta is new_theta and phi is new_phi.

Definition at line 88 of file vector_unit_3d.cpp.

                                                                                                                                    : scalar_unit(new_value,new_dimensions),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [28/32]

vector_unit_3d::vector_unit_3d ( const scalar_unit &  x, float  new_theta, float  new_phi  )

explicit

The value and the dimensions are copied from the scalar_unit x, theta is new_theta, phi is new_phi.

Definition at line 91 of file vector_unit_3d.cpp.

                                                                                     : scalar_unit(x),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [29/32]

vector_unit_3d::vector_unit_3d ( const scalar_unit &  x, const angle &  new_theta, const angle &  new_phi  )

explicit

The value and the dimensions are copied from the scalar_unit x, theta is new_theta, phi is new_phi.

Definition at line 94 of file vector_unit_3d.cpp.

                                                                                                   : scalar_unit(x),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [30/32]

vector_unit_3d::vector_unit_3d ( const string &  init_scalar, float  new_theta, float  new_phi  )

explicit

The value and the dimensions are copied from the initialization string of scalar_unit init_scalar, theta is new_theta, phi is new_phi.

Definition at line 97 of file vector_unit_3d.cpp.

                                                                                          : scalar_unit(init_scalar),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [31/32]

vector_unit_3d::vector_unit_3d ( const string &  init_scalar, const angle &  new_theta, const angle &  new_phi  )

explicit

The value and the dimensions are copied from the initialization string of scalar_unit init_scalar, theta is new_theta, phi is new_phi.

Definition at line 100 of file vector_unit_3d.cpp.

                                                                                                        : scalar_unit(init_scalar),theta(new_theta),phi(new_phi)
    {}

vector_unit_3d() [32/32]

vector_unit_3d::vector_unit_3d ( const string &  init_vector_3d )

explicit

The value, the dimensions, theta and phi are initialized from the initialization string of vector_unit_3d init_vector_3d.

Definition at line 103 of file vector_unit_3d.cpp.

                                                               : vector_unit_3d()
    {
        vector_unit_3d::initialize_from_string(init_vector_3d);
    }

Member Function Documentation

cartesian_3d()

vector_unit_3d vector_unit_3d::cartesian_3d ( const string &  init_dimensions, float  new_x, float  new_y, float  new_z  )

inlinestatic

The dimensions are initialized from the initialization string of dimensions new_dimensions, the cartesian coordinates new_x, new_y and new_z are converted to spherical coordinates and then set the value, theta and phi.

Definition at line 338 of file vector_unit_3d.hpp.

            {
                float new_value = float(std::sqrt(std::pow(new_x,2) + std::pow(new_y,2) + std::pow(new_z,2)));
                float new_theta = scifir::atan_degree(new_y / new_x);
                float new_phi = scifir::acos_degree(new_z / new_value);
                return vector_unit_3d(new_value,init_dimensions,angle(new_theta),angle(new_phi));
            }

cylindrical()

vector_unit_3d vector_unit_3d::cylindrical ( const string &  init_dimensions, float  new_p, angle  new_theta, float  new_z  )

inlinestatic

The dimensions are initialized from the initialization string of dimensions new_dimensions, the cylindrical coordinates new_p, new_theta and new_z are converted to spherical coordinates and then set the value, theta and phi.

Definition at line 346 of file vector_unit_3d.hpp.

            {
                float new_value = float(std::sqrt(std::pow(new_p,2) + std::pow(new_z,2)));
                float new_phi = scifir::atan_degree(new_p / new_z);
                return vector_unit_3d(new_value,init_dimensions,new_theta,angle(new_phi));
            }

initialize_from_string()

void vector_unit_3d::initialize_from_string ( string  init_vector_3d )

protected

Initializes the member-variables with the initialization string of vector_unit_3d init_vector_3d.

Definition at line 438 of file vector_unit_3d.cpp.

    {
        vector<string> values;
        boost::split(values,init_vector_3d,boost::is_any_of(" "));
        if (values.size() == 4)
        {
            scalar_unit::initialize_from_string(values[0] + " " + values[1],vector<dimension>());
            theta = angle(values[2]);
            phi = angle(values[3]);
        }
    }

invert()

void vector_unit_3d::invert ( )

inline

Changes the direction of the vector to the opposite direction. It does that by adding 180 degrees to theta and calculating the new phi as "180 - phi".

Definition at line 458 of file vector_unit_3d.hpp.

            {
                theta.invert();
                phi = 180.0f - phi;
            }

operator*() [1/2]

vector_unit_3d vector_unit_3d::operator*

(

const scalar_unit &

x

)

const

It creates a new vector_unit_3d scaling a vector_unit_3d by the scalar_unit x.

Definition at line 356 of file vector_unit_3d.cpp.

    {
        long double new_value = scalar_unit::value * x.get_value();
        vector<dimension> new_dimensions = multiply_dimensions(get_dimensions(), x.get_dimensions(),new_value);
        return vector_unit_3d(float(new_value), new_dimensions, theta, phi);
    }

operator*() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

vector_unit_3d vector_unit_3d::operator* ( T  x ) const

inline

It creates a new vector as the multiplication of the numeric type x to the value. Theta and phi are not changed.

Definition at line 390 of file vector_unit_3d.hpp.

            {
                vector_unit_3d y = *this;
                y *= x;
                return y;
            }

operator*=()

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void vector_unit_3d::operator*= ( T  x )

inline

It multiplies the numeric type x to the value. Theta and phi are not changed.

Definition at line 424 of file vector_unit_3d.hpp.

            {
                scalar_unit::value *= std::abs(x);
                if(x < 0)
                {
                    invert();
                }
            }

operator+() [1/2]

vector_unit_3d vector_unit_3d::operator+

(

const vector_unit_3d &

x

)

const

Addition of vectors in 3D. It creates a new vector as the addition of the other two.

Definition at line 319 of file vector_unit_3d.cpp.

    {
        if (has_dimensions(x))
        {
            float new_x = float(x_projection() + x.x_projection());
            float new_y = float(y_projection() + x.y_projection());
            float new_z = float(z_projection() + x.z_projection());
            float new_value = cartesian_3d_to_spherical_r(new_x, new_y, new_z);
            angle new_theta = angle(cartesian_3d_to_spherical_theta(new_x, new_y, new_z));
            angle new_phi = angle(cartesian_3d_to_spherical_phi(new_x, new_y, new_z));
            return vector_unit_3d(new_value,get_dimensions(),new_theta,new_phi);
        }
        else
        {
            return vector_unit_3d();
        }
    }

operator+() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

vector_unit_3d vector_unit_3d::operator+ ( T  x ) const

inline

It creates a new vector as the addition of the numeric type x to the value. Theta and phi are not changed.

Definition at line 374 of file vector_unit_3d.hpp.

            {
                vector_unit_3d y = *this;
                y += x;
                return y;
            }

operator+=() [1/2]

void vector_unit_3d::operator+=

(

const vector_unit_3d &

x

)

The vector_unit_3d is summed as vector, in spherical coordinates. The addition of vectors is used for the calculation.

Definition at line 289 of file vector_unit_3d.cpp.

    {
        if(has_dimensions(x))
        {
            float new_x = float(x_projection() + x.x_projection());
            float new_y = float(y_projection() + x.y_projection());
            float new_z = float(z_projection() + x.z_projection());
            scalar_unit::value = cartesian_3d_to_spherical_r(new_x, new_y, new_z);
            theta = angle(cartesian_3d_to_spherical_theta(new_x, new_y, new_z));
            phi = angle(cartesian_3d_to_spherical_phi(new_x, new_y, new_z));
        }
        else
        {
            cerr << "Cannot sum vectors of different dimensions" << endl;
        }
    }

operator+=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void vector_unit_3d::operator+= ( T  x )

inline

It sums the numeric type x to the value. Theta and phi are not changed.

Definition at line 412 of file vector_unit_3d.hpp.

            {
                scalar_unit::value += x;
            }

operator-() [1/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

vector_unit_3d vector_unit_3d::operator- ( T  x ) const

inline

It creates a new vector as the substraction of the numeric type x to the value. Theta and phi are not changed.

Definition at line 382 of file vector_unit_3d.hpp.

            {
                vector_unit_3d y = *this;
                y -= x;
                return y;
            }

operator-() [2/2]

vector_unit_3d vector_unit_3d::operator-

(

vector_unit_3d

x

)

const

Substraction of vectors in 3D. It creates a new vector as the difference of the other two.

Definition at line 337 of file vector_unit_3d.cpp.

    {
        if (has_dimensions(x))
        {
            x.invert();
            float new_x = float(x_projection() + x.x_projection());
            float new_y = float(y_projection() + x.y_projection());
            float new_z = float(z_projection() + x.z_projection());
            float new_value = cartesian_3d_to_spherical_r(new_x, new_y, new_z);
            angle new_theta = angle(cartesian_3d_to_spherical_theta(new_x, new_y, new_z));
            angle new_phi = angle(cartesian_3d_to_spherical_phi(new_x, new_y, new_z));
            return vector_unit_3d(new_value,get_dimensions(),new_theta,new_phi);
        }
        else
        {
            return vector_unit_3d();
        }
    }

operator-=() [1/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void vector_unit_3d::operator-= ( T  x )

inline

It substracts the numeric type x to the value. Theta and phi are not changed.

Definition at line 418 of file vector_unit_3d.hpp.

            {
                scalar_unit::value -= x;
            }

operator-=() [2/2]

void vector_unit_3d::operator-=

(

vector_unit_3d

x

)

The vector_unit_3d is substracted as vector, in spherical coordinates. The substraction of vectors is used for the calculation.

Definition at line 306 of file vector_unit_3d.cpp.

    {
        if(has_dimensions(x))
        {
            x.invert();
            *this += x;
        }
        else
        {
            cerr << "Cannot substract vectors of different dimensions" << endl;
        }
    }

operator/() [1/2]

vector_unit_3d vector_unit_3d::operator/

(

const scalar_unit &

x

)

const

It creates a new vector_unit_3d scaling a vector_unit_3d by the inverse of the scalar_unit x.

Definition at line 363 of file vector_unit_3d.cpp.

    {
        long double new_value = scalar_unit::value / x.get_value();
        vector<dimension> new_dimensions = divide_dimensions(get_dimensions(), x.get_dimensions(),new_value);
        return vector_unit_3d(float(new_value), new_dimensions, theta, phi);
    }

operator/() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

vector_unit_3d vector_unit_3d::operator/ ( T  x ) const

inline

It creates a new vector as the division of the value with the numeric type x. Theta and phi are not changed.

Definition at line 398 of file vector_unit_3d.hpp.

            {
                vector_unit_3d y = *this;
                y /= x;
                return y;
            }

operator/=()

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void vector_unit_3d::operator/= ( T  x )

inline

It divides the numeric type x to the value. Theta and phi are not changed.

Definition at line 434 of file vector_unit_3d.hpp.

            {
                scalar_unit::value /= std::abs(x);
                if(x < 0)
                {
                    invert();
                }
            }

operator=() [1/5]

vector_unit_3d & vector_unit_3d::operator=

(

const scalar_unit &

x

)

The value and the dimensions are copied from the scalar_unit x, theta and phi are not changed.

Definition at line 124 of file vector_unit_3d.cpp.

    {
        scalar_unit::operator =(x);
        return *this;
    }

operator=() [2/5]

vector_unit_3d & vector_unit_3d::operator=

(

const string &

init_vector_3d

)

The value, the dimensions, theta and phi are set from the initialization string init_vector_3d.

Definition at line 136 of file vector_unit_3d.cpp.

    {
        vector_unit_3d::initialize_from_string(init_vector_3d);
        return *this;
    }

operator=() [3/5]

vector_unit_3d & vector_unit_3d::operator=

(

const vector_unit_3d &

x

)

Copy assignment. The member-variables are copied from the vector_unit_3d x.

Definition at line 108 of file vector_unit_3d.cpp.

    {
        scalar_unit::operator =(x);
        theta = x.theta;
        phi = x.phi;
        return *this;
    }

operator=() [4/5]

vector_unit_3d & vector_unit_3d::operator=

(

scalar_unit &&

x

)

The value and the dimensions are moved from the scalar_unit x, theta and phi are not changed.

Definition at line 130 of file vector_unit_3d.cpp.

    {
        scalar_unit::operator =(std::move(x));
        return *this;
    }

operator=() [5/5]

vector_unit_3d & vector_unit_3d::operator=

(

vector_unit_3d &&

x

)

Move assignment. The member-variables are moved from the vector_unit_3d x.

Definition at line 116 of file vector_unit_3d.cpp.

    {
        scalar_unit::operator =(std::move(x));
        theta = std::move(x.theta);
        phi = std::move(x.phi);
        return *this;
    }

operator==()

bool vector_unit_3d::operator==

(

scifir::vector_unit_3d

x

)

const

Comparison operator. Two vector_unit_3d are equal if their value, dimensions, theta and phi are the same.

Definition at line 142 of file vector_unit_3d.cpp.

    {
        x.change_dimensions(*this);
        if(get_value() == x.get_value() and scifir::same_direction(*this,x) and has_dimensions(x))
        {
            return true;
        }
        else
        {
            return false;
        }
    }

operator^() [1/2]

vector_unit_3d vector_unit_3d::operator^

(

const scalar_unit &

x

)

const

It powers a vector by a scalar_unit x if that scalar_unit has empty dimensions.

Definition at line 370 of file vector_unit_3d.cpp.

    {
        if(x.has_empty_dimensions())
        {
            scalar_unit new_unit = scalar_unit::operator^(x);
            return vector_unit_3d(new_unit, theta, phi);
        }
        else
        {
            cerr << "Cannot power with as exponent a unit with dimensions" << endl;
            return vector_unit_3d();
        }
    }

operator^() [2/2]

template<typename T , typename = typename enable_if<is_integer_number<T>::value>::type>

vector_unit_3d vector_unit_3d::operator^ ( T  x ) const

inline

It creates a new vector as the power of the value with the numeric type x. Theta and phi are not changed.

Definition at line 406 of file vector_unit_3d.hpp.

            {
                return vector_unit_3d(std::pow(get_value(),x),power_dimensions(get_dimensions(),x),theta,phi);
            }

point_to()

void vector_unit_3d::point_to

(

direction::name

x

)

Theta is set to the direction specified in 3D. Possible values are LEFT, RIGHT, TOP, BOTTOM, LEFT_TOP, RIGHT_TOP, RIGHT_BOTTOM, LEFT_BOTTOM, FRONT, BACK, LEFT_FRONT, RIGHT_FRONT, TOP_FRONT, BOTTOM_FRONT, LEFT_BACK, RIGHT_BACK, TOP_BACK, BOTTOM_BACK, LEFT_TOP_FRONT, RIGHT_TOP_FRONT, LEFT_BOTTOM_FRONT, RIGHT_BOTTOM_FRONT, LEFT_TOP_BACK, RIGHT_TOP_BACK, LEFT_BOTTOM_BACK, RIGHT_BOTTOM_BACK.

Definition at line 155 of file vector_unit_3d.cpp.

    {
        if (x == direction::LEFT)
        {
            theta = 270.0f;
            phi = 90.0f;
        }
        else if(x == direction::RIGHT)
        {
            theta = 90.0f;
            phi = 90.0f;
        }
        else if(x == direction::TOP)
        {
            theta = 0.0f;
            phi = 0.0f;
        }
        else if(x == direction::BOTTOM)
        {
            theta = 0.0f;
            phi = 180.0f;
        }
        else if(x == direction::LEFT_TOP)
        {
            theta = 270.0f;
            phi = 45.0f;
        }
        else if(x == direction::RIGHT_TOP)
        {
            theta = 90.0f;
            phi = 45.0f;
        }
        else if(x == direction::RIGHT_BOTTOM)
        {
            theta = 90.0f;
            phi = 135.0f;
        }
        else if(x == direction::LEFT_BOTTOM)
        {
            theta = 270.0f;
            phi = 135.0f;
        }
        else if(x == direction::FRONT)
        {
            theta = 0.0f;
            phi = 90.0f;
        }
        else if(x == direction::BACK)
        {
            theta = 180.0f;
            phi = 90.0f;
        }
        else if(x == direction::LEFT_FRONT)
        {
            theta = 315.0f;
            phi = 90.0f;
        }
        else if(x == direction::RIGHT_FRONT)
        {
            theta = 45.0f;
            phi = 90.0f;
        }
        else if(x == direction::TOP_FRONT)
        {
            theta = 0.0f;
            phi = 45.0f;
        }
        else if(x == direction::BOTTOM_FRONT)
        {
            theta = 0.0f;
            phi = 135.0f;
        }
        else if(x == direction::LEFT_BACK)
        {
            theta = 225.0f;
            phi = 90.0f;
        }
        else if(x == direction::RIGHT_BACK)
        {
            theta = 135.0f;
            phi = 90.0f;
        }
        else if(x == direction::TOP_BACK)
        {
            theta = 180.0f;
            phi = 45.0f;
        }
        else if(x == direction::BOTTOM_BACK)
        {
            theta = 180.0f;
            phi = 135.0f;
        }
        else if(x == direction::LEFT_TOP_FRONT)
        {
            theta = 315.0f;
            phi = 45.0f;
        }
        else if(x == direction::RIGHT_TOP_FRONT)
        {
            theta = 45.0f;
            phi = 45.0f;
        }
        else if(x == direction::LEFT_BOTTOM_FRONT)
        {
            theta = 315.0f;
            phi = 135.0f;
        }
        else if(x == direction::RIGHT_BOTTOM_FRONT)
        {
            theta = 45.0f;
            phi = 135.0f;
        }
        else if(x == direction::LEFT_TOP_BACK)
        {
            theta = 225.0f;
            phi = 45.0f;
        }
        else if(x == direction::RIGHT_TOP_BACK)
        {
            theta = 135.0f;
            phi = 45.0f;
        }
        else if(x == direction::LEFT_BOTTOM_BACK)
        {
            theta = 225.0f;
            phi = 135.0f;
        }
        else if(x == direction::RIGHT_BOTTOM_BACK)
        {
            theta = 135.0f;
            phi = 135.0f;
        }
    }

vectorial_base_display()

string vector_unit_3d::vectorial_base_display

(

int

number_of_decimals = 2

)

const

Displays the vector as the string representation of the scalar unit adding also the angle theta and the angle phi. It displays the dimensions with its base dimensions.

vectorial_custom_display()

string vector_unit_3d::vectorial_custom_display	(	const string &	init_dimensions,
		int	number_of_decimals = 2
	)		const

Displays the vector as the string representation of the scalar unit adding also the angle theta and the angle phi. It displays the vector in the dimensions specified in the initialization string of dimensions init_dimensions.

vectorial_display()

string vector_unit_3d::vectorial_display

(

int

number_of_decimals = 2

)

const

Displays the vector as the string representation of the scalar unit adding also the angle theta and the angle phi.

x_projection()

scalar_unit vector_unit_3d::x_projection ( ) const

inline

It creates the x projection of the vector, returning it as a scalar_unit of the same dimensions, and the value corresponds to the projection.

Definition at line 443 of file vector_unit_3d.hpp.

            {
                return scalar_unit(scalar_unit::value * scifir::cos(theta) * scifir::sin(phi),get_dimensions());
            }

y_projection()

scalar_unit vector_unit_3d::y_projection ( ) const

inline

It creates the y projection of the vector, returning it as a scalar_unit of the same dimensions, and the value corresponds to the projection.

Definition at line 448 of file vector_unit_3d.hpp.

            {
                return scalar_unit(scalar_unit::value * scifir::sin(theta) * scifir::sin(phi),get_dimensions());
            }

z_projection()

scalar_unit vector_unit_3d::z_projection ( ) const

inline

It creates the z projection of the vector, returning it as a scalar_unit of the same dimensions, and the value corresponds to the projection.

Definition at line 453 of file vector_unit_3d.hpp.

            {
                return scalar_unit(scalar_unit::value * scifir::cos(phi),get_dimensions());
            }

Member Data Documentation

phi

angle vector_unit_3d::phi

Angle phi of the vector in 3D space, in spherical coordinates. As all angles of scifir-units, it's stored in degrees.

Definition at line 469 of file vector_unit_3d.hpp.

theta

angle vector_unit_3d::theta

Angle theta of the vector in 3D space, in spherical coordinates. As all angles of scifir-units, it's stored in degrees.

Definition at line 468 of file vector_unit_3d.hpp.

---

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

• units/vector_unit_3d.hpp
• units/vector_unit_3d.cpp
• docs/dox/units/vector_unit_3d.dox