/usr/include/x86_64-linux-gnu/visp3/core/vpList.h is in libvisp-core-dev 3.0.0-4.
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 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 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 | /****************************************************************************
*
* This file is part of the ViSP software.
* Copyright (C) 2005 - 2015 by Inria. All rights reserved.
*
* This software is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* ("GPL") version 2 as published by the Free Software Foundation.
* See the file LICENSE.txt at the root directory of this source
* distribution for additional information about the GNU GPL.
*
* For using ViSP with software that can not be combined with the GNU
* GPL, please contact Inria about acquiring a ViSP Professional
* Edition License.
*
* See http://visp.inria.fr for more information.
*
* This software was developed at:
* Inria Rennes - Bretagne Atlantique
* Campus Universitaire de Beaulieu
* 35042 Rennes Cedex
* France
*
* If you have questions regarding the use of this file, please contact
* Inria at visp@inria.fr
*
* This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
* WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*
* Description:
* List data structure.
*
* Authors:
* Eric Marchand
* Nicolas Mansard : Toward const-specification respect
*
*****************************************************************************/
#ifndef VP_LIST_H
#define VP_LIST_H
/*!
\file vpList.h
\brief Definition of the list managment class
*/
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpDebug.h>
#include <visp3/core/vpException.h>
#include <stdio.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/*!
\class vpListElement
\brief Each element of a list
*/
template <class type>
class vpListElement
{
//private:
// vpListElement(const vpListElement &)
// : prev(NULL), next(NULL), val()
// {
// throw vpException(vpException::functionNotImplementedError,"Not implemented!");
// }
// vpListElement &operator=(const vpListElement &){
// throw vpException(vpException::functionNotImplementedError,"Not implemented!");
// return *this;
// }
public:
vpListElement() : prev(NULL), next(NULL), val() {};
vpListElement<type> *prev; //<! pointer to the previous element in the list
vpListElement<type> *next; //<! pointer to the next element in the list
type val; //<! value of the element
} ;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
/*!
\class vpList
\brief Provide simple list management
\verbatim
Data structure:
each object vpListElement contains its own value and
two pointers to the next element of the list and to the previous one
A list is mainly a pointer to three of these elements
- one (cur) points the current element
- one (first) points to a virtual element located at the
beginning of the list
- one (last) points to a virtual element located at the
end of the list
first, last and cur are used internally and are not to be considered
by "basic" user.
Notation:
In this documentation we note such a list as
[*, a, b, c, *]
f ^ l
where
- the * are the two virtual elements (first (f) and last (l))
- the ^ denotes the position of the current element
\endverbatim
*/
template <class type>
class vpList
{
private:
void init() ;
public:
unsigned int nb; //<! number of items in the List
/*!
\brief the first virtual item in the list
\verbatim
[*, a, b, c, *]
f
\endverbatim
*/
vpListElement<type> *first;
/*!
\brief the last virtualitem in the list
\verbatim
[*, a, b, c, *]
l
\endverbatim
*/
vpListElement<type> *last;
/*!
\brief the current item in the list
\verbatim
[*, a, b, c, *]
^
\endverbatim
*/
vpListElement<type> *cur; // the current element
public:
vpList() ; // constr.
vpList(const vpList& l); // cloning
virtual ~vpList(); // destr.
inline void next(void) ; // current element's successor ( cur = cur->next )
inline void previous(void) ; // current element's predecessor ( cur = cur->pred )
inline void front(void) ; // go to the front of the List (cur = first)
inline void end(void) ; // go back to the end of the List ( cur = last )
inline bool outside(void) const; // test whether we are outside the List
bool empty(void) const; // tests whether the List is empty
inline type& value(void); // returns the current element value
inline const type& value(void) const; // returns the current element value
void suppress(void); // deletes the current item
void kill(); // empties the List
void display() ; // displays the content of the list
void print() {display() ;} // displays the content of the list
inline void addRight(const type& el); // inserts an element on the right
inline void addLeft(const type& el); // inserts an element on the left
inline void modify(const type& el); // modifies thevalue field of the curr. el.
inline void addRight(type& el); // inserts an element on the right
inline void addLeft(type& el); // inserts an element on the left
inline void swapLeft(); // Switch the current element with the element on the left
inline void swapRight(); // Switch the current element with the element on the right
inline unsigned int nbElement(void); // returns the number of items currently in the list
inline unsigned int nbElements(void); // returns the number of items currently in the list
vpList<type>& operator=(const vpList<type>& l);
inline void operator+=(vpList<type>& l);
inline void operator+=(const type& l);
// Other non fundamental member (may be somehow useful)
bool nextOutside(void) const; // test whether we are outside the List
bool previousOutside(void) const;// test whether we are outside the List
type& previousValue(void); // returns the previous element value
type& nextValue(void); // returns the next element value
type& firstValue(void) ;
type& lastValue(void) ;
};
/*!
\brief initialization, Create an empty list
\verbatim
init() --> [*, *]
\endverbatim */
template<class type>
void vpList<type>::init()
{
vpListElement<type> *x=new vpListElement<type>;
vpListElement<type> *y=new vpListElement<type> ;
first = x ;
last = y ;
x->prev = NULL ;
x->next = y ;
y->prev = x ;
y->next =NULL ;
cur = x ;
nb = 0 ;
}
/*!
\brief Basic constructor, initialization, Create an empty list
\verbatim
init() --> [*, *]
\endverbatim
\sa init()
*/
template<class type>
vpList<type>::vpList() : nb(0), first(NULL), last(NULL), cur(NULL)
{
init() ;
}
/*!
\brief vpList destructor
\sa kill()
*/
template<class type>
vpList<type>::~vpList()
{
kill() ;
/*if (first != NULL) */ delete first ;
/*if (last != NULL) */ delete last ;
}
/*!
\brief return the number of element in the list
*/
template<class type>
unsigned int vpList<type>::nbElement(void)
{
return(nb) ;
}
/*!
\brief return the number of element in the list
*/
template<class type>
unsigned int vpList<type>::nbElements(void)
{
return(nb) ;
}
/*!
\brief position the current element on the next one
\verbatim
[*, a, b, c, d, *] --> next() --> [*, a, b, c, d, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::next(void)
{
cur = cur->next ;
}
/*!
\brief position the current element on the previous one
\verbatim
[*, a, b, c, d, *] --> previous() --> [*, a, b, c, d, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::previous(void)
{
cur = cur->prev ;
}
/*!
\brief return the value of the current element
\verbatim
[*, a, b, c, *] --> value() return b
^
\endverbatim
*/
template<class type>
type& vpList<type>::value(void)
{
return(cur->val) ;
}
/*!
\brief return the value of the current element using a const ref.
\verbatim
[*, a, b, c, *] --> value() return b
^
\endverbatim
*/
template<class type>
const type& vpList<type>::value(void) const
{
return(cur->val) ;
}
/*!
\brief return the value of the previous element
\verbatim
[*, a, b, c, *] --> previousValue() return a
^
\endverbatim
*/
template<class type>
type& vpList<type>::previousValue(void)
{
return(cur->prev->val) ;
}
/*!
\brief return the value of the next element
\verbatim
[*, a, b, c, d, *] --> nextValue() return c
^
\endverbatim
*/
template<class type>
type& vpList<type>::nextValue(void)
{
return(cur->next->val) ;
}
/*!
\brief return the first element of the list
\verbatim
[*, a, b, c, d, *] --> firstValue() return a
\endverbatim
*/
template<class type>
type& vpList<type>::firstValue(void)
{
return(first->next->val) ;
}
/*!\brief return the last element of the list
\verbatim
[*, a, b, c, d, *] --> lastValue() return d
\endverbatim
*/
template<class type>
type& vpList<type>::lastValue(void)
{
return(last->prev->val) ;
}
/*!
\brief Position the current element on the first element of the list
\verbatim
[*, a, b, c, d, *] --> front() --> [*, a, b, c, d, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::front(void)
{
cur = first->next ;
}
/*!
\brief Position the current element on the last element of the list
\verbatim
[*, a, b, c, d, *] --> end() --> [*, a, b, c, d, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::end(void)
{
cur = last->prev ;
}
/*!
\brief Test if the list is empty
\verbatim
[*, a, b, c, d, *] --> empty return false
[*, *] --> empty return true
\endverbatim
*/
template<class type>
bool vpList<type>::empty(void) const
{
return((first->next == last) &&( first == last->prev)) ;
}
/*!
\brief Test if the current element is outside the list
(on the virtual element)
\verbatim
[*, a, b, c, d, *] --> outside return false
^
[*, a, b, c, d, *] --> outside return true
^ or ^
\endverbatim
*/
template<class type>
bool vpList<type>::outside(void) const
{
return((cur==first)||(cur==last)) ;
}
/*!
\brief Test if the next element is outside the list
(ie if the current element is the last one)
\verbatim
[*, a, b, c, d, *] --> nextOutside return true
^
\endverbatim
*/
template<class type>
bool vpList<type>::nextOutside(void) const
{
return((cur->next==first)||(cur->next==last)) ;
}
/*!
\brief Test if the previous element is outside the list
(ie if the current element is the firts one)
\verbatim
[*, a, b, c, d, *] --> nextOutside return true
^
\endverbatim
*/
template<class type>
bool vpList<type>::previousOutside(void) const
{
return((cur->prev==first)||(cur->prev==last)) ;
}
/*!
\brief add a new element in the list, at the right of the current one
\warning the new element becomes the current one
\verbatim
[*, a, b, c, *] --> addRight(i) --> [*, a, b, i, c, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::addRight(const type& v)
{
vpListElement<type> *x=new vpListElement<type>;
x->val = v ;
if (empty())
{
cur = first ;
}
else
{
if (outside()) std::cout << "vpList: outside with addRight " << std::endl ;
}
cur->next->prev = x ;
x->next = cur->next ;
x->prev = cur ;
cur->next = x ;
cur = x ;
nb++ ;
}
/*!
\brief add a new element in the list, at the left of the current one
\warning the new element becomes the current one
\verbatim
[*, a, b, c, *] --> addLeft(i) --> [*, a, i, b, c, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::addLeft(const type& v)
{
vpListElement<type> *x=new vpListElement<type>;
x->val = v ;
if (empty())
{
cur = last ;
}
else
{
if (outside()) std::cout << "vpList: outside with addLeft " << std::endl ;
}
x->next = cur ;
x->prev = cur->prev ;
cur->prev->next = x ;
cur->prev = x ;
cur = x ;
nb++ ;
}
/*!
\brief add a new element in the list, at the right of the current one
\warning the new element becomes the current one
\verbatim
[*, a, b, c, *] --> addRight(i) --> [*, a, b, i, c, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::addRight(type& v)
{
vpListElement<type> *x=new vpListElement<type>;
x->val = v ;
if (empty())
{
cur = first ;
}
else
{
if (outside()) std::cout << "vpList: outside with addRight " << std::endl ;
}
cur->next->prev = x ;
x->next = cur->next ;
x->prev = cur ;
cur->next = x ;
cur = x ;
nb++ ;
}
/*!
\brief add a new element in the list, at the left of the current one
\warning the new element becomes the current one
\verbatim
[*, a, b, c, *] --> addLeft(i) --> [*, a, i, b, c, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::addLeft(type& v)
{
vpListElement<type> *x=new vpListElement<type>;
x->val = v ;
if (empty())
{
cur = last ;
}
else
{
if (outside()) std::cout << "vpList: outside with addLeft " << std::endl ;
}
x->next = cur ;
x->prev = cur->prev ;
cur->prev->next = x ;
cur->prev = x ;
cur = x ;
nb++ ;
}
/*!
\brief Modify the value of the current element
\verbatim
[*, a, b, c, *] --> modify(i) --> [*, a, i, c, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::modify(const type& v)
{
cur->val = v ;
}
/*!
\brief Switch the current element with the element on the left
\verbatim
[*, a, b, c, *] --> swapLeft --> [*, b, a, c, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::swapLeft()
{
if (cur->prev != first)
{
cur->prev->prev->next = cur;
cur->next->prev = cur->prev;
vpListElement<type> *nextTmp;
vpListElement<type> *prevTmp;
nextTmp = cur->next;
prevTmp = cur->prev;
cur->next = cur->prev;
cur->prev = cur->prev->prev;
prevTmp->prev = cur;
prevTmp->next = nextTmp;
}
else
{
std::cout << "vpList: previous element is outside (swapLeft) " << std::endl ;
}
}
/*!
\brief Switch the current element with the element on the right
\verbatim
[*, a, b, c, *] --> swapRight --> [*, a, c, b, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::swapRight()
{
if (cur->next != last)
{
cur->prev->next = cur->next;
cur->next->next->prev = cur;
vpListElement<type> *nextTmp;
vpListElement<type> *prevTmp;
nextTmp = cur->next;
prevTmp = cur->prev;
cur->next = nextTmp->next;
cur->prev = nextTmp;
nextTmp->prev = prevTmp;
nextTmp->next = cur;
}
else
{
std::cout << "vpList: next element is outside (swapRight) " << std::endl ;
}
}
/*!
\brief Destroy the list
\verbatim
[*, a, b, c, *] --> kill --> [*, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::kill()
{
front() ;
while (!empty())
{
suppress() ;
}
}
/*!
\brief suppress the current element
\warning new current element is on the next one
\verbatim
[*, a, b, c, d, *] --> suppress --> [*, a, c, d, *]
^ ^
\endverbatim
*/
template<class type>
void vpList<type>::suppress(void)
{
vpListElement<type> *x ;
cur->prev->next = cur->next ;
cur->next->prev = cur->prev ;
x = cur ;
cur = cur->next ;
if (x!=NULL) delete x ;
nb-- ;
}
/*!
\brief Copy constructor const
\param l : the list to copy
*/
template<class type>
vpList<type>& vpList<type>::operator=(const vpList<type>& l)
{
type x ;
vpListElement<type> *e ;
kill() ;
e = l.first->next ;
front() ;
while (e!=l.last)
{
x = e->val ;
addRight(x) ;
e = e->next ;
}
nb = l.nb ;
cur = first->next ;
return *this;
}
/*!
\brief Append two lists
\verbatim
[*, a, b, *] += [*, c, d, *] --> [*, a, b, c, d, *]
^
\endverbatim
*/
template<class type>
void vpList<type>::operator+=(vpList<type>& l)
{
type x ;
l.front() ;
end() ;
while (!l.outside())
{
x = l.value() ;
addRight(x) ;
l.next() ;
}
}
/*!
\brief Append an element to a list
\verbatim
[*, a, b, *] += c --> [*, a, b, c, *]
^
\endverbatim
*/
template<class type>
void vpList<type>::operator += (const type& l)
{
end() ;
addRight(l) ;
}
/*!
\brief copy constructor
\param l : the list to copy
*/
template<class type>
vpList<type>::vpList(const vpList<type>& l)
: nb(0), first(NULL), last(NULL), cur(NULL)
{
init() ;
*this = l;
}
/*!
\brief Print (std::cout) all the element of the list
*/
template<class type>
void vpList<type>::display()
{
unsigned int k = 1 ;
front() ;
while(!outside()) {
std::cout<<k<<" ---> "<<value()<<std::endl ;
next() ;
k++ ;
}
std::cout<< std::endl << std::endl ;
}
#endif /* #ifndef VP_LIST_H */
/*
* Local variables:
* c-basic-offset: 2
* End:
*/
|