annotate general/numerical/scalar/hypdecay.m @ 35:f1ce7876346a

Updated docs.

function ret=hypdecay(k,d)
% hypdecay - compute interpolation ratio for hyperbolic decay
%
% hypdecay :: [Size->nonneg], [Size->nonneg] -> [Size->nonneg].
% hypdecay :: [Size->nonneg] -> ([Size->nonneg] -> [Size->nonneg]).
%
% this gives 'hyperbolic' convergence which is more like 
% a sort of diffusion by Brownian motion. The trick is
% to add a constant to the inverse of each natural parameter,
% which is like a temperature or variance. The constant
% is like a diffusion constant
%
% This function supports partial application: if only one
% argument is supplied, it returns a function handle.

if nargin==2, ret=1./(1+k*d);
else ret=@(d)1./(1+k*d); end