ITE / code / H_I_D / I_estimation.m

Full commit
function [I] = I_estimation(Y,ds,co)
%Estimates mutual information I(y^1,...,y^M), where the m^th subspace is
%ds(m)-dimensional; using the method/cost object co.
%   Y: Y(:,t) is the t^th sample.
%  ds: subspace dimensions.
%  co: mutual information estimator object (structure).
%Copyright (C) 2012 Zoltan Szabo ("", "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 <>.

%Here, we make use of the naming convention 'I<name>_estimation':
    eval(['I=I',,'_estimation(Y,ds,co);']);%example: I = IShannon_HShannon_estimation(Y,ds,co);