class: HalfFloatArray
authorClaus Gittinger <cg@exept.de>
Tue, 04 Feb 2014 21:40:12 +0100
changeset 3160 d5bef8d7e676
parent 3159 1ea80d1ded0c
child 3161 36b715e44b98
class: HalfFloatArray comment/format in: #documentation
HalfFloatArray.st
--- a/HalfFloatArray.st	Tue Feb 04 18:05:02 2014 +0100
+++ b/HalfFloatArray.st	Tue Feb 04 21:40:12 2014 +0100
@@ -1,5 +1,5 @@
 "
- COPYRIGHT (c) 2014 by Claus Gittinger
+ COPYRIGHT (c) 1993 by Claus Gittinger
 	      All Rights Reserved
 
  This software is furnished under a license and may be used
@@ -19,7 +19,6 @@
 !
 
 !HalfFloatArray primitiveFunctions!
-
 %{
 typedef unsigned short halffloat;
 typedef unsigned short uint16;
@@ -132,7 +131,7 @@
 }
 
 %}
-!
+! !
 
 !HalfFloatArray class methodsFor:'documentation'!
 
@@ -155,19 +154,24 @@
     HalfFloatArrays store half precision (16bit) floats (and nothing else).
     HalfFloats were trditionally seldom used, but seem to become more popular
     these days, as some 3D graphics accelerators and game engines use them
-    for very dens and compact storage.
+    for very dense and compact storage.
     Notice, that when accessing a HalfFloats elements via getters/setters,
     shortFloat (i.e. single precision 32bit floats are exchanged).
-    HalfFloats are not supported as first class objects by the st/x system (yet?).
+
+    HalfFloats are not supported as first class objects by the st/x system;
+    i.e. outside of a HalfFloatArray, these values are represented as floats
+    or doubles.
+
+    Be aware that the numeric range of a half-float is very very limited.
 
     [memory requirements:]
-	OBJ-HEADER + (size * 2)
+        OBJ-HEADER + (size * 2)
 
     [See also:]
-	FloatArray DoubleArray Array
+        FloatArray DoubleArray Array
 
     [author:]
-	Claus Gittinger
+        Claus Gittinger
 "
 ! !
 
@@ -177,7 +181,6 @@
     ^ 2
 ! !
 
-
 !HalfFloatArray methodsFor:'accessing'!
 
 at:index
@@ -242,5 +245,6 @@
 !HalfFloatArray class methodsFor:'documentation'!
 
 version_CVS
-    ^ '$Header: /cvs/stx/stx/libbasic2/HalfFloatArray.st,v 1.1 2014-02-04 17:05:02 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic2/HalfFloatArray.st,v 1.2 2014-02-04 20:40:12 cg Exp $'
 ! !
+