summaryrefslogtreecommitdiff
path: root/apps/codecs/libspeex/pseudofloat.h
diff options
context:
space:
mode:
Diffstat (limited to 'apps/codecs/libspeex/pseudofloat.h')
-rw-r--r--apps/codecs/libspeex/pseudofloat.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/apps/codecs/libspeex/pseudofloat.h b/apps/codecs/libspeex/pseudofloat.h
index 67f01b3..a6c4762 100644
--- a/apps/codecs/libspeex/pseudofloat.h
+++ b/apps/codecs/libspeex/pseudofloat.h
@@ -2,6 +2,15 @@
/**
@file pseudofloat.h
@brief Pseudo-floating point
+ * This header file provides a lightweight floating point type for
+ * use on fixed-point platforms when a large dynamic range is
+ * required. The new type is not compatible with the 32-bit IEEE format,
+ * it is not even remotely as accurate as 32-bit floats, and is not
+ * even guaranteed to produce even remotely correct results for code
+ * other than Speex. It makes all kinds of shortcuts that are acceptable
+ * for Speex, but may not be acceptable for your application. You're
+ * quite welcome to reuse this code and improve it, but don't assume
+ * it works out of the box. Most likely, it doesn't.
*/
/*
Redistribution and use in source and binary forms, with or without