Re: [Swarm-Support] Averager- undocumented methods?

[Paul Johnson]

The documentation is in the CVS and has been since those methods were 
introduced.  So when the documentation is generated, it will include 
those things.  All of those methods were written after 2.1.1, and that's 
why they are not documented in 2.1.1.

pj
Steve Railsback wrote:
> We have an output file-writing tool that uses the Swarm Averager (in the 
> Analysis library). According to the Swarm 2.1.1 documentation, Averager 
> has methods:
>
> - (double)getAverage
> - (double)getTotal
> - (double)getMin
> - (unsigned)getCount
>
> but we wanted to get the standard deviation.
>
> Luckily Steve Jackson had enough sense to read the code and found out 
> that several methods exist in Averager but do not appear in the 
> reference manual. The full list in Averager.h is:
>
> - (double)getAverage;
> - (double)getMovingAverage;
> - (double)getVariance;
> - (double)getMovingVariance;
> - (double)getStdDev;
> - (double)getMovingStdDev;
> - (double)getTotal;
> - (double)getMax;
> - (double)getMin;
> - (unsigned)getCount;
>
> a. Does anyone know if there is any reason why these were left out of 
> the documentation? Any reason not to use them?
>
> b. (Marcus) Can these be included in the doc book for the new release??
>
> Thanks,
>
> Steve Railsback


--
Paul E. Johnson                       email: address@hidden
Dept. of Political Science            http://lark.cc.ku.edu/~pauljohn
1541 Lilac Lane, Rm 504
University of Kansas                  Office: (785) 864-9086
Lawrence, Kansas 66044-3177           FAX: (785) 864-5700