[Scipy-tickets] [SciPy] #764: interpolate.Rbf: docstring is inaccurate

SciPy scipy-tickets@scipy....
Tue Oct 28 05:03:10 CDT 2008


#764: interpolate.Rbf: docstring is inaccurate
--------------------+-------------------------------------------------------
 Reporter:  pv      |       Owner:  somebody
     Type:  defect  |      Status:  new     
 Priority:  normal  |   Milestone:          
Component:  Other   |     Version:          
 Severity:  normal  |    Keywords:          
--------------------+-------------------------------------------------------
 The description of the 'epsilon' parameter in the docstring of
 interpolate.Rbf.__init__ is wrong for function='multiquadric' and
 function='inverse multiquadric'.

 The docstring states that:
 {{{
             ::
                 'multiquadric': sqrt((self.epsilon*r)**2 + 1)
                 'inverse multiquadric': 1.0/sqrt((self.epsilon*r)**2 + 1)
                 'gausian': exp(-(self.epsilon*r)**2)
                 'cubic': r**3
                 'quintic': r**5
                 'thin-plate': r**2 * log(r)
 }}}
 whereas the code says
 {{{
     def _function(self, r):
         if self.function.lower() == 'multiquadric':
             return sqrt((1.0/self.epsilon*r)**2 + 1)
         elif self.function.lower() == 'inverse multiquadric':
             return 1.0/sqrt((1.0/self.epsilon*r)**2 + 1)
         elif self.function.lower() == 'gausian':
         ...
 }}}
 The rest are correct.

 (The 'gausian' is misspelled and doesn't work, see #686).

-- 
Ticket URL: <http://scipy.org/scipy/scipy/ticket/764>
SciPy <http://www.scipy.org/>
SciPy is open-source software for mathematics, science, and engineering.


More information about the Scipy-tickets mailing list