... | ... |
@@ -36,5 +36,2 @@ |
36 | 36 |
/// \ref lemon::dim2::Point "dim2::Point"'s. |
37 |
/// |
|
38 |
///\author Attila Bernath |
|
39 |
|
|
40 | 37 |
|
... | ... |
@@ -64,5 +61,5 @@ |
64 | 61 |
|
65 |
///First |
|
62 |
///First coordinate |
|
66 | 63 |
T x; |
67 |
///Second |
|
64 |
///Second coordinate |
|
68 | 65 |
T y; |
... | ... |
@@ -77,4 +74,4 @@ |
77 | 74 |
|
78 |
///This class give back always 2. |
|
79 |
/// |
|
75 |
///The dimension of the vector. |
|
76 |
///This function always returns 2. |
|
80 | 77 |
int size() const { return 2; } |
... | ... |
@@ -140,3 +137,3 @@ |
140 | 137 |
|
141 |
///Return the |
|
138 |
///Return the negative of the vector |
|
142 | 139 |
Point<T> operator-() const { |
... | ... |
@@ -177,5 +174,5 @@ |
177 | 174 |
|
178 |
///Return |
|
175 |
///Return a Point |
|
179 | 176 |
|
180 |
///Return |
|
177 |
///Return a Point. |
|
181 | 178 |
///\relates Point |
... | ... |
@@ -188,3 +185,3 @@ |
188 | 185 |
|
189 |
///Return a vector multiplied by a scalar |
|
186 |
///Return a vector multiplied by a scalar. |
|
190 | 187 |
///\relates Point |
... | ... |
@@ -196,3 +193,3 @@ |
196 | 193 |
|
197 |
///Read a plainvector from a stream |
|
194 |
///Read a plainvector from a stream. |
|
198 | 195 |
///\relates Point |
... | ... |
@@ -224,3 +221,3 @@ |
224 | 221 |
|
225 |
///Write a plainvector to a stream |
|
222 |
///Write a plainvector to a stream. |
|
226 | 223 |
///\relates Point |
... | ... |
@@ -236,3 +233,3 @@ |
236 | 233 |
|
237 |
///Returns |
|
234 |
///Returns the parameter rotated by 90 degrees in positive direction. |
|
238 | 235 |
///\relates Point |
... | ... |
@@ -247,3 +244,3 @@ |
247 | 244 |
|
248 |
///Returns |
|
245 |
///Returns the parameter rotated by 180 degrees. |
|
249 | 246 |
///\relates Point |
... | ... |
@@ -258,3 +255,3 @@ |
258 | 255 |
|
259 |
///Returns |
|
256 |
///Returns the parameter rotated by 90 degrees in negative direction. |
|
260 | 257 |
///\relates Point |
... | ... |
@@ -273,3 +270,2 @@ |
273 | 270 |
/// |
274 |
///\author Attila Bernath |
|
275 | 271 |
template<typename T> |
... | ... |
@@ -288,5 +284,7 @@ |
288 | 284 |
|
289 |
///Construct an instance from two points |
|
290 |
///\warning The coordinates of the bottom-left corner must be no more |
|
291 |
/// |
|
285 |
///Construct an instance from two points. |
|
286 |
///\param a The bottom left corner. |
|
287 |
///\param b The top right corner. |
|
288 |
///\warning The coordinates of the bottom left corner must be no more |
|
289 |
///than those of the top right one. |
|
292 | 290 |
BoundingBox(Point<T> a,Point<T> b) |
... | ... |
@@ -300,5 +298,9 @@ |
300 | 298 |
|
301 |
///Construct an instance from four numbers |
|
302 |
///\warning The coordinates of the bottom-left corner must be no more |
|
303 |
/// |
|
299 |
///Construct an instance from four numbers. |
|
300 |
///\param l The left side of the box. |
|
301 |
///\param b The bottom of the box. |
|
302 |
///\param r The right side of the box. |
|
303 |
///\param t The top of the box. |
|
304 |
///\warning The left side must be no more than the right side and |
|
305 |
///bottom must be no more than the top. |
|
304 | 306 |
BoundingBox(T l,T b,T r,T t) |
... | ... |
@@ -310,3 +312,8 @@ |
310 | 312 |
|
311 |
/// |
|
313 |
///Return \c true if the bounding box is empty. |
|
314 |
|
|
315 |
///Return \c true if the bounding box is empty (i.e. return \c false |
|
316 |
///if at least one point was added to the box or the coordinates of |
|
317 |
///the box were set). |
|
318 |
///The coordinates of an empty bounding box are not defined. |
|
312 | 319 |
bool empty() const { |
... | ... |
@@ -331,3 +338,3 @@ |
331 | 338 |
///Set the bottom left corner. |
332 |
///It should only |
|
339 |
///It should only be used for non-empty box. |
|
333 | 340 |
void bottomLeft(Point<T> p) { |
... | ... |
@@ -347,3 +354,3 @@ |
347 | 354 |
///Set the top right corner. |
348 |
///It should only |
|
355 |
///It should only be used for non-empty box. |
|
349 | 356 |
void topRight(Point<T> p) { |
... | ... |
@@ -363,3 +370,3 @@ |
363 | 370 |
///Set the bottom right corner. |
364 |
///It should only |
|
371 |
///It should only be used for non-empty box. |
|
365 | 372 |
void bottomRight(Point<T> p) { |
... | ... |
@@ -380,3 +387,3 @@ |
380 | 387 |
///Set the top left corner. |
381 |
///It should only |
|
388 |
///It should only be used for non-empty box. |
|
382 | 389 |
void topLeft(Point<T> p) { |
... | ... |
@@ -397,3 +404,3 @@ |
397 | 404 |
///Set the bottom of the box. |
398 |
///It should only |
|
405 |
///It should only be used for non-empty box. |
|
399 | 406 |
void bottom(T t) { |
... | ... |
@@ -413,3 +420,3 @@ |
413 | 420 |
///Set the top of the box. |
414 |
///It should only |
|
421 |
///It should only be used for non-empty box. |
|
415 | 422 |
void top(T t) { |
... | ... |
@@ -429,3 +436,3 @@ |
429 | 436 |
///Set the left side of the box. |
430 |
///It should only |
|
437 |
///It should only be used for non-empty box. |
|
431 | 438 |
void left(T t) { |
... | ... |
@@ -445,3 +452,3 @@ |
445 | 452 |
///Set the right side of the box. |
446 |
///It should only |
|
453 |
///It should only be used for non-empty box. |
|
447 | 454 |
void right(T t) { |
... | ... |
@@ -467,3 +474,3 @@ |
467 | 474 |
///Checks whether a point is inside a bounding box |
468 |
bool inside(const Point<T>& u){ |
|
475 |
bool inside(const Point<T>& u) const { |
|
469 | 476 |
if (_empty) |
... | ... |
@@ -477,2 +484,5 @@ |
477 | 484 |
///Increments a bounding box with a point |
485 |
|
|
486 |
///Increments a bounding box with a point. |
|
487 |
/// |
|
478 | 488 |
BoundingBox& add(const Point<T>& u){ |
... | ... |
@@ -491,3 +501,6 @@ |
491 | 501 |
|
492 |
///Increments a bounding to contain another bounding box |
|
502 |
///Increments a bounding box to contain another bounding box |
|
503 |
|
|
504 |
///Increments a bounding box to contain another bounding box. |
|
505 |
/// |
|
493 | 506 |
BoundingBox& add(const BoundingBox &u){ |
... | ... |
@@ -501,4 +514,10 @@ |
501 | 514 |
///Intersection of two bounding boxes |
502 |
|
|
515 |
|
|
516 |
///Intersection of two bounding boxes. |
|
517 |
/// |
|
518 |
BoundingBox operator&(const BoundingBox& u) const { |
|
503 | 519 |
BoundingBox b; |
520 |
if (this->_empty || u._empty) { |
|
521 |
b._empty = true; |
|
522 |
} else { |
|
504 | 523 |
b.bottom_left.x=std::max(this->bottom_left.x,u.bottom_left.x); |
... | ... |
@@ -507,4 +526,5 @@ |
507 | 526 |
b.top_right.y=std::min(this->top_right.y,u.top_right.y); |
508 |
b._empty = this->_empty || u._empty || |
|
509 |
b.bottom_left.x>top_right.x && b.bottom_left.y>top_right.y; |
|
527 |
b._empty = b.bottom_left.x > b.top_right.x || |
|
528 |
b.bottom_left.y > b.top_right.y; |
|
529 |
} |
|
510 | 530 |
return b; |
... | ... |
@@ -515,6 +535,6 @@ |
515 | 535 |
|
516 |
///Map of x-coordinates of a |
|
536 |
///Map of x-coordinates of a \ref Point "Point"-map |
|
517 | 537 |
|
518 | 538 |
///\ingroup maps |
519 |
///Map of x-coordinates of a |
|
539 |
///Map of x-coordinates of a \ref Point "Point"-map. |
|
520 | 540 |
/// |
... | ... |
@@ -572,3 +592,3 @@ |
572 | 592 |
|
573 |
///This function just returns |
|
593 |
///This function just returns a \ref ConstXMap class. |
|
574 | 594 |
/// |
... | ... |
@@ -582,6 +602,6 @@ |
582 | 602 |
|
583 |
///Map of y-coordinates of a |
|
603 |
///Map of y-coordinates of a \ref Point "Point"-map |
|
584 | 604 |
|
585 | 605 |
///\ingroup maps |
586 |
///Map of y-coordinates of a |
|
606 |
///Map of y-coordinates of a \ref Point "Point"-map. |
|
587 | 607 |
/// |
... | ... |
@@ -601,5 +621,5 @@ |
601 | 621 |
|
602 |
///Returns |
|
622 |
///Returns a \ref YMap class |
|
603 | 623 |
|
604 |
///This function just returns |
|
624 |
///This function just returns a \ref YMap class. |
|
605 | 625 |
/// |
... | ... |
@@ -639,3 +659,3 @@ |
639 | 659 |
|
640 |
///This function just returns |
|
660 |
///This function just returns a \ref ConstYMap class. |
|
641 | 661 |
/// |
... | ... |
@@ -651,6 +671,6 @@ |
651 | 671 |
///\brief Map of the \ref Point::normSquare() "normSquare()" |
652 |
///of |
|
672 |
///of a \ref Point "Point"-map |
|
653 | 673 |
/// |
654 | 674 |
///Map of the \ref Point::normSquare() "normSquare()" |
655 |
///of |
|
675 |
///of a \ref Point "Point"-map. |
|
656 | 676 |
///\ingroup maps |
... | ... |
@@ -672,3 +692,3 @@ |
672 | 692 |
|
673 |
///This function just returns |
|
693 |
///This function just returns a \ref NormSquareMap class. |
|
674 | 694 |
/// |
0 comments (0 inline)