changeset 358:0fae77db7b34

Docs
author Chris Cannam
date Tue, 25 Jun 2013 09:48:57 +0100
parents e35fc1f4df0b
children 52aaf0a09de6
files may/vector.yeti
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/may/vector.yeti	Tue Jun 25 09:37:53 2013 +0100
+++ b/may/vector.yeti	Tue Jun 25 09:48:57 2013 +0100
@@ -2,7 +2,13 @@
 /**
  * Vectors. A May vector is a typesafe, immutable wrapper around a Java
  * primitive array of doubles.
+ *
+ * Although not as convenient and flexible as a Yeti array<number> or
+ * list<number>, a vector can be faster and more compact when dealing
+ * with dense data of suitable range and precision such as sampled
+ * sequences.
  */
+
 module may.vector;
 
 load may.vector.type;