ITE / code / H_I_D_A_C / meta_estimators / IRenyi_HRenyi_initialization.m

function [co] = IRenyi_HRenyi_initialization(mult)
%Initialization of the "meta" Renyi mutual information estimator. The estimator uses the identity: 
%I_{alpha}(X) = -H_{alpha}(Z), where Z =[F_1(X_1);...;F_d(X_d)] is the copula transformation of X; F_i is the cdf of X_i.
%
%Note:
%   1)The estimator is treated as a cost object (co). 
%   2)We use the naming convention 'I<name>_estimation' to ease embedding new mutual information estimation methods.
%   3)This is a meta method: the Renyi entropy estimator can be arbitrary.
%
%INPUT:
%   mult: is a multiplicative constant relevant (needed) in the estimation; '=1' means yes, '=0' no.
%OUTPUT:
%   co: cost object (structure).
%
%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/>.

%mandatory fields:
    co.name = 'Renyi_HRenyi';
    co.mult = mult;
    
%other fields:    
    co.alpha = 0.99; %alpha \ne 1.

    co.member_name = 'Renyi_kNN_k'; %you can change it to any Renyi entropy estimator 
    co.member_co = H_initialization(co.member_name,mult);

    co.member_co.alpha = co.alpha; %automatism for setting the parameters (co.alpha) of member_co (co_2) in a <=2 deep meta construction (co_1 -> co_2); otherwise, please set the parameters (co.alpha) in the member_co-s.
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.