IRIX Base Documentation 2001 May/SGI IRIX Base Documentation 2001 May.iso/usr/share/catman/p_man/cat3/librw/RWTPtrHashMultiSetIterator.z/RWTPtrHashMultiSetIterator

Text File | 1998-10-30 | 8.6 KB | 199 lines

RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))              RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



NNNNaaaammmmeeee
     RWTPtrHashMultiSetIterator<T,H,EQ> - Rogue Wave library class

SSSSyyyynnnnooooppppssssiiiissss
              #include<rw/tphasht.h>



              RWTPtrHashMultiSet<T,H,EQ> m;
          RWTPtrHashMultiSet<T,H,EQ> itr(m);






PPPPlllleeeeaaaasssseeee NNNNooootttteeee!!!!
     IIIIffff yyyyoooouuuu hhhhaaaavvvveeee tttthhhheeee SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ddddeeeessssccccrrrriiiibbbbeeeedddd hhhheeeerrrreeee....
     OOOOtttthhhheeeerrrrwwwwiiiisssseeee,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ffffoooorrrr RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr described in
     Appendix A.


DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
     RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr is supplied with TTTToooooooollllssss....hhhh++++++++ 7.x to provide an
     iterator interface to the Standard Library based collections that has
     backward compatibility with the container iterators provided in TTTToooooooollllssss....hhhh++++++++
     6.x. Iteration over an RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeetttt is pseudorandom and dependent
     on the capacity of the underlying hash table and the hash function being
     used.  The only useable relationship between consecutive elements is that
     all elements which are defined to be equivalent by the equivalence
     object, EEEEQQQQ, will remain adjacent.  The current item referenced by this
     iterator is undefined after construction or after a call to rrrreeeesssseeeetttt(((())))
     operation.  The iterator becomes valid after being advanced with either a
     preincrement or ooooppppeeeerrrraaaattttoooorrrr(((()))).  For both ooooppppeeeerrrraaaattttoooorrrr++++++++ and ooooppppeeeerrrraaaattttoooorrrr(((()))),
     iterating past the last element will return a value equivalent to boolean
     ffffaaaallllsssseeee.  Continued increments will return a value equivalent to ffffaaaallllsssseeee
     until rrrreeeesssseeeetttt(((()))) is called.

PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
     None

EEEExxxxaaaammmmpppplllleeeessss
              #include<rw/tphasht.h>



              #include<iostream.h>
          #include<rw/cstring.h>
          struct silly_h{
             unsigned long operator()(RWCString x) const
               { return x.length() * (long)x(0); }
          };



                                                                        PPPPaaaaggggeeee 1111






RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))              RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



          int main(){
             RWTPtrHashMultiSet<RWCString,silly_h,equal_to<RWCString> > age;
             RWTPtrHashMultiSetIterator
             <RWCString,silly_h,equal_to<RWCString> > itr(age);
             age.insert(new RWCString("John"));
             age.insert(new RWCString("Steve"));
             age.insert(new RWCString("Mark"));
             age.insert(new RWCString("Steve"));
             for(;++itr;)
               cout << *itr.key() << endl;
             return 0;
          }
          Program Output (not necessarily in this order)
          John
          Mark
          Steve

PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
     Steve



              RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr<<<<TTTT,,,,HHHH,,,,EEEEQQQQ>>>>
          (RWTPtrHashMultiSet<T,H,EQ>&h);


     Creates an iterator for the hashed multi-set hhhh.  The iterator begins in
     an undefined state and must be advanced before the first element will be
     accessible.

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrrssss
              T*
          ooooppppeeeerrrraaaattttoooorrrr(((())))();


     Advances self to the next element, dereferences the resulting iterator
     and returns its value.  If the iterator has advanced past the last item
     in the container,  the element returned will be a nnnniiiillll pointer equivalent
     to boolean ffffaaaallllsssseeee.

              RWBoolean
          ooooppppeeeerrrraaaattttoooorrrr++++++++();


     Advances self to the next element.  If the iterator has been reset or
     just created self will now reference the first element.  If, before
     iteration, self referenced the last association in the multiset, self
     will now reference an undefined value and a value equivalent to ffffaaaallllsssseeee
     will be returned.  Otherwise, a value equivalent to ttttrrrruuuueeee is returned.






                                                                        PPPPaaaaggggeeee 2222






RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))              RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))



     Note: no post-increment operator is provided.

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
              RWTPtrHashMultiSet<T,H,EQ>*
          ccccoooonnnnttttaaaaiiiinnnneeeerrrr(((()))) const;


     Returns a pointer to the collection being iterated over.

              T*
          kkkkeeeeyyyy() const;


     Returns the value  currently referenced by sssseeeellllffff. Undefined if self is not
     referencing a value within the multiset.

              void
          rrrreeeesssseeeetttt();
          void
          rrrreeeesssseeeetttt(RWTPtrHashMultiSet<T,H,EQ>& h);


     Resets the iterator so that after being advanced it will reference the
     first element of the collection.  Using rrrreeeesssseeeetttt(((()))) with no argument will
     reset the iterator on the current container.  Supplying a
     RRRRWWWWTTTTPPPPttttrrrrHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeetttt to rrrreeeesssseeeetttt(((()))) will reset the iterator on that container.





























                                                                        PPPPaaaaggggeeee 3333