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
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
|
// Copyright (C) 2005 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_RECTANGLe_ABSTRACT_
#ifdef DLIB_RECTANGLe_ABSTRACT_
#include "vector_abstract.h"
#include <iostream>
#include "../serialize.h"
namespace dlib
{
class rectangle
{
/*!
INITIAL VALUE
The initial value of this object is defined by its constructor.
WHAT THIS OBJECT REPRESENTS
This object represents a rectangular region inside a Cartesian
coordinate system. 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:
rectangle (
const rectangle& rect
);
/*!
ensures
- #*this represents the same rectangle as rect
!*/
rectangle (
);
/*!
ensures
- #left() == 0
- #top() == 0
- #right() == -1
- #bottom() == -1
- #is_empty() == true
!*/
rectangle (
long left_,
long top_,
long right_,
long bottom_
);
/*!
ensures
- #left() == left_
- #top() == top_
- #right() == right_
- #bottom() == bottom_
!*/
rectangle (
unsigned long width_,
unsigned long height_
);
/*!
requires
- (width_ > 0 && height_ > 0) || (width_ == 0 && height_ == 0)
ensures
- #left() == 0
- #top() == 0
- #width() == width_
- #height() == height_
!*/
rectangle (
const point& p
);
/*!
ensures
- #left() == p.x()
- #top() == p.y()
- #right() == p.x()
- #bottom() == p.y()
!*/
template <typename T>
rectangle (
const vector<T,2>& p1,
const vector<T,2>& p2
);
/*!
ensures
- #*this == rectangle(p1) + rectangle(p2)
!*/
long left (
) const;
/*!
ensures
- returns the x coordinate for the left side of this rectangle
!*/
long& left (
);
/*!
ensures
- returns a non-const reference to the x coordinate for the left side
of this rectangle
!*/
void set_left (
long left_
);
/*!
ensures
- #left() == left_
!*/
long top (
) const;
/*!
ensures
- returns the y coordinate for the top of this rectangle
!*/
long& top (
);
/*!
ensures
- returns a non-const reference to the y coordinate for the
top of this rectangle
!*/
void set_top (
long top_
);
/*!
ensures
- #top() == top_
!*/
long right (
) const;
/*!
ensures
- returns the x coordinate for the right side of this rectangle
!*/
long& right (
);
/*!
ensures
- returns a non-const reference to the x coordinate for the right
side of this rectangle
!*/
void set_right (
long right_
);
/*!
ensures
- #right() == right_
!*/
long bottom (
) const;
/*!
ensures
- returns the y coordinate for the bottom of this rectangle
!*/
long& bottom (
);
/*!
ensures
- returns a non-const reference to the y coordinate for the bottom
of this rectangle
!*/
void set_bottom (
long bottom_
);
/*!
ensures
- #bottom() == bottom_
!*/
const point tl_corner (
) const;
/*!
ensures
- returns point(left(), top())
(i.e. returns the top left corner point for this rectangle)
!*/
const point bl_corner (
) const;
/*!
ensures
- returns point(left(), bottom())
(i.e. returns the bottom left corner point for this rectangle)
!*/
const point tr_corner (
) const;
/*!
ensures
- returns point(right(), top())
(i.e. returns the top right corner point for this rectangle)
!*/
const point br_corner (
) const;
/*!
ensures
- returns point(right(), bottom())
(i.e. returns the bottom right corner point for this rectangle)
!*/
bool is_empty (
) const;
/*!
ensures
- if (top() > bottom() || left() > right()) then
- returns true
- else
- returns false
!*/
unsigned long width (
) const;
/*!
ensures
- if (is_empty()) then
- returns 0
- else
- returns the width of this rectangle.
(i.e. right() - left() + 1)
!*/
unsigned long height (
) const;
/*!
ensures
- if (is_empty()) then
- returns 0
- else
- returns the height of this rectangle.
(i.e. bottom() - top() + 1)
!*/
unsigned long area (
) const;
/*!
ensures
- returns width()*height()
!*/
rectangle operator + (
const rectangle& 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
!*/
rectangle intersect (
const rectangle& 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 (
long x,
long y
) const;
/*!
ensures
- if (the point (x,y) is contained in this rectangle) then
- returns true
- else
- returns false
!*/
bool contains (
const point& p
) const;
/*!
ensures
- if (the point (p.x(),p.y()) is contained in this rectangle) then
- returns true
- else
- returns false
!*/
bool contains (
const rectangle& rect
) const;
/*!
ensures
- if (rect + *this == *this) then
- returns true
(i.e. returns true if *this contains the given rectangle)
- else
- returns false
!*/
rectangle& operator= (
const rectangle& rect
);
/*!
ensures
- #*this represents the same rectangle as rect
- returns #*this
!*/
rectangle& operator+= (
const rectangle& rect
);
/*!
ensures
- #*this == *this + rect
- returns #*this
!*/
bool operator== (
const rectangle& rect
) const;
/*!
ensures
- if (top() == rect.top() && left() == rect.left() &&
right() == rect.right() && bottom() == rect.bottom()) then
- returns true
- else
- returns false
!*/
bool operator!= (
const rectangle& rect
) const;
/*!
ensures
- returns !(*this == rect)
!*/
};
// ----------------------------------------------------------------------------------------
void serialize (
const rectangle& item,
std::ostream& out
);
/*!
provides serialization support
!*/
void deserialize (
rectangle& item,
std::istream& in
);
/*!
provides deserialization support
!*/
std::ostream& operator<< (
std::ostream& out,
const rectangle& item
);
/*!
ensures
- writes item to out in the form "[(left, top) (right, bottom)]"
!*/
std::istream& operator>>(
std::istream& in,
rectangle& item
);
/*!
ensures
- reads a rectangle 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)]
!*/
// ----------------------------------------------------------------------------------------
point center (
const dlib::rectangle& rect
);
/*!
ensures
- returns the center of the given rectangle
!*/
// ----------------------------------------------------------------------------------------
dlib::vector<double,2> dcenter (
const dlib::rectangle& rect
);
/*!
ensures
- returns the center of the given rectangle using a real valued vector.
!*/
// ----------------------------------------------------------------------------------------
inline const rectangle centered_rect (
const point& p,
unsigned long width,
unsigned long height
);
/*!
ensures
- returns a rectangle R such that:
- center(R) == p
- if (width == 0 || height == 0)
- R.width() == 0
- R.height() == 0
- else
- R.width() == width
- R.height() == height
- R.tl_corner() == point(p.x()-width/2, p.y()-height/2)
!*/
// ----------------------------------------------------------------------------------------
const rectangle centered_rect (
long x,
long y,
unsigned long width,
unsigned long height
);
/*!
ensures
- returns a rectangle R such that:
- center(R) == p
- if (width == 0 || height == 0)
- R.width() == 0
- R.height() == 0
- else
- R.width() == width
- R.height() == height
- R.tl_corner() == point(x-width/2, y-height/2)
!*/
// ----------------------------------------------------------------------------------------
inline const rectangle centered_rect (
const rectangle& rect,
unsigned long width,
unsigned long height
);
/*!
ensures
- returns centered_rect( (rect.tl_corner() + rect.br_corner())/2, width, height)
(i.e. returns a rectangle centered on rect but with the given width
and height)
!*/
// ----------------------------------------------------------------------------------------
inline const rectangle shrink_rect (
const rectangle& rect,
long num
);
/*!
ensures
- returns rectangle(rect.left()+num, rect.top()+num, rect.right()-num, rect.bottom()-num)
(i.e. shrinks the given rectangle by shrinking its border by num)
!*/
// ----------------------------------------------------------------------------------------
inline const rectangle grow_rect (
const rectangle& rect,
long num
);
/*!
ensures
- return shrink_rect(rect, -num)
(i.e. grows the given rectangle by expanding its border by num)
!*/
// ----------------------------------------------------------------------------------------
inline const rectangle shrink_rect (
const rectangle& rect,
long width,
long height
);
/*!
ensures
- returns rectangle(rect.left()+width, rect.top()+height, rect.right()-width, rect.bottom()-height)
(i.e. shrinks the given rectangle by shrinking its left and right borders by width
and its top and bottom borders by height. )
!*/
// ----------------------------------------------------------------------------------------
inline const rectangle grow_rect (
const rectangle& rect,
long width,
long height
);
/*!
ensures
- return shrink_rect(rect, -width, -height)
(i.e. grows the given rectangle by expanding its border)
!*/
// ----------------------------------------------------------------------------------------
const rectangle translate_rect (
const rectangle& rect,
const point& 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()
!*/
// ----------------------------------------------------------------------------------------
const rectangle translate_rect (
const rectangle& rect,
long x,
long y
);
/*!
ensures
- returns a rectangle R such that:
- R.left() == rect.left() + x
- R.right() == rect.right() + x
- R.top() == rect.top() + y
- R.bottom() == rect.bottom() + y
!*/
// ----------------------------------------------------------------------------------------
const rectangle resize_rect (
const rectangle& rect,
unsigned long width,
unsigned long height
);
/*!
ensures
- returns a rectangle R such that:
- if (width == 0 || height == 0)
- R.width() == 0
- R.height() == 0
- else
- R.width() == width
- R.height() == height
- R.left() == rect.left()
- R.top() == rect.top()
!*/
// ----------------------------------------------------------------------------------------
const rectangle resize_rect_width (
const rectangle& rect,
unsigned long width
);
/*!
ensures
- returns a rectangle R such that:
- R.width() == width
- R.left() == rect.left()
- R.top() == rect.top()
- R.bottom() == rect.bottom()
!*/
// ----------------------------------------------------------------------------------------
const rectangle resize_rect_height (
const rectangle& rect,
unsigned long height
);
/*!
ensures
- returns a rectangle R such that:
- R.height() == height
- R.left() == rect.left()
- R.top() == rect.top()
- R.right() == rect.right()
!*/
// ----------------------------------------------------------------------------------------
const rectangle move_rect (
const rectangle& rect,
const point& p
);
/*!
ensures
- returns a rectangle R such that:
- R.width() == rect.width()
- R.height() == rect.height()
- R.left() == p.x()
- R.top() == p.y()
!*/
// ----------------------------------------------------------------------------------------
const rectangle move_rect (
const rectangle& rect,
long x,
long y
);
/*!
ensures
- returns a rectangle R such that:
- R.width() == rect.width()
- R.height() == rect.height()
- R.left() == x
- R.top() == y
!*/
// ----------------------------------------------------------------------------------------
inline const point nearest_point (
const rectangle& rect,
const point& p
);
/*!
ensures
- if (rect.contains(p)) then
- returns p
- else
- returns the point in rect that is closest to p
!*/
// ----------------------------------------------------------------------------------------
inline long distance_to_rect_edge (
const rectangle& rect,
const point& p
);
/*!
ensures
- returns the Manhattan distance between the edge of rect and p.
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
const rectangle get_rect (
const T& m
);
/*!
requires
- T has nr() and nc() functions that return longs
ensures
- returns rectangle(0, 0, m.nc()-1, m.nr()-1)
(i.e. assuming T represents some kind of rectangular grid, such as
the dlib::matrix or dlib::array2d objects, this function returns the
bounding rectangle for that gridded object.)
!*/
// ----------------------------------------------------------------------------------------
inline rectangle operator+ (
const rectangle& r,
const point& p
);
/*!
ensures
- returns r + rectangle(p)
(i.e. returns the rectangle that contains both r and p)
!*/
// ----------------------------------------------------------------------------------------
inline rectangle operator+ (
const point& p,
const rectangle& r
);
/*!
ensures
- returns r + rectangle(p)
(i.e. returns the rectangle that contains both r and p)
!*/
// ----------------------------------------------------------------------------------------
}
namespace std
{
/*!
Define std::less<rectangle> so that you can use rectangles in the associative containers.
!*/
template<>
struct less<dlib::rectangle> : public binary_function<dlib::rectangle,dlib::rectangle,bool>
{
inline bool operator() (const dlib::rectangle& a, const dlib::rectangle& b) const
{
if (a.left() < b.left()) return true;
else if (a.left() > b.left()) return false;
else if (a.top() < b.top()) return true;
else if (a.top() > b.top()) return false;
else if (a.right() < b.right()) return true;
else if (a.right() > b.right()) return false;
else if (a.bottom() < b.bottom()) return true;
else if (a.bottom() > b.bottom()) return false;
else return false;
}
};
}
#endif // DLIB_RECTANGLe_ABSTRACT_
|
