Fix a comment.

[octave.git] / c_inner_product.m

diff --git a/c_inner_product.m b/c_inner_product.m
index ca98008acb9228ed932fe9be95ee5d070a771803..1d7bfd1e67122823724ebafb8ee919fe58c9980e 100644 (file)
--- a/c_inner_product.m
+++ b/c_inner_product.m
@@ -1,4 +1,24 @@
 function ip = c_inner_product(w, a, b, v1, v2)
-  integrand = @(x) w(x)*v1(x)*v2(x)
-  ip = quad(integrand, a, b)
+  ##
+  ## 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