Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / nan-2.5.5 / prctile.m

diff --git a/octave_packages/nan-2.5.5/prctile.m b/octave_packages/nan-2.5.5/prctile.m
new file mode 100644 (file)
index 0000000..63948d4
--- /dev/null
+++ b/octave_packages/nan-2.5.5/prctile.m
@@ -0,0 +1,48 @@
+function Q=prctile(Y,q,DIM)
+% PRCTILE calculates the percentiles of histograms and sample arrays.  
+% (its the same than PERCENTILE.M)
+%
+%  Q = prctile(Y,q)      
+%  Q = prctile(Y,q,DIM)      
+%     returns the q-th percentile along dimension DIM of sample array Y.
+%     size(Q) is equal size(Y) except for dimension DIM which is size(Q,DIM)=length(Q)
+%
+%  Q = prctile(HIS,q)
+%     returns the q-th percentile from the histogram HIS. 
+%     HIS must be a HISTOGRAM struct as defined in HISTO2 or HISTO3.
+%     If q is a vector, the each row of Q returns the q(i)-th percentile 
+%
+% see also: HISTO2, HISTO3, QUANTILE
+
+%      $Id$
+%      Copyright (C) 1996-2003,2005,2006,2007,2009 by Alois Schloegl <alois.schloegl@gmail.com>        
+%       This function is part of the NaN-toolbox
+%       http://pub.ist.ac.at/~schloegl/matlab/NaN/
+
+%    This program is free software; you can redistribute it and/or modify
+%    it under the terms of the GNU General Public License as published by
+%    the Free Software Foundation; either version 2 of the License, or
+%    (at your option) any later version.
+%
+%    This program is distributed in the hope that it will be useful,
+%    but WITHOUT ANY WARRANTY; without even the implied warranty of
+%    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+%    GNU General Public License for more details.
+%
+%    You should have received a copy of the GNU General Public License
+%    along with this program; If not, see <http://www.gnu.org/licenses/>.
+
+
+if nargin==2,
+       Q = quantile(Y,q/100); 
+
+elseif nargin==3,
+       Q = quantile(Y,q/100,DIM); 
+
+else
+       help percentile
+
+end;
+
+
+