ITE / code / estimators / meta_estimators / KJT_HJT_initialization.m

function [co] = KJT_HJT_initialization(mult,post_init)
%function [co] = KJT_HJT_initialization(mult)
%function [co] = KJT_HJT_initialization(mult,post_init)
%Initialization of the Jensen-Tsallis kernel estimator defined according to the relation: K_JT(f_1,f_2) = log_{alpha}(2) - T_alpha(f_1,f_2), where (i) log_{alpha} is the alpha-logarithm, (ii) T_alpha is the Jensen-Tsallis alpha-difference (that can be expressed in terms of the Tsallis entropy).
%   1)The estimator is treated as a cost object (co).
%   2)We use the naming convention 'K<name>_initialization' to ease embedding new estimators for kernels on distributions.
%   3)This is a meta method: the Tsallis entropy estimator can arbitrary.
%   mult: is a multiplicative constant relevant (needed) in the estimation; '=1' means yes, '=0' no.
%   post_init: {field_name1,field_value1,field_name2,field_value2,...}; cell array containing the names and the values of the cost object fields that are to be used
%   (instead of their default values). For further details, see 'post_initialization.m'.
%   co: cost object (structure).

%Copyright (C) 2013 Zoltan Szabo ("", "zoltan (dot) szabo (at) gatsby (dot) ucl (dot) ac (dot) uk")
%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 <>.

%mandatory fields (following the template structure of the estimators to make uniform usage of the estimators possible): = 'JT_HJT';
    co.mult = mult;
%other fields:
    co.alpha = 0.95; %0<=alpha<=2, alpha \ne 1
    co.member_name = 'Tsallis_kNN_k'; %you can change it to any Tsallis entropy estimator

%post initialization (put it _before_ initialization of the members in case of a meta estimator):    
    if nargin==2 %there are given (name,value) cost object fields
        co = post_initialization(co,post_init);

%initialization of the member(s):
    co.member_co = H_initialization(co.member_name,mult,{'alpha',co.alpha}); %{'alpha',co.alpha}: the 'alpha' field of the member is also set here