changeset 813:97741fe16205

Comment about periodic windows
author Chris Cannam
date Fri, 24 May 2013 11:57:44 +0100
parents 98d54183d0f8
children 06c64a1c6785
files base/Window.h
diffstat 1 files changed, 5 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/base/Window.h	Thu May 16 15:00:20 2013 +0100
+++ b/base/Window.h	Fri May 24 11:57:44 2013 +0100
@@ -41,7 +41,11 @@
 {
 public:
     /**
-     * Construct a windower of the given type.
+     * Construct a windower of the given type and size. 
+     *
+     * Note that the cosine windows are periodic by design, rather
+     * than symmetrical. (A window of size N is equivalent to a
+     * symmetrical window of size N+1 with the final element missing.)
      */
     Window(WindowType type, size_t size) : m_type(type), m_size(size) { encache(); }
     Window(const Window &w) : m_type(w.m_type), m_size(w.m_size) { encache(); }