Add docs for the c_inner_product function.
authorMichael Orlitzky <michael@orlitzky.com>
Thu, 15 Nov 2012 01:36:09 +0000 (20:36 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Thu, 15 Nov 2012 01:36:09 +0000 (20:36 -0500)
c_inner_product.m

index ca98008acb9228ed932fe9be95ee5d070a771803..0ff7f9631dee488c7365d8d4df7676fca131c0e4 100644 (file)
@@ -1,4 +1,24 @@
 function ip = c_inner_product(w, a, b, v1, v2)
+  ##
+  ## The usual inner product defined on the space of continuous
+  ## functions over the interval [a,b].
+  ##
+  ## INPUT:
+  ##
+  ##   * ``w`` -- The weight function.
+  ##
+  ##   * ``a`` -- The left endpoint of the interval.
+  ##
+  ##   * ``b`` -- The right endpoint of the interval.
+  ##
+  ##   * ``v1`` -- The first vector.
+  ##
+  ##   * ``v2`` -- The second vector.
+  ##
+  ## OUTPUT:
+  ##
+  ## The inner product <v1, v2>.
+  ##
   integrand = @(x) w(x)*v1(x)*v2(x)
   ip = quad(integrand, a, b)
 end