Re: FlowSet documentation patch

[Chris Pickett <chris.pickett@mail.mcgill.ca>]

Sure, that's better.  I don't really like meet/join/~other either, I was 
just trying to keep changes minimal.  btw, ArrayPackedSet apparently has 
a defined universe.

Cheers,
Chris

Ondrej Lhotak wrote:
> Well, I'd prefer "intersect" over meet/join, since we're talking about
> sets rather than lattices. But even saying "this intersect ~other" isn't
> quite right, since FlowSets have no defined universe, so ~other doesn't
> make much sense. So, how about "this minus other"?
>
> Ondrej
>
> On Wed, Jun 23, 2004 at 10:21:01PM -0400, Chris Pickett wrote:
>
> > Hi,
> >
> > Is there a problem with this patch?  I know it's terribly simple, but 
> > that "join" was there in the docs (and still is) was enough to make me 
> > check that the methods actually did what I expected, which was "meet". 
> > The rest is just capitalization, I figured I may as well fix it.
> >
> > Cheers,
> > Chris
> >
> > Chris Pickett wrote:
> >
> > > Hi,
> > >
> > > Here is a simple documentation-only patch for FlowSet.java.
> > >
> > > Cheers,
> > > Chris
> > >
> > >
> > > ------------------------------------------------------------------------
> > >
> > > Index: src/soot/toolkits/scalar/FlowSet.java
> > > ===================================================================
> > > --- src/soot/toolkits/scalar/FlowSet.java	(revision 1507)
> > > +++ src/soot/toolkits/scalar/FlowSet.java	(working copy)
> > > @@ -47,7 +47,7 @@
> > >   public Object clone();
> > >
> > >   /** 
> > > -   * returns an empty set, most often more efficient than:
> > > +   * Returns an empty set, most often more efficient than:
> > >    * <code>((FlowSet)clone()).clear()</code>
> > >    */
> > >   public Object emptySet();
> > > @@ -88,13 +88,13 @@
> > >   public void intersection(FlowSet other, FlowSet dest);
> > >
> > >   /** 
> > > -   * Returns the set difference (this join ~other) of this FlowSet and
> > > +   * Returns the set difference (this meet ~other) of this FlowSet and
> > >    * <code>other</code>, putting result into <code>this</code>.
> > >    */
> > >   public void difference(FlowSet other);
> > >
> > >   /**
> > > -   * Returns the set difference (this join ~other) of this FlowSet and 
> > > +   * Returns the set difference (this meet ~other) of this FlowSet and 
> > >    * <code>other</code>, putting result into <code>dest</code>.
> > >    * <code>dest</code>, <code>other</code> and <code>this</code> could be the
> > >    * same object.
> > > @@ -119,7 +119,7 @@
> > >   public void add(Object obj);
> > >
> > >   /**
> > > -   * puts <code>this</code> union <code>obj</code> into <code>dest</code>.
> > > +   * Puts <code>this</code> union <code>obj</code> into <code>dest</code>.
> > >    */
> > >   public void add(Object obj, FlowSet dest);
> > >
> > > @@ -139,7 +139,7 @@
> > >   public boolean contains(Object obj);
> > >
> > >   /**
> > > -   * returns an iterator over the elements of the flowSet. Note that the
> > > +   * Returns an iterator over the elements of the flowSet. Note that the
> > >    * iterator might be backed, and hence be faster in the creation, than doing
> > >    * <code>toList().iterator()</code>.
> > >    */