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 | Public Attributes | Private Member Functions | List of all members
scifir::coordinates_1d< float > Class Reference

#include <coordinates_1d.hpp>

Public Member Functions

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

Public Attributes

float x
 

Private Member Functions

void initialize_from_string (string init_coordinates_1d)
 

Detailed Description

Definition at line 102 of file coordinates_1d.hpp.

Constructor & Destructor Documentation

◆ coordinates_1d() [1/5]

scifir::coordinates_1d< float >::coordinates_1d ( )
inline

Definition at line 105 of file coordinates_1d.hpp.

◆ coordinates_1d() [2/5]

scifir::coordinates_1d< float >::coordinates_1d ( const coordinates_1d< float > &  x_coordinates)
inline

Definition at line 108 of file coordinates_1d.hpp.

◆ coordinates_1d() [3/5]

scifir::coordinates_1d< float >::coordinates_1d ( coordinates_1d< float > &&  x_coordinates)
inline

Definition at line 111 of file coordinates_1d.hpp.

111 : x(std::move(x_coordinates.x))
112 {}

◆ coordinates_1d() [4/5]

scifir::coordinates_1d< float >::coordinates_1d ( float  new_x)
inlineexplicit

Definition at line 114 of file coordinates_1d.hpp.

114 : x(new_x)
115 {}

◆ coordinates_1d() [5/5]

scifir::coordinates_1d< float >::coordinates_1d ( const string init_coordinates_1d)
inlineexplicit

Definition at line 117 of file coordinates_1d.hpp.

118 {
120 }
void initialize_from_string(string init_coordinates_1d)

Member Function Documentation

◆ display_cartesian()

string scifir::coordinates_1d< float >::display_cartesian ( ) const
inline

Definition at line 155 of file coordinates_1d.hpp.

156 {
158 out << "(" << display_float(x) << ")";
159 return out.str();
160 }
string display_float(const float &value, int number_of_decimals)
Definition types.cpp:36

◆ distance_to_origin()

float scifir::coordinates_1d< float >::distance_to_origin ( ) const
inline

Definition at line 150 of file coordinates_1d.hpp.

151 {
152 return float(std::abs(x));
153 }

◆ initialize_from_string()

void scifir::coordinates_1d< float >::initialize_from_string ( string  init_coordinates_1d)
inlineprivate

Definition at line 165 of file coordinates_1d.hpp.

166 {
167 if (init_coordinates_1d.front() == '(')
168 {
169 init_coordinates_1d.erase(0,1);
170 }
171 if (init_coordinates_1d.back() == ')')
172 {
174 }
175 if (init_coordinates_1d != "")
176 {
178 }
179 }

◆ move()

void scifir::coordinates_1d< float >::move ( float  x_value)
inline

Definition at line 145 of file coordinates_1d.hpp.

146 {
147 x += x_value;
148 }

◆ operator=() [1/3]

Definition at line 122 of file coordinates_1d.hpp.

123 {
124 x = x_coordinates.x;
125 return *this;
126 }

◆ operator=() [2/3]

coordinates_1d< float > & scifir::coordinates_1d< float >::operator= ( const string init_coordinates_1d)
inline

Definition at line 134 of file coordinates_1d.hpp.

135 {
137 return *this;
138 }

◆ operator=() [3/3]

Definition at line 128 of file coordinates_1d.hpp.

129 {
130 x = std::move(x_coordinates.x);
131 return *this;
132 }

◆ set_position()

void scifir::coordinates_1d< float >::set_position ( float  new_x)
inline

Definition at line 140 of file coordinates_1d.hpp.

141 {
142 x = new_x;
143 }

Member Data Documentation

◆ x

Definition at line 162 of file coordinates_1d.hpp.


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