A Discrete-Event Network Simulator
API
vector.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #include "vector.h"
21 #include "fatal-error.h"
22 #include "log.h"
23 #include <cmath>
24 #include <sstream>
25 #include <tuple>
26 
33 namespace ns3 {
34 
35 NS_LOG_COMPONENT_DEFINE ("Vector");
36 
39 
40 // compatibility for mobility code
42 {
44  return MakeVector3DChecker ();
45 }
46 
47 
48 Vector3D::Vector3D (double _x, double _y, double _z)
49  : x (_x),
50  y (_y),
51  z (_z)
52 {
53  NS_LOG_FUNCTION (this << _x << _y << _z);
54 }
55 
57  : x (0.0),
58  y (0.0),
59  z (0.0)
60 {
61  NS_LOG_FUNCTION (this);
62 }
63 
64 Vector2D::Vector2D (double _x, double _y)
65  : x (_x),
66  y (_y)
67 {
68  NS_LOG_FUNCTION (this << _x << _y);
69 }
70 
72  : x (0.0),
73  y (0.0)
74 {
75  NS_LOG_FUNCTION (this);
76 }
77 
78 double
80 {
81  NS_LOG_FUNCTION (this);
82  return std::sqrt (x * x + y * y + z * z);
83 }
84 double
86 {
87  NS_LOG_FUNCTION (this);
88  return std::sqrt (x * x + y * y);
89 }
90 
91 double
93 {
94  NS_LOG_FUNCTION (this);
95  return x * x + y * y + z * z;
96 }
97 double
99 {
100  NS_LOG_FUNCTION (this);
101  return x * x + y * y;
102 }
103 
104 double
105 CalculateDistance (const Vector3D &a, const Vector3D &b)
106 {
107  NS_LOG_FUNCTION (a << b);
108  return (b - a).GetLength ();
109 }
110 double
111 CalculateDistance (const Vector2D &a, const Vector2D &b)
112 {
113  NS_LOG_FUNCTION (a << b);
114  return (b - a).GetLength ();
115 }
116 
117 double
119 {
120  NS_LOG_FUNCTION (a << b);
121  return (b - a).GetLengthSquared ();
122 }
123 double
125 {
126  NS_LOG_FUNCTION (a << b);
127  return (b - a).GetLengthSquared ();
128 }
129 
130 std::ostream &operator << (std::ostream &os, const Vector3D &vector)
131 {
132  os << vector.x << ":" << vector.y << ":" << vector.z;
133  return os;
134 }
135 std::istream &operator >> (std::istream &is, Vector3D &vector)
136 {
137  char c1, c2;
138  is >> vector.x >> c1 >> vector.y >> c2 >> vector.z;
139  if (c1 != ':'
140  || c2 != ':')
141  {
142  is.setstate (std::ios_base::failbit);
143  }
144  return is;
145 }
146 bool operator < (const Vector3D &a, const Vector3D &b)
147 {
148  return std::tie (a.x, a.y, a.z) <
149  std::tie (b.x, b.y, b.z);
150 }
151 bool operator <= (const Vector3D &a, const Vector3D &b)
152 {
153  return std::tie (a.x, a.y, a.z) <=
154  std::tie (b.x, b.y, b.z);
155 }
156 bool operator > (const Vector3D &a, const Vector3D &b)
157 {
158  return std::tie (a.x, a.y, a.z) >
159  std::tie (b.x, b.y, b.z);
160 }
161 bool operator >= (const Vector3D &a, const Vector3D &b)
162 {
163  return std::tie (a.x, a.y, a.z) >=
164  std::tie (b.x, b.y, b.z);
165 }
166 bool operator == (const Vector3D &a, const Vector3D &b)
167 {
168  return std::tie (a.x, a.y, a.z) ==
169  std::tie (b.x, b.y, b.z);
170 }
171 bool operator != (const Vector3D &a, const Vector3D &b)
172 {
173  return !(a == b);
174 }
175 Vector3D
176 operator + (const Vector3D &a, const Vector3D &b)
177 {
178  return Vector3D (a.x + b.x, a.y + b.y, a.z + b.z);
179 }
180 Vector3D
181 operator - (const Vector3D &a, const Vector3D &b)
182 {
183  return Vector3D (a.x - b.x, a.y - b.y, a.z - b.z);
184 }
185 std::ostream &operator << (std::ostream &os, const Vector2D &vector)
186 {
187  os << vector.x << ":" << vector.y;
188  return os;
189 }
190 std::istream &operator >> (std::istream &is, Vector2D &vector)
191 {
192  char c1;
193  is >> vector.x >> c1 >> vector.y;
194  if (c1 != ':')
195  {
196  is.setstate (std::ios_base::failbit);
197  }
198  return is;
199 }
200 bool operator < (const Vector2D &a, const Vector2D &b)
201 {
202  return std::tie (a.x, a.y) <
203  std::tie (b.x, b.y);
204 }
205 bool operator <= (const Vector2D &a, const Vector2D &b)
206 {
207  return std::tie (a.x, a.y) <=
208  std::tie (b.x, b.y);
209 }
210 bool operator > (const Vector2D &a, const Vector2D &b)
211 {
212  return std::tie (a.x, a.y) >
213  std::tie (b.x, b.y);
214 }
215 bool operator >= (const Vector2D &a, const Vector2D &b)
216 {
217  return std::tie (a.x, a.y) >=
218  std::tie (b.x, b.y);
219 }
220 bool operator == (const Vector2D &a, const Vector2D &b)
221 {
222  return std::tie (a.x, a.y) ==
223  std::tie (b.x, b.y);
224 }
225 bool operator != (const Vector2D &a, const Vector2D &b)
226 {
227  return !(a == b);
228 }
229 Vector2D
230 operator + (const Vector2D &a, const Vector2D &b)
231 {
232  return Vector2D (a.x + b.x, a.y + b.y);
233 }
234 Vector2D
235 operator - (const Vector2D &a, const Vector2D &b)
236 {
237  return Vector2D (a.x - b.x, a.y - b.y);
238 }
239 
240 } // namespace ns3
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
ns3::MakeVector3DChecker
Ptr< const AttributeChecker > MakeVector3DChecker(void)
Definition: vector.cc:37
ns3::Vector3D::GetLengthSquared
double GetLengthSquared() const
Compute the squared length of the vector.
Definition: vector.cc:92
ns3::operator+
int64x64_t operator+(const int64x64_t &lhs)
Unary plus operator.
Definition: int64x64-128.h:491
ns3::Vector3D::GetLength
double GetLength() const
Compute the length (magnitude) of the vector.
Definition: vector.cc:79
fatal-error.h
NS_FATAL_x macro definitions.
ns3::Vector3D::Vector3D
Vector3D()
Create vector (0.0, 0.0, 0.0)
Definition: vector.cc:56
ns3::Vector3D::y
double y
y coordinate of vector
Definition: vector.h:60
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::MakeVectorChecker
Ptr< const AttributeChecker > MakeVectorChecker(void)
Definition: vector.cc:41
ns3::operator<
bool operator<(const EventId &a, const EventId &b)
Definition: event-id.h:160
ns3::operator>=
bool operator>=(const int64x64_t &lhs, const int64x64_t &rhs)
Greater or equal operator.
Definition: int64x64.h:166
ns3::operator-
int64x64_t operator-(const int64x64_t &lhs)
Unary negation operator (change sign operator).
Definition: int64x64-128.h:501
ns3::Vector3D::x
double x
x coordinate of vector
Definition: vector.h:59
ns3::Vector2D::GetLength
double GetLength() const
Compute the length (magnitude) of the vector.
Definition: vector.cc:85
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
ns3::operator<=
bool operator<=(const int64x64_t &lhs, const int64x64_t &rhs)
Less or equal operator.
Definition: int64x64.h:155
ns3::CalculateDistanceSquared
double CalculateDistanceSquared(const Vector3D &a, const Vector3D &b)
Definition: vector.cc:118
ATTRIBUTE_HELPER_CPP
#define ATTRIBUTE_HELPER_CPP(type)
Define the attribute value, accessor and checkers for class type
Definition: attribute-helper.h:412
ns3::CalculateDistance
double CalculateDistance(const Vector3D &a, const Vector3D &b)
Definition: vector.cc:105
ns3::Vector2D::GetLengthSquared
double GetLengthSquared() const
Compute the squared length of the vector.
Definition: vector.cc:98
ns3::Vector3D::z
double z
z coordinate of vector
Definition: vector.h:61
ns3::Vector3D
a 3d vector
Definition: vector.h:46
ns3::operator==
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.h:142
ns3::Vector2D::y
double y
y coordinate of vector
Definition: vector.h:195
NS_LOG_FUNCTION_NOARGS
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
Definition: log-macros-enabled.h:209
log.h
Debug message logging.
vector.h
ns3::Vector, ns3::Vector2D and ns3::Vector3D declarations.
sample-rng-plot.x
list x
Definition: sample-rng-plot.py:34
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition: log-macros-enabled.h:244
ns3::operator!=
bool operator!=(Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > a, Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > b)
Inequality test.
Definition: callback.h:1606
ns3::Vector2D
a 2d vector
Definition: vector.h:183
ns3::operator>
bool operator>(const int64x64_t &lhs, const int64x64_t &rhs)
Greater operator.
Definition: int64x64-128.h:431
ns3::operator<<
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition: angles.cc:137
ns3::Vector2D::x
double x
x coordinate of vector
Definition: vector.h:194
ns3::Vector2D::Vector2D
Vector2D()
Constructor: (0.0, 0.0)
Definition: vector.cc:71
ns3::operator>>
std::istream & operator>>(std::istream &is, Angles &a)
Definition: angles.cc:160