Code Documentation

dormaayan · dormaayan · commit 65d2f5bc358e · 2016-12-12T11:34:49.000+02:00
diff --git a/checkAmplitudeDependency.m b/checkAmplitudeDependency.m
@@ -1,3 +1,5 @@
+% Validate whether there is any dependency of the bit allocation problem
+% with the amplitude in function 1
 for i=1:1:10,
  B = 12379;
  omega = rand * 10;
diff --git a/checkAmplitudeDependency4.m b/checkAmplitudeDependency4.m
@@ -1,3 +1,5 @@
+% Validate whether there is any dependency of the bit allocation problem
+% with the amplitude in function 4
 for i=1:1:10,
  B = 1024;
  omega = rand * 10;
diff --git a/checkAnplitudeDependency5.m b/checkAnplitudeDependency5.m
@@ -1,3 +1,5 @@
+% Validate whether there is any dependency of the bit allocation problem
+% with the amplitude in function 5
 for i=1:1:10,
  B = 1024;
  omega = rand * 10;
diff --git a/checkWnenOmegaIsInteger.m b/checkWnenOmegaIsInteger.m
@@ -1,3 +1,5 @@
+% Validate our assumption in the theoretical part
+% that functions 1 and 2 are the same when omega is integer
 for i=1:1:10,
  B = 12379;
  A = rand * 100;
diff --git a/func1Numerically.m b/func1Numerically.m
@@ -1,3 +1,4 @@
+% Numerical calculation of N,b and the mse of function 1
 function [b,N,mse] = func1Numerically( omega,phi,A,B)
     syms symb;
     Energy = 0.5*pi*omega*A^2*(4*pi*omega+sin(4*pi*omega+2*phi)-sin(2*phi));
diff --git a/func2Numerically.m b/func2Numerically.m
@@ -1,3 +1,4 @@
+% Numerical calculation of N,b and the mse of function 2
 function [b,N,mse] = func2Numerically( omega,phi,A,B)
     syms symb;
     Energy = 0.5*pi*omega*A^2*(4*pi*omega-sin(4*pi*omega+2*phi)+sin(2*phi));
diff --git a/func3Numerically.m b/func3Numerically.m
@@ -1,3 +1,4 @@
+% Numerical calculation of N,b and the mse of function 3
 function [b,N,mse] = func3Numerically(omega,phi,A,alpha,B)
     syms symb;
     fun = @(t) (2.*pi.*A.*(omega+2.*alpha.*t).*cos(2.*pi.*t.*(omega+alpha.*t)+phi)).^2;
diff --git a/func4Numerically.m b/func4Numerically.m
@@ -1,3 +1,4 @@
+% Numerical calculation of N,b and the mse of function 4
 function [b,N,mse] = func4Numerically( omega,phi,A,alpha,B)
     syms symb;
     fun = @(t) (2.*pi.*A.*(omega+alpha.^t+t.*alpha.^t-1).*cos(2.*pi.*t.*(omega+alpha.^t-1)+phi)).^2;
diff --git a/func5Numerically.m b/func5Numerically.m
@@ -1,3 +1,4 @@
+% Numerical calculation of N,b and the mse of function 5
 function [b,N,mse] = func5Numerically( omega,phi,A,alpha,beta,B)
     syms symb;
     fun = @(t) (2.*pi.*(beta.*t+A).*(omega+2.*alpha.*t).*cos(2.*pi.*t.*(omega+alpha.*t)+phi)+beta.*sin(2.*pi.*t.*(omega+alpha.*t)+phi)).^2;
diff --git a/mseProject.m b/mseProject.m
@@ -1,5 +1,5 @@
 function [mse_error] = mseProject(A,B)
-%Calculate the mse error of the matrix
+%Calculate the mse error
 
 difference = double(A)- double(decompress_1d(B,numel(A)));
 % disp(difference);
diff --git a/quantize.m b/quantize.m
@@ -1,3 +1,4 @@
+% Do the quantization process
 function [ qs ] = quantize(s,D,R,J )
 qs=s;
 [x,l]=size(s);
diff --git a/sampleInterval.m b/sampleInterval.m
@@ -1,3 +1,5 @@
+% calculate the average of valuse in a specific interval
+% auxilary function for the sampling process
 function [ sample ] = sampleInterval( interval )
     sample = sum(sum(interval))/numel(interval);
 end

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+% Validate whether there is any dependency of the bit allocation problem`
	`2`	`+% with the amplitude in function 1`
`1`	`3`	`for i=1:1:10,`
`2`	`4`	`B = 12379;`
`3`	`5`	`omega = rand * 10;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+% Validate whether there is any dependency of the bit allocation problem`
	`2`	`+% with the amplitude in function 4`
`1`	`3`	`for i=1:1:10,`
`2`	`4`	`B = 1024;`
`3`	`5`	`omega = rand * 10;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+% Validate whether there is any dependency of the bit allocation problem`
	`2`	`+% with the amplitude in function 5`
`1`	`3`	`for i=1:1:10,`
`2`	`4`	`B = 1024;`
`3`	`5`	`omega = rand * 10;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+% Validate our assumption in the theoretical part`
	`2`	`+% that functions 1 and 2 are the same when omega is integer`
`1`	`3`	`for i=1:1:10,`
`2`	`4`	`B = 12379;`
`3`	`5`	`A = rand * 100;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% Numerical calculation of N,b and the mse of function 1`
`1`	`2`	`function [b,N,mse] = func1Numerically( omega,phi,A,B)`
`2`	`3`	`syms symb;`
`3`	`4`	`Energy = 0.5piomegaA^2(4piomega+sin(4piomega+2phi)-sin(2phi));`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% Numerical calculation of N,b and the mse of function 2`
`1`	`2`	`function [b,N,mse] = func2Numerically( omega,phi,A,B)`
`2`	`3`	`syms symb;`
`3`	`4`	`Energy = 0.5piomegaA^2(4piomega-sin(4piomega+2phi)+sin(2phi));`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% Numerical calculation of N,b and the mse of function 3`
`1`	`2`	`function [b,N,mse] = func3Numerically(omega,phi,A,alpha,B)`
`2`	`3`	`syms symb;`
`3`	`4`	`fun = @(t) (2.pi.A.(omega+2.alpha.t).cos(2.pi.t.(omega+alpha.t)+phi)).^2;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% Numerical calculation of N,b and the mse of function 4`
`1`	`2`	`function [b,N,mse] = func4Numerically( omega,phi,A,alpha,B)`
`2`	`3`	`syms symb;`
`3`	`4`	`fun = @(t) (2.pi.A.(omega+alpha.^t+t.alpha.^t-1).cos(2.pi.t.(omega+alpha.^t-1)+phi)).^2;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% Numerical calculation of N,b and the mse of function 5`
`1`	`2`	`function [b,N,mse] = func5Numerically( omega,phi,A,alpha,beta,B)`
`2`	`3`	`syms symb;`
`3`	`4`	`fun = @(t) (2.pi.(beta.t+A).(omega+2.alpha.t).cos(2.pi.t.(omega+alpha.t)+phi)+beta.sin(2.pi.t.(omega+alpha.t)+phi)).^2;`