MIToolbox/WeightedMIToolbox.m at master · Junpeng-Wang/MIToolbox · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
function [varargout] = WeightedMIToolbox(functionName, weightVector, varargin)
%function [varargout] = WeightedMIToolbox(functionName, weightVector, varargin)
%
%Provides access to the functions in WeightedMIToolboxMex
%
%Expects column vectors, will not work with row vectors
%
%Function list
%"entropy" or "h" = H(X)
%"ConditionalEntropy" or "condh" = H(X|Y)
%"mi" = I(X;Y)
%"ConditionalMI" or "cmi" = I(X;Y|Z)
%
%Arguments and returned values
%[entropy] = H_w(X) = H_w(vector)
%[entropy] = H_w(X|Y) = H_w(vector,condition)
%[mi] = I_w(X;Y) = I_w(vector,target)
%[mi] = I_w(X;Y|Z) = I_w(vector,target,condition)
%
%Internal MIToolbox function number
%Entropy              = 1
%Conditional Entropy  = 3
%Mutual Information   = 4
%Conditional MI       = 5

for i = 1:length(varargin)
    if (~isa(varargin{i},'double'))
        error('Error, MIToolbox requires inputs to be double vector or matrices')
    end
end

if (strcmpi(functionName,'Entropy') || strcmpi(functionName,'h'))
    %disp('Calculating Entropy');
    if (size(varargin{1},2)>1)
			mergedVector = MIToolboxMex(3,varargin{1});
		else
			mergedVector = varargin{1};
    end
    [varargout{1}] = WeightedMIToolboxMex(1,weightVector,mergedVector);
elseif ((strcmpi(functionName,'JointEntropy')) || strcmpi(functionName,'jointh'))
    if (size(varargin{1},2)>1)
			mergedFirst = MIToolboxMex(3,varargin{1});
		else
			mergedFirst = varargin{1};
    end
    if (size(varargin{2},2)>1)
			mergedSecond = MIToolboxMex(3,varargin{2});
		else
			mergedSecond = varargin{2};
    end
    [varargout{1}] = WeightedMIToolboxMex(2,weightVector,mergedFirst,mergedSecond);
elseif ((strcmpi(functionName,'ConditionalEntropy')) || strcmpi(functionName,'condh'))
    if (size(varargin{1},2)>1)
			mergedFirst = MIToolboxMex(3,varargin{1});
		else
			mergedFirst = varargin{1};
    end
    if (size(varargin{2},2)>1)
			mergedSecond = MIToolboxMex(3,varargin{2});
		else
			mergedSecond = varargin{2};
    end
    [varargout{1}] = WeightedMIToolboxMex(3,weightVector,mergedFirst,mergedSecond);
elseif (strcmpi(functionName,'mi'))
    if (size(varargin{1},2)>1)
			mergedFirst = MIToolboxMex(3,varargin{1});
		else
			mergedFirst = varargin{1};
    end
    if (size(varargin{2},2)>1)
			mergedSecond = MIToolboxMex(3,varargin{2});
		else
			mergedSecond = varargin{2};
    end
    [varargout{1}] = WeightedMIToolboxMex(4,weightVector,mergedFirst,mergedSecond);
elseif (strcmpi(functionName,'ConditionalMI') || strcmpi(functionName,'cmi'))
    if (size(varargin{1},2)>1)
			mergedFirst = MIToolboxMex(3,varargin{1});
		else
			mergedFirst = varargin{1};
    end
    if (size(varargin{2},2)>1)
			mergedSecond = MIToolboxMex(3,varargin{2});
		else
			mergedSecond = varargin{2};
    end
    if (size(varargin{3},2)>1)
			mergedThird = MIToolboxMex(3,varargin{3});
		else
			mergedThird = varargin{3};
    end
    [varargout{1}] = WeightedMIToolboxMex(5,weightVector,mergedFirst,mergedSecond,mergedThird);
else
    varargout{1} = 0;
    disp(['Unrecognised functionName ' functionName]);
end