/usr/include/dlib/geometry/drectangle_abstract.h is in libdlib-dev 18.18-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 | // Copyright (C) 2015 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_DRECTANGLe_ABSTRACT_H_
#ifdef DLIB_DRECTANGLe_ABSTRACT_H_
#include "rectangle_abstract.h"
namespace dlib
{
// ----------------------------------------------------------------------------------------
class drectangle
{
/*!
INITIAL VALUE
The initial value of this object is defined by its constructor.
WHAT THIS OBJECT REPRESENTS
This object is just like dlib::rectangle except that it stores the
coordinates of the rectangle using double rather than long variables. As
such, this object represents a rectangular region inside an image. The
region is the rectangle with its top left corner at position (left(),top())
and its bottom right corner at (right(),bottom()).
Note that the origin of the coordinate system, i.e. (0,0), is located at
the upper left corner. That is, points such as (1,1) or (3,5) represent
locations that are below and to the right of the origin.
Also note that rectangles where top() > bottom() or left() > right()
represent empty rectangles.
!*/
public:
drectangle (
);
/*!
ensures
- #left() == 0
- #top() == 0
- #right() == -1
- #bottom() == -1
- #is_empty() == true
!*/
drectangle (
double left_,
double top_,
double right_,
double bottom_
);
/*!
ensures
- #left() == left_
- #top() == top_
- #right() == right_
- #bottom() == bottom_
!*/
drectangle (
const vector<double,2>& p
);
/*!
ensures
- #left() == p.x()
- #top() == p.y()
- #right() == p.x()
- #bottom() == p.y()
!*/
template <typename T, typename U>
drectangle (
const vector<T,2>& p1,
const vector<U,2>& p2
);
/*!
ensures
- #*this == drectangle(p1) + drectangle(p2)
!*/
drectangle (
const drectangle& rect
);
/*!
ensures
- #*this represents the same rectangle as rect
!*/
drectangle (
const rectangle& rect
);
/*!
ensures
- left() == rect.left()
- top() == rect.top()
- right() == rect.right()
- bottom() == rect.bottom()
- dcenter(*this) == dcenter(rect)
- width() == rect.width()
- height() == rect.height()
!*/
operator rectangle (
) const;
/*!
ensures
- returns a rectangle where left(), top(), right(), and bottom() have been
rounded to the nearest integer values.
!*/
double left (
) const;
/*!
ensures
- returns the x coordinate for the left side of this rectangle
!*/
double& left (
);
/*!
ensures
- returns a non-const reference to the x coordinate for the left side
of this rectangle
!*/
double top (
) const;
/*!
ensures
- returns the y coordinate for the top of this rectangle
!*/
double& top (
);
/*!
ensures
- returns a non-const reference to the y coordinate for the
top of this rectangle
!*/
double right (
) const;
/*!
ensures
- returns the x coordinate for the right side of this rectangle
!*/
double& right (
);
/*!
ensures
- returns a non-const reference to the x coordinate for the right
side of this rectangle
!*/
double bottom (
) const;
/*!
ensures
- returns the y coordinate for the bottom of this rectangle
!*/
double& bottom (
);
/*!
ensures
- returns a non-const reference to the y coordinate for the bottom
of this rectangle
!*/
const vector<double,2> tl_corner (
) const;
/*!
ensures
- returns vector<double,2>(left(), top())
(i.e. returns the top left corner point for this rectangle)
!*/
const vector<double,2> bl_corner (
) const;
/*!
ensures
- returns vector<double,2>(left(), bottom())
(i.e. returns the bottom left corner point for this rectangle)
!*/
const vector<double,2> tr_corner (
) const;
/*!
ensures
- returns vector<double,2>(right(), top())
(i.e. returns the top right corner point for this rectangle)
!*/
const vector<double,2> br_corner (
) const;
/*!
ensures
- returns vector<double,2>(right(), bottom())
(i.e. returns the bottom right corner point for this rectangle)
!*/
double width (
) const;
/*!
ensures
- if (is_empty()) then
- returns 0
- else
- returns the width of this rectangle.
(i.e. right() - left() + 1)
!*/
double height (
) const;
/*!
ensures
- if (is_empty()) then
- returns 0
- else
- returns the height of this rectangle.
(i.e. bottom() - top() + 1)
!*/
double area (
) const;
/*!
ensures
- returns width()*height()
!*/
bool is_empty (
) const;
/*!
ensures
- if (top() > bottom() || left() > right()) then
- returns true
- else
- returns false
!*/
drectangle operator + (
const drectangle& rhs
) const;
/*!
ensures
- if (rhs.is_empty() == false && this->is_empty() == false) then
- returns the smallest rectangle that contains both *this and
rhs.
- if (rhs.is_empty() == true && this->is_empty() == false) then
- returns *this
- if (rhs.is_empty() == false && this->is_empty() == true) then
- returns rhs
- if (rhs.is_empty() == true && this->is_empty() == true) then
- returns a rectangle that has is_empty() == true
!*/
drectangle intersect (
const drectangle& rhs
) const;
/*!
ensures
- if (there is a region of intersection between *this and rhs) then
- returns a rectangle that represents the intersection of *this
and rhs.
- else
- returns a rectangle where is_empty() == true
!*/
bool contains (
const vector<double,2>& p
) const;
/*!
ensures
- if (the point (p.x(),p.y()) is contained in this rectangle) then
- returns true
- else
- returns false
!*/
bool contains (
const drectangle& rect
) const
/*!
ensures
- if (rect + *this == *this) then
- returns true
(i.e. returns true if *this contains the given rectangle)
- else
- returns false
!*/
drectangle& operator *= (
const double& scale
);
/*!
ensures
- performs: *this = *this*scale;
- returns #*this
!*/
drectangle& operator /= (
const double& scale
);
/*!
requires
- scale != 0
ensures
- performs: *this = *this*(1.0/scale);
- returns #*this
!*/
drectangle& operator += (
const dlib::vector<double,2>& p
);
/*!
ensures
- performs: *this = *this + drectangle(p)
- returns #*this
!*/
};
// ----------------------------------------------------------------------------------------
void serialize (
const drectangle& item,
std::ostream& out
);
/*!
provides serialization support
!*/
void deserialize (
drectangle& item,
std::istream& in
);
/*!
provides deserialization support
!*/
// ----------------------------------------------------------------------------------------
std::ostream& operator<< (
std::ostream& out,
const drectangle& item
);
/*!
ensures
- writes item to out in the form "[(left, top) (right, bottom)]"
!*/
// ----------------------------------------------------------------------------------------
std::istream& operator>>(
std::istream& in,
drectangle& item
);
/*!
ensures
- reads a drectangle from the input stream in and stores it in #item. The data
in the input stream should be of the form [(left, top) (right, bottom)]
!*/
// ----------------------------------------------------------------------------------------
vector<double,2> center (
const drectangle& rect
);
/*!
ensures
- returns the center of the given rectangle
!*/
// ----------------------------------------------------------------------------------------
vector<double,2> dcenter (
const drectangle& rect
);
/*!
ensures
- returns the center of the given rectangle. (Both center() and dcenter() are
identical when applied to drectangle objects)
!*/
// ----------------------------------------------------------------------------------------
drectangle operator* (
const drectangle& rect,
const double& scale
);
/*!
ensures
- This function returns a rectangle that has the same center as rect but with
dimensions that are scale times larger. That is, we return a new rectangle R
such that:
- center(R) == center(rect)
- R.right()-R.left() == (rect.right()-rect.left())*scale
- R.bottom()-R.top() == (rect.bottom()-rect.top())*scale
!*/
// ----------------------------------------------------------------------------------------
drectangle operator* (
const double& scale,
const drectangle& rect
);
/*!
ensures
- returns rect*scale
!*/
// ----------------------------------------------------------------------------------------
drectangle operator/ (
const drectangle& rect,
const double& scale
);
/*!
ensures
- returns rect*(1.0/scale)
!*/
// ----------------------------------------------------------------------------------------
drectangle operator+ (
const drectangle& r,
const vector<double,2>& p
);
/*!
ensures
- returns r + drectangle(p)
(i.e. returns the rectangle that contains both r and p)
!*/
// ----------------------------------------------------------------------------------------
drectangle operator+ (
const vector<double,2>& p,
const drectangle& r
);
/*!
ensures
- returns r + drectangle(p)
(i.e. returns the rectangle that contains both r and p)
!*/
// ----------------------------------------------------------------------------------------
template <typename T>
drectangle translate_rect (
const drectangle& rect,
const vector<T,2>& p
);
/*!
ensures
- returns a rectangle R such that:
- R.left() == rect.left() + p.x()
- R.right() == rect.right() + p.x()
- R.top() == rect.top() + p.y()
- R.bottom() == rect.bottom() + p.y()
!*/
// ----------------------------------------------------------------------------------------
drectangle intersect (
const drectangle& a,
const drectangle& b
);
/*!
ensures
- returns a.intersect(b)
(i.e. returns a rectangle representing the intersection of a and b)
!*/
// ----------------------------------------------------------------------------------------
double area (
const drectangle& a
);
/*!
ensures
- returns a.area()
!*/
// ----------------------------------------------------------------------------------------
drectangle centered_drect (
const vector<double,2>& p,
double width,
double height
);
/*!
ensures
- returns a rectangle R such that:
- center(R) == p
- if (width < 1 || height < 1)
- R.width() == 0
- R.height() == 0
- R.is_empty() == true
- else
- R.width() == width
- R.height() == height
!*/
// ----------------------------------------------------------------------------------------
drectangle centered_drect (
const drectangle& rect,
double width,
double height
);
/*!
ensures
- returns centered_drect(center(rect), width, height)
!*/
// ----------------------------------------------------------------------------------------
const drectangle shrink_rect (
const drectangle& rect,
double num
);
/*!
ensures
- returns drectangle(rect.left()+num, rect.top()+num, rect.right()-num, rect.bottom()-num)
(i.e. shrinks the given drectangle by shrinking its border by num)
!*/
// ----------------------------------------------------------------------------------------
const drectangle grow_rect (
const drectangle& rect,
double num
);
/*!
ensures
- return shrink_rect(rect, -num)
(i.e. grows the given drectangle by expanding its border by num)
!*/
// ----------------------------------------------------------------------------------------
const drectangle shrink_rect (
const drectangle& rect,
double width,
double height
);
/*!
ensures
- returns drectangle(rect.left()+width, rect.top()+height, rect.right()-width, rect.bottom()-height)
(i.e. shrinks the given drectangle by shrinking its left and right borders by width
and its top and bottom borders by height. )
!*/
// ----------------------------------------------------------------------------------------
const drectangle grow_rect (
const drectangle& rect,
double width,
double height
);
/*!
ensures
- return shrink_rect(rect, -width, -height)
(i.e. grows the given drectangle by expanding its border)
!*/
// ----------------------------------------------------------------------------------------
drectangle set_aspect_ratio (
const drectangle& rect,
double ratio
);
/*!
requires
- ratio > 0
ensures
- This function reshapes the given rectangle so that it has the given aspect
ratio. In particular, this means we return a rectangle R such that the
following equations are true:
- R.width()/R.height() == ratio
- R.area() == rect.area()
- dcenter(rect) == dcenter(R)
!*/
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_DRECTANGLe_ABSTRACT_H_
|