scifir-units 2.0.0
scifir-units is a library of units of measurement, angles, coordinates, fields, and related data, all lightweight, that help in the development of scientific software and scientific machines
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | List of all members
scifir::coordinates_1d< T > Class Template Reference

#include <coordinates_1d.hpp>

Public Member Functions

 coordinates_1d ()
 
 coordinates_1d (const coordinates_1d< T > &x_coordinates)
 
 coordinates_1d (coordinates_1d< T > &&x_coordinates)
 
 coordinates_1d (const scalar_unit &new_x)
 
 coordinates_1d (const string &init_coordinates_1d)
 
coordinates_1d< T > & operator= (const coordinates_1d< T > &x_coordinates)
 
coordinates_1d< T > & operator= (coordinates_1d< T > &&x_coordinates)
 
coordinates_1d< T > & operator= (const string &init_coordinates_1d)
 
void set_position (const scalar_unit &new_x)
 
void move (const scalar_unit &x_value)
 
T distance_to_origin () const
 
string display_cartesian () const
 

Static Public Member Functions

static coordinates_1d< Torigin (const coordinates_1d< T > &origin, const coordinates_1d< T > &coordinates)
 

Public Attributes

T x
 

Private Member Functions

void initialize_from_string (string init_coordinates_1d)
 

Detailed Description

template<typename T = length>
class scifir::coordinates_1d< T >

Definition at line 17 of file coordinates_1d.hpp.

Constructor & Destructor Documentation

◆ coordinates_1d() [1/5]

template<typename T = length>
scifir::coordinates_1d< T >::coordinates_1d ( )
inline

Definition at line 20 of file coordinates_1d.hpp.

◆ coordinates_1d() [2/5]

template<typename T = length>
scifir::coordinates_1d< T >::coordinates_1d ( const coordinates_1d< T > &  x_coordinates)
inline

Definition at line 23 of file coordinates_1d.hpp.

◆ coordinates_1d() [3/5]

template<typename T = length>
scifir::coordinates_1d< T >::coordinates_1d ( coordinates_1d< T > &&  x_coordinates)
inline

Definition at line 26 of file coordinates_1d.hpp.

26 : x(std::move(x_coordinates.x))
27 {}

◆ coordinates_1d() [4/5]

template<typename T = length>
scifir::coordinates_1d< T >::coordinates_1d ( const scalar_unit new_x)
inlineexplicit

Definition at line 29 of file coordinates_1d.hpp.

29 : x(new_x)
30 {}

◆ coordinates_1d() [5/5]

template<typename T = length>
scifir::coordinates_1d< T >::coordinates_1d ( const string init_coordinates_1d)
inlineexplicit

Definition at line 32 of file coordinates_1d.hpp.

33 {
35 }
void initialize_from_string(string init_coordinates_1d)

Member Function Documentation

◆ display_cartesian()

template<typename T = length>
string scifir::coordinates_1d< T >::display_cartesian ( ) const
inline

Definition at line 77 of file coordinates_1d.hpp.

78 {
80 out << "(" << x << ")";
81 return out.str();
82 }

◆ distance_to_origin()

template<typename T = length>
T scifir::coordinates_1d< T >::distance_to_origin ( ) const
inline

Definition at line 72 of file coordinates_1d.hpp.

73 {
74 return T(std::abs(x.get_value()),x.get_dimensions());
75 }

◆ initialize_from_string()

template<typename T = length>
void scifir::coordinates_1d< T >::initialize_from_string ( string  init_coordinates_1d)
inlineprivate

Definition at line 87 of file coordinates_1d.hpp.

88 {
89 if (init_coordinates_1d.front() == '(')
90 {
91 init_coordinates_1d.erase(0,1);
92 }
93 if (init_coordinates_1d.back() == ')')
94 {
96 }
97 x = scalar_unit(T(init_coordinates_1d));
98 }

◆ move()

template<typename T = length>
void scifir::coordinates_1d< T >::move ( const scalar_unit x_value)
inline

Definition at line 67 of file coordinates_1d.hpp.

68 {
69 x += x_value;
70 }

◆ operator=() [1/3]

template<typename T = length>
coordinates_1d< T > & scifir::coordinates_1d< T >::operator= ( const coordinates_1d< T > &  x_coordinates)
inline

Definition at line 37 of file coordinates_1d.hpp.

38 {
40 return *this;
41 }

◆ operator=() [2/3]

template<typename T = length>
coordinates_1d< T > & scifir::coordinates_1d< T >::operator= ( const string init_coordinates_1d)
inline

Definition at line 49 of file coordinates_1d.hpp.

50 {
52 return *this;
53 }

◆ operator=() [3/3]

template<typename T = length>
coordinates_1d< T > & scifir::coordinates_1d< T >::operator= ( coordinates_1d< T > &&  x_coordinates)
inline

Definition at line 43 of file coordinates_1d.hpp.

44 {
45 x = std::move(x_coordinates.x);
46 return *this;
47 }

◆ origin()

template<typename T = length>
static coordinates_1d< T > scifir::coordinates_1d< T >::origin ( const coordinates_1d< T > &  origin,
const coordinates_1d< T > &  coordinates 
)
inlinestatic

Definition at line 55 of file coordinates_1d.hpp.

56 {
59 return new_coordinates;
60 }
static coordinates_1d< T > origin(const coordinates_1d< T > &origin, const coordinates_1d< T > &coordinates)

◆ set_position()

template<typename T = length>
void scifir::coordinates_1d< T >::set_position ( const scalar_unit new_x)
inline

Definition at line 62 of file coordinates_1d.hpp.

63 {
64 x = new_x;
65 }

Member Data Documentation

◆ x

template<typename T = length>
T scifir::coordinates_1d< T >::x

Definition at line 84 of file coordinates_1d.hpp.


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