From 5b444276ae427091d7c413eb297a909f0a9472b3 Mon Sep 17 00:00:00 2001 From: Andrew Hannam Date: Thu, 17 Jan 2013 17:47:51 +1000 Subject: Implement GMISC Array Operations --- include/gmisc/gmisc.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'include') diff --git a/include/gmisc/gmisc.h b/include/gmisc/gmisc.h index 0cce12bd..c68e5ca2 100644 --- a/include/gmisc/gmisc.h +++ b/include/gmisc/gmisc.h @@ -69,6 +69,12 @@ extern "C" { * * @note Assumes the destination buffer is large enough for the resultant data. * @note This routine is optimised to perform as fast as possible. + * @note No type checking is performed on the source format. It is assumed to + * have only valid values eg. ARRAY_DATA_4BITSIGNED will have values + * 0000 -> 0111 for positive numbers and 1111 -> 1000 for negative numbers + * Bits 5 -> 8 in the storage byte are treated in an undefined manner. + * @note If srcfmt or dstfmt is an unknown format, this routine does nothing + * with no warning that something is wrong * * @api */ -- cgit v1.2.3