From 11f08cc395ea1b0de77af3dbb87a985418fc3800 Mon Sep 17 00:00:00 2001
From: Abhinav Dronamraju
Date: Fri, 24 Nov 2017 19:19:30 +0530
Subject: Created xml help files

---
 macros/invfreq.sci | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

(limited to 'macros/invfreq.sci')

diff --git a/macros/invfreq.sci b/macros/invfreq.sci
index dde23ef..a720115 100644
--- a/macros/invfreq.sci
+++ b/macros/invfreq.sci
@@ -1,6 +1,28 @@
 function [B,A] = invfreq(H,F,nB,nA,W,iter,tol, plane)
-
-
+// Calculates inverse frequency vectors
+//
+// Calling Sequence
+//[B,A] = invfreq(H,F,nB,nA)
+//[B,A] = invfreq(H,F,nB,nA,W)
+//[B,A] = invfreq(H,F,nB,nA,W,[],[],plane)
+//[B,A] = invfreq(H,F,nB,nA,W,iter,tol,plane)
+// 
+// Parameters
+// H: desired complex frequency response,It is assumed that A and B are real polynomials, hence H is one-sided.
+// F: vector of frequency samples in radians
+// nA: order of denominator polynomial A
+// nB: order of numerator polynomial B
+//
+// Description
+//Fit filter B(z)/A(z) or B(s)/A(s) to complex frequency response at frequency points F. A and B are real polynomial coefficients of order nA and nB respectively.  Optionally, the fit-errors can be weighted vs frequency according to the weights W. Also, the transform plane can be specified as either 's' for continuous time or 'z' for discrete time. 'z' is chosen by default.  Eventually, Steiglitz-McBride iterations will be specified by iter and tol.
+//
+// Examples
+//  [B,A] = butter(12,1/4);
+//  [H,w] = freqz(B,A,128);
+//  [Bh,Ah] = invfreq(H,F,4,4);
+//  Hh = freqz(Bh,Ah);
+//  disp(sprintf('||frequency response error|| = %f',norm(H-Hh)));
+// 
 funcprot(0);
 lhs= argn(1);
 rhs= argn(2);
-- 
cgit