ITE / code / H_I_D / base_estimators / HRenyi_MST_estimation.m

function [H] = HRenyi_MST_estimation(Y,co)
%Estimates the Renyi entropy (H) of Y (Y(:,t) is the t^th sample)
%using the minimum spanning tree (MST). Cost parameters are provided in the cost object co.
%
%We make use of the naming convention 'H<name>_estimation', to ease embedding new entropy estimation methods.
%
%REFERENCE: 
%   Joseph E. Yukich. Probability Theory of Classical Euclidean Optimization Problems, Lecture Notes in Mathematics, 1998, vol. 1675.
%
%Copyright (C) 2012 Zoltan Szabo ("http://nipg.inf.elte.hu/szzoli", "szzoli (at) cs (dot) elte (dot) hu")
%
%This file is part of the ITE (Information Theoretical Estimators) Matlab/Octave toolbox.
%
%ITE 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 software 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 ITE. If not, see <http://www.gnu.org/licenses/>.

%co.mult:OK.

[d,num_of_samples] = size(Y);%dimension, number of samples

%length (L):
    L = compute_length_HRenyi_MST(Y,co);

%estimation:
    if co.additive_constant_is_relevant %the additive constant is relevant in the Renyi entropy estimation
        FN = filename_of_HRenyi_constant(d,co);
        if exist(FN)
            load(FN,'constant');
            H = log( L / (constant*num_of_samples^co.alpha) ) / (1-co.alpha);
        else
            disp('Error: the file containing the additive constant does not exist. You can precompute the additive constant via estimate_HRenyi_constant.m.');
        end
    else %estimation up to an additive constant
        H = log( L / num_of_samples^co.alpha ) / (1-co.alpha);
    end
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.