[Bug libstdc++/18174] New: documentation example for std::priority_queue usage

Wed, 27 Oct 2004 04:37:39 -0700 

I just wanted to add an std::priority_queue usage example in the documentations,
since it's not obvious when you don't know how tu use it.

Since there isn't an "html" target in the root Makefile of gcc i didn't check
for validity of the patch, but i think it's ok.

$ uuencode priority_queue-3.4.1.patch.uu < priority_queue-3.4.1.patch          
                                                          
begin 600 priority_queue-3.4.1.patch.uu
M9&EF9B`M<[EMAIL PROTECTED]<B]S86UB85]P=6)L:6,O9V-C+V=C8RTS+C0N,2YO<FEG
M+VQI8G-T9&,K*RUV,R]I;F-L=61E+V)I=',O<W1L7W%U975E+F@@+W9A<B]S
M86UB85]P=6)L:6,O9V-C+V=C8RTS+C0N,2]L:6)S=&1C*RLM=C,O:6YC;'5D
M92]B:71S+W-T;%]Q=65U92YH"BTM+2`O=F%R+W-A;6)A7W!U8FQI8R]G8V,O
M9V-C+3,N-"XQ+F]R:6<O;&EB<W1D8RLK+78S+VEN8VQU9&4O8FET<R]S=&Q?
M<75E=64N:`DR,#`T+3$P+3(W(#$R.C,Y.C(V+C`P,#`P,#`P,"`K,#(P,`HK
[EMAIL PROTECTED]<B]S86UB85]P=6)L:6,O9V-C+V=C8RTS+C0N,2]L:6)S=&1C*RLM
M=C,O:6YC;'5D92]B:71S+W-T;%]Q=65U92YH"3(P,#0M,3`M,C<@,3,Z,C0Z
M,C0N,#`P,#`P,#`P("LP,C`P"D!`("TQ,#$L-R`K,3`Q+#8S($!`"B`@("`J
M("!-96UB97)S(&YO="!F;W5N9"!I;B`B;F]R;6%L(B!C;VYT86EN97)S(&%R
M92!`8R!C;VYT86EN97)?='EP92P*("`@("H@('=H:6-H(&ES(&[EMAIL PROTECTED]'EP961E
M9B!F;W(@=&AE('-E8V]N9"!397%U96YC92!P87)A;65T97(L(&%N9"!`8R!P
M=7-H(&%N9`H@("[EMAIL PROTECTED]@0&,@<&]P+"!W:&EC:"!A<F4@<W1A;F1A<F0@)7%U
M975E+T9)1D\@;W!E<F%T:6]N<[EMAIL PROTECTED]@("H**R`@("H@(%QB($5X
M86UP;&4Z"BL@("`J("!<8V]D90HK("[EMAIL PROTECTED]@(VEN8VQU9&4@/&EO<W1R96%M
M/@HK("[EMAIL PROTECTED]@(VEN8VQU9&4@/'9E8W1O<CX**R`@("H@("-I;F-L=61E(#QQ
M=65U93X**R`@("H**R`@("H@(&-L87-S($EN=`HK("[EMAIL PROTECTED]@>PHK("[EMAIL PROTECTED]@
M<'5B;&[EMAIL PROTECTED]("[EMAIL PROTECTED]@("`@($EN="AI;G0@:2D**R`@("H@("`@("`@("`@
M.B!I7RAI*0HK("[EMAIL PROTECTED]@("`@('L**R`@("H@("`@("!]"BL@("`J"BL@("`J
M("`@("`@:6YT(&E?.PHK("[EMAIL PROTECTED]@?3L**R`@("H**R`@("H@('-T9#HZ;W-T
M<F5A;2`F"BL@("`J("!O<&5R871O<CP\("AS=&0Z.F]S=')E86T@)B!O<RP@
M8V]N<[EMAIL PROTECTED]("8@:2D**R`@("H@('L**R`@("H@("`@("!R971U<FX@;W,@
M/#P@:2YI7SL**R`@("H@('T**R`@("H**R`@("H@(&-L87-S($EN=%]L97-S
M"BL@("`J("!["BL@("`J("!P=6)L:6,Z"BL@("`J("`@("[EMAIL PROTECTED]@1G5N8W1I
M;VX@;W!E<F%T;W(**R`@("H@("`@("!B;V]L(&]P97)A=&]R*"[EMAIL PROTECTED]&-O;G-T
M($EN="`J(&DQ+"!C;VYS="!);[EMAIL PROTECTED],BD**R`@("H@("`@("!["BL@("`J
M("`@("`@("`@(')E='5R;B!I,2T^:5\@/"!I,BT^:5\["BL@("`J("`@("`@
M?0HK("[EMAIL PROTECTED]@?3L**R`@("H**R`@("H@('1Y<&5D968@<W1D.CIV96-T;W(\
M($EN="`J([EMAIL PROTECTED]&]R7W1Y<&4["BL@("`J("!T>7!E9&5F('-T9#HZ<')I
M;W)I='E?<75E=64\($EN="`J+"!V96-T;W)?='[EMAIL PROTECTED]<W,@/B!P
M<FEO<FET>5]Q=65U95]T>7!E.PHK("[EMAIL PROTECTED]@HK("[EMAIL 
PROTECTED]@=F]I9`HK("[EMAIL PROTECTED]@
M9F]O*"D**R`@("H@('L**R`@("H@("`@("!V96-T;W)?='EP92!V.PHK("`@
[EMAIL PROTECTED]("[EMAIL PROTECTED]@("`@('8N<'5S:%]B86-K*&YE=R!);G0H."DI.PHK("[EMAIL 
PROTECTED]@
M("`@('8N<'5S:%]B86-K*&YE=R!);G0H,2DI.PHK("[EMAIL PROTECTED]@("`@('8N<'5S
M:%]B86-K*&YE=R!);G0H-2DI.PHK("[EMAIL PROTECTED]@HK("[EMAIL PROTECTED]@("`@('!R:6]R:71Y
M7W%U975E7W1Y<&4@<'$H=BYB96=I;[EMAIL PROTECTED]"!V+F5N9"@I*3L**R`@("H**R`@
M("H@("`@("!W:&EL92`H(7!Q+F5M<'1Y*"DI"BL@("`J("`@("`@>PHK("`@
M*B`@("`@("`@("!S=&0Z.F-O=70@/[EMAIL PROTECTED]<"@I(#P\('-T9#HZ96YD
M;#L**R`@("H@("`@("`@("[EMAIL PROTECTED]&5L971E('!Q+G1O<"@I.PHK("[EMAIL PROTECTED]@("`@
M("`@("!P<2YP;W`H*3L**R`@("H@("`@("!]"BL@("`J("!]"BL@("`J("!<
M96YD8V]D90HK("[EMAIL PROTECTED]("[EMAIL PROTECTED]&5M<&QA=&4\='EP96YA;[EMAIL 
PROTECTED]"!T>7!E
H;F%M92!?4V5Q=65N8V4^"B`@("[EMAIL PROTECTED]<W,@<75E=64*("`@("!["@``
`
end

for easy viewing (i don't know if posting the patch in plain text is ok because
of space breaking):

diff -ru
/var/samba_public/gcc/gcc-3.4.1.orig/libstdc++-v3/include/bits/stl_queue.h
/var/samba_public/gcc/gcc-3.4.1/libstdc++-v3/include/bits/stl_queue.h
--- /var/samba_public/gcc/gcc-3.4.1.orig/libstdc++-v3/include/bits/stl_queue.h 
2004-10-27 12:39:26.000000000 +0200
+++ /var/samba_public/gcc/gcc-3.4.1/libstdc++-v3/include/bits/stl_queue.h      
2004-10-27 13:24:24.000000000 +0200
@@ -101,7 +101,63 @@
    *  Members not found in "normal" containers are @c container_type,
    *  which is a typedef for the second Sequence parameter, and @c push and
    *  @c pop, which are standard %queue/FIFO operations.
-  */
+   *
+   *  \b Example:
+   *  \code
+   *  #include <iostream>
+   *  #include <vector>
+   *  #include <queue>
+   *
+   *  class Int
+   *  {
+   *  public:
+   *      Int(int i)
+   *          : i_(i)
+   *      {
+   *      }
+   *
+   *      int i_;
+   *  };
+   *
+   *  std::ostream &
+   *  operator<< (std::ostream & os, const Int & i)
+   *  {
+   *      return os << i.i_;
+   *  }
+   *
+   *  class Int_less
+   *  {
+   *  public:
+   *      // Function operator
+   *      bool operator() (const Int * i1, const Int * i2)
+   *      {
+   *          return i1->i_ < i2->i_;
+   *      }
+   *  };
+   *
+   *  typedef std::vector< Int * > vector_type;
+   *  typedef std::priority_queue< Int *, vector_type, Int_less >
priority_queue_type;
+   *
+   *  void
+   *  foo()
+   *  {
+   *      vector_type v;
+   *
+   *      v.push_back(new Int(8));
+   *      v.push_back(new Int(1));
+   *      v.push_back(new Int(5));
+   *
+   *      priority_queue_type pq(v.begin(), v.end());
+   *
+   *      while (!pq.empty())
+   *      {
+   *          std::cout << *pq.top() << std::endl;
+   *          delete pq.top();
+   *          pq.pop();
+   *      }
+   *  }
+   *  \endcode
+   */
   template<typename _Tp, typename _Sequence>
     class queue
     {


HTH

-- 
           Summary: documentation example for std::priority_queue usage
           Product: gcc
           Version: 3.4.1
            Status: UNCONFIRMED
          Severity: enhancement
          Priority: P2
         Component: libstdc++
        AssignedTo: unassigned at gcc dot gnu dot org
        ReportedBy: Number_42 at caramail dot com
                CC: gcc-bugs at gcc dot gnu dot org
 GCC build triplet: all
  GCC host triplet: all
GCC target triplet: all


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=18174

Reply via email to