X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fstatistics-1.1.3%2Fvmpdf.m;fp=octave_packages%2Fstatistics-1.1.3%2Fvmpdf.m;h=ef42f70941d1fd84935a8529b9c35edb877434c8;hp=0000000000000000000000000000000000000000;hb=c880e8788dfc484bf23ce13fa2787f2c6bca4863;hpb=1705066eceaaea976f010f669ce8e972f3734b05 diff --git a/octave_packages/statistics-1.1.3/vmpdf.m b/octave_packages/statistics-1.1.3/vmpdf.m new file mode 100644 index 0000000..ef42f70 --- /dev/null +++ b/octave_packages/statistics-1.1.3/vmpdf.m @@ -0,0 +1,46 @@ +## Copyright (C) 2009 Soren Hauberg +## +## 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 3 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 . + +## -*- texinfo -*- +## @deftypefn {Function File} @var{theta} = vmpdf (@var{x}, @var{mu}, @var{k}) +## Evaluates the Von Mises probability density function. +## +## The Von Mises distribution has probability density function +## @example +## f (@var{x}) = exp (@var{k} * cos (@var{x} - @var{mu})) / @var{Z} , +## @end example +## where @var{Z} is a normalisation constant. By default, @var{mu} is 0 and +## @var{k} is 1. +## @seealso{vmrnd} +## @end deftypefn + +function p = vmpdf (x, mu = 0, k = 1) + ## Check input + if (!isreal (x)) + error ("vmpdf: first input must be real"); + endif + + if (!isreal (mu)) + error ("vmpdf: second input must be a scalar"); + endif + + if (!isreal (k) || k <= 0) + error ("vmpdf: third input must be a real positive scalar"); + endif + + ## Evaluate PDF + Z = 2 * pi * besseli (0, k); + p = exp (k * cos (x-mu)) / Z; +endfunction