[FFmpeg-devel] [PATCH] Document av_gcd()

[Reimar Döffinger]

On Sun, Mar 01, 2009 at 07:34:31PM +0100, Stefano Sabatini wrote:
> On date Saturday 2009-02-28 18:49:27 +0100, Reimar D?ffinger encoded:
> > On Sat, Feb 28, 2009 at 06:23:37PM +0100, Michael Niedermayer wrote:
> > > On Sat, Feb 28, 2009 at 04:53:08PM +0100, Stefano Sabatini wrote:
> > > > Hi,
> > > > as in subject, regards.
> > > > -- 
> > > > FFmpeg = Funny and Forgiving Multimedia Pitiful Elected Ghost
> > > 
> > > > Index: libavutil/mathematics.h
> > > > ===================================================================
> > > > --- libavutil/mathematics.h	(revision 17629)
> > > > +++ libavutil/mathematics.h	(working copy)
> > > > @@ -50,6 +50,9 @@
> > > >      AV_ROUND_NEAR_INF = 5, ///< Round to nearest and halfway cases away from zero.
> > > >  };
> > > >  
> > > > +/**
> > > > + * Returns the greatest common divisor of a and b.
> > > > + */
> > > >  int64_t av_const av_gcd(int64_t a, int64_t b);
> > > >  
> > > >  /**
> > > 
> > > ok,also please add
> > > "if either or both are <=0 then the behavior is undefined"
> > 
> > My r_frame_rate code in utils.c uses the = 0 case already, since I
> > considered that the common mathematical definition...
> 
> Trying to find a compromise, I think documenting the case gcd(a, 0) = a
> doesn't hurt.

The you'd have to flip the usage in utils.c though, it uses
av_gcd(0, a) (I considered speed irrelevant there).
Also just documenting that there are internal uses that use the =0 case
in the .c file would be fine by me...