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/fwht.sci | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'macros/fwht.sci')

diff --git a/macros/fwht.sci b/macros/fwht.sci
index 280bbee..e0a15ff 100644
--- a/macros/fwht.sci
+++ b/macros/fwht.sci
@@ -1,4 +1,28 @@
 function y = fwht(x, varargin)
+//Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm
+//Calling Sequence
+//fwht (x)
+//fwht (x, n)
+//fwht (x, n, order)
+//Parameters 
+//x: real or complex valued scalar or vector
+//n: x is truncated or extended to have length n 
+//order: Specification of order in which coefficients should be arranged 
+//Description
+//Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm. If the input is a matrix, the FWHT is calculated along the columns of x.
+//
+//The number of elements of x must be a power of 2; if not, the input will be extended and filled with zeros. If a second argument is given, the input is truncated or extended to have length n.
+//
+//The third argument specifies the order in which the returned Walsh-Hadamard transform coefficients should be arranged. The order may be any of the following strings:
+//
+//"sequency"
+//The coefficients are returned in sequency order. This is the default if order is not given.
+//
+//"hadamard"
+//The coefficients are returned in Hadamard order.
+//
+//"dyadic"
+//The coefficients are returned in Gray code order.
 
 funcprot(0);
 rhs= argn(2);
-- 
cgit