Show
Ignore:
Timestamp:
06/04/10 14:26:02 (14 years ago)
Author:
smidl
Message:

Doxygen documentation of bdmtoolbox

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • applications/bdmtoolbox/mex/mex_classes/mexEpdf.m

    r1037 r1040  
     1%> @file mexEpdf.m 
     2%> @brief File mappring root class of epdf from BDM 
     3% ====================================================================== 
     4%> @brief Abstract class of unconditional probability density function (epdf)  
     5% 
     6%> This class provides a bridge between bdm::epdf and Matlab 
     7% ====================================================================== 
    18classdef mexEpdf 
    29    properties 
    3             rv=RV; %empty description add some valid RV when needed 
     10            %> Description of random variable (see definitiopn of RV) 
     11            rv=RV;  
    412    end 
    513    methods 
     14             %> Function returning mean value of this epdf 
    615        function m=mean(p) 
    716            error('define how to compute mean') 
    817        end 
     18             %> This function is called before using the object. It should check consistency of the properties and fill default values. 
    919        function validate(p) 
    1020            error('check if the density is consistent') 
    1121        end 
     22             %> Tell the world around it dimension of the random variable 
    1223        function dim=dimension(p) 
    1324            error('return dimension of the density') 
    1425        end 
     26             %> Function returning variance of this epdf 
    1527        function v=variance(p) 
    1628            error('define how to compute mean') 
    1729        end 
     30             %> Function returning logarithm of likelihood function in point x 
    1831        function l=evallog(p,x) 
    1932            error('define how to evaluate log of this density at point x') 
    2033        end 
     34             %> Function returning a signle sample from this density 
    2135         function l=sample(p) 
    2236            error('define how to sample from this density') 
     
    2539        %%% default functions -- no need to redefine %%% 
    2640         
     41             %> Function returning logarithm of NON-normalized likelihood function in point x (speed optimization) 
    2742        function l=evallog_nn(p,x) 
    2843            % define how to evaluate non-normalized log of this density at point x 
     
    3045            l=evallog(p,x); 
    3146        end 
     47 
    3248                  function r=get_rv(p) 
    3349                        r=p.rv; 
    3450          end 
     51             %> Function returning a matrix of n samples from this density,  
    3552          function m = samplemat(obj, n) 
    3653              m = zeros(obj.dimension, n);