[ViewVC] Diff of: cvs/cvsroot/libecb/ecb.pod

Comparing cvsroot/libecb/ecb.pod (file contents):
Revision 1.71 by root, Sat Nov 21 16:53:50 2015 UTC vs.
Revision 1.84 by root, Mon Jan 20 21:10:16 2020 UTC

…		…
58		58
59	=head2 TYPES / TYPE SUPPORT	59	=head2 TYPES / TYPE SUPPORT
60		60
61	ecb.h makes sure that the following types are defined (in the expected way):	61	ecb.h makes sure that the following types are defined (in the expected way):
62		62
63	int8_t uint8_t int16_t uint16_t	63	int8_t uint8_
64	int32_t uint32_t int64_t uint64_t	64	int16_t uint16_t
		65	int32_t uint32_
		66	int64_t uint64_t
		67	int_fast8_t uint_fast8_t
		68	int_fast16_t uint_fast16_t
		69	int_fast32_t uint_fast32_t
		70	int_fast64_t uint_fast64_t
65	intptr_t uintptr_t	71	intptr_t uintptr_t
66		72
67	The macro C<ECB_PTRSIZE> is defined to the size of a pointer on this	73	The macro C<ECB_PTRSIZE> is defined to the size of a pointer on this
68	platform (currently C<4> or C<8>) and can be used in preprocessor	74	platform (currently C<4> or C<8>) and can be used in preprocessor
69	expressions.	75	expressions.
70		76
71	For C<ptrdiff_t> and C<size_t> use C<stddef.h>.	77	For C<ptrdiff_t> and C<size_t> use C<stddef.h>/C<cstddef>.
72		78
73	=head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS	79	=head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS
74		80
75	All the following symbols expand to an expression that can be tested in	81	All the following symbols expand to an expression that can be tested in
76	preprocessor instructions as well as treated as a boolean (use C<!!> to	82	preprocessor instructions as well as treated as a boolean (use C<!!> to
…		…
79	=over 4	85	=over 4
80		86
81	=item ECB_C	87	=item ECB_C
82		88
83	True if the implementation defines the C<__STDC__> macro to a true value,	89	True if the implementation defines the C<__STDC__> macro to a true value,
84	while not claiming to be C++.	90	while not claiming to be C++, i..e C, but not C++.
85		91
86	=item ECB_C99	92	=item ECB_C99
87		93
88	True if the implementation claims to be compliant to C99 (ISO/IEC	94	True if the implementation claims to be compliant to C99 (ISO/IEC
89	9899:1999) or any later version, while not claiming to be C++.	95	9899:1999) or any later version, while not claiming to be C++.
90		96
91	Note that later versions (ECB_C11) remove core features again (for	97	Note that later versions (ECB_C11) remove core features again (for
92	example, variable length arrays).	98	example, variable length arrays).
93		99
94	=item ECB_C11	100	=item ECB_C11, ECB_C17
95		101
96	True if the implementation claims to be compliant to C11 (ISO/IEC	102	True if the implementation claims to be compliant to C11/C17 (ISO/IEC
97	9899:2011) or any later version, while not claiming to be C++.	103	9899:2011, :20187) or any later version, while not claiming to be C++.
98		104
99	=item ECB_CPP	105	=item ECB_CPP
100		106
101	True if the implementation defines the C<__cplusplus__> macro to a true	107	True if the implementation defines the C<__cplusplus__> macro to a true
102	value, which is typically true for C++ compilers.	108	value, which is typically true for C++ compilers.
103		109
104	=item ECB_CPP11	110	=item ECB_CPP11, ECB_CPP14, ECB_CPP17
105		111
106	True if the implementation claims to be compliant to ISO/IEC 14882:2011	112	True if the implementation claims to be compliant to C++11/C++14/C++17
107	(C++11) or any later version.	113	(ISO/IEC 14882:2011, :2014, :2017) or any later version.
		114
		115	Note that many C++20 features will likely have their own feature test
		116	macros (see e.g. L<http://eel.is/c++draft/cpp.predefined#1.8>).
		117
		118	=item ECB_OPTIMIZE_SIZE
		119
		120	Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol
		121	can also be defined before including F<ecb.h>, in which case it will be
		122	unchanged.
108		123
109	=item ECB_GCC_VERSION (major, minor)	124	=item ECB_GCC_VERSION (major, minor)
110		125
111	Expands to a true value (suitable for testing in by the preprocessor)	126	Expands to a true value (suitable for testing by the preprocessor) if the
112	if the compiler used is GNU C and the version is the given version, or	127	compiler used is GNU C and the version is the given version, or higher.
113	higher.
114		128
115	This macro tries to return false on compilers that claim to be GCC	129	This macro tries to return false on compilers that claim to be GCC
116	compatible but aren't.	130	compatible but aren't.
117		131
118	=item ECB_EXTERN_C	132	=item ECB_EXTERN_C
…		…
137		151
138	ECB_EXTERN_C_END	152	ECB_EXTERN_C_END
139		153
140	=item ECB_STDFP	154	=item ECB_STDFP
141		155
142	If this evaluates to a true value (suitable for testing in by the	156	If this evaluates to a true value (suitable for testing by the
143	preprocessor), then C<float> and C<double> use IEEE 754 single/binary32	157	preprocessor), then C<float> and C<double> use IEEE 754 single/binary32
144	and double/binary64 representations internally I<and> the endianness of	158	and double/binary64 representations internally I<and> the endianness of
145	both types match the endianness of C<uint32_t> and C<uint64_t>.	159	both types match the endianness of C<uint32_t> and C<uint64_t>.
146		160
147	This means you can just copy the bits of a C<float> (or C<double>) to an	161	This means you can just copy the bits of a C<float> (or C<double>) to an
…		…
248	used instead of a generic depreciation message when the object is being	262	used instead of a generic depreciation message when the object is being
249	used.	263	used.
250		264
251	=item ecb_inline	265	=item ecb_inline
252		266
253	Expands either to C<static inline> or to just C<static>, if inline	267	Expands either to (a compiler-specific equivalent of) C<static inline> or
254	isn't supported. It should be used to declare functions that should be	268	to just C<static>, if inline isn't supported. It should be used to declare
255	inlined, for code size or speed reasons.	269	functions that should be inlined, for code size or speed reasons.
256		270
257	Example: inline this function, it surely will reduce codesize.	271	Example: inline this function, it surely will reduce codesize.
258		272
259	ecb_inline int	273	ecb_inline int
260	negmul (int a, int b)	274	negmul (int a, int b)
…		…
583		597
584	=item int ecb_ctz32 (uint32_t x)	598	=item int ecb_ctz32 (uint32_t x)
585		599
586	=item int ecb_ctz64 (uint64_t x)	600	=item int ecb_ctz64 (uint64_t x)
587		601
		602	=item int ecb_ctz (T x) [C++]
		603
588	Returns the index of the least significant bit set in C<x> (or	604	Returns the index of the least significant bit set in C<x> (or
589	equivalently the number of bits set to 0 before the least significant bit	605	equivalently the number of bits set to 0 before the least significant bit
590	set), starting from 0. If C<x> is 0 the result is undefined.	606	set), starting from 0. If C<x> is 0 the result is undefined.
591		607
592	For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>.	608	For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>.
593		609
		610	The overloaded C++ C<ecb_ctz> function supports C<uint8_t>, C<uint16_t>,
		611	C<uint32_t> and C<uint64_t> types.
		612
594	For example:	613	For example:
595		614
596	ecb_ctz32 (3) = 0	615	ecb_ctz32 (3) = 0
597	ecb_ctz32 (6) = 1	616	ecb_ctz32 (6) = 1
598		617
599	=item bool ecb_is_pot32 (uint32_t x)	618	=item bool ecb_is_pot32 (uint32_t x)
600		619
601	=item bool ecb_is_pot64 (uint32_t x)	620	=item bool ecb_is_pot64 (uint32_t x)
602		621
		622	=item bool ecb_is_pot (T x) [C++]
		623
603	Returns true iff C<x> is a power of two or C<x == 0>.	624	Returns true iff C<x> is a power of two or C<x == 0>.
604		625
605	For smaller types than C<uint32_t> you can safely use C<ecb_is_pot32>.	626	For smaller types than C<uint32_t> you can safely use C<ecb_is_pot32>.
606		627
		628	The overloaded C++ C<ecb_is_pot> function supports C<uint8_t>, C<uint16_t>,
		629	C<uint32_t> and C<uint64_t> types.
		630
607	=item int ecb_ld32 (uint32_t x)	631	=item int ecb_ld32 (uint32_t x)
608		632
609	=item int ecb_ld64 (uint64_t x)	633	=item int ecb_ld64 (uint64_t x)
		634
		635	=item int ecb_ld64 (T x) [C++]
610		636
611	Returns the index of the most significant bit set in C<x>, or the number	637	Returns the index of the most significant bit set in C<x>, or the number
612	of digits the number requires in binary (so that C<< 2**ld <= x <	638	of digits the number requires in binary (so that C<< 2**ld <= x <
613	2**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is	639	2**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is
614	to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for	640	to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for
…		…
619	the given data type), while C<ecb_ld> returns how many bits the number	645	the given data type), while C<ecb_ld> returns how many bits the number
620	itself requires.	646	itself requires.
621		647
622	For smaller types than C<uint32_t> you can safely use C<ecb_ld32>.	648	For smaller types than C<uint32_t> you can safely use C<ecb_ld32>.
623		649
		650	The overloaded C++ C<ecb_ld> function supports C<uint8_t>, C<uint16_t>,
		651	C<uint32_t> and C<uint64_t> types.
		652
624	=item int ecb_popcount32 (uint32_t x)	653	=item int ecb_popcount32 (uint32_t x)
625		654
626	=item int ecb_popcount64 (uint64_t x)	655	=item int ecb_popcount64 (uint64_t x)
627		656
		657	=item int ecb_popcount (T x) [C++]
		658
628	Returns the number of bits set to 1 in C<x>.	659	Returns the number of bits set to 1 in C<x>.
629		660
630	For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>.	661	For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>.
		662
		663	The overloaded C++ C<ecb_popcount> function supports C<uint8_t>, C<uint16_t>,
		664	C<uint32_t> and C<uint64_t> types.
631		665
632	For example:	666	For example:
633		667
634	ecb_popcount32 (7) = 3	668	ecb_popcount32 (7) = 3
635	ecb_popcount32 (255) = 8	669	ecb_popcount32 (255) = 8
…		…
638		672
639	=item uint16_t ecb_bitrev16 (uint16_t x)	673	=item uint16_t ecb_bitrev16 (uint16_t x)
640		674
641	=item uint32_t ecb_bitrev32 (uint32_t x)	675	=item uint32_t ecb_bitrev32 (uint32_t x)
642		676
		677	=item T ecb_bitrev (T x) [C++]
		678
643	Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1	679	Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1
644	and so on.	680	and so on.
645		681
		682	The overloaded C++ C<ecb_bitrev> function supports C<uint8_t>, C<uint16_t> and C<uint32_t> types.
		683
646	Example:	684	Example:
647		685
648	ecb_bitrev8 (0xa7) = 0xea	686	ecb_bitrev8 (0xa7) = 0xea
649	ecb_bitrev32 (0xffcc4411) = 0x882233ff	687	ecb_bitrev32 (0xffcc4411) = 0x882233ff
650		688
		689	=item T ecb_bitrev (T x) [C++]
		690
		691	Overloaded C++ bitrev function.
		692
		693	C<T> must be one of C<uint8_t>, C<uint16_t> or C<uint32_t>.
		694
651	=item uint32_t ecb_bswap16 (uint32_t x)	695	=item uint32_t ecb_bswap16 (uint32_t x)
652		696
653	=item uint32_t ecb_bswap32 (uint32_t x)	697	=item uint32_t ecb_bswap32 (uint32_t x)
654		698
655	=item uint64_t ecb_bswap64 (uint64_t x)	699	=item uint64_t ecb_bswap64 (uint64_t x)
		700
		701	=item T ecb_bswap (T x)
656		702
657	These functions return the value of the 16-bit (32-bit, 64-bit) value	703	These functions return the value of the 16-bit (32-bit, 64-bit) value
658	C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in	704	C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in
659	C<ecb_bswap32>).	705	C<ecb_bswap32>).
660		706
		707	The overloaded C++ C<ecb_bswap> function supports C<uint8_t>, C<uint16_t>,
		708	C<uint32_t> and C<uint64_t> types.
		709
661	=item uint8_t ecb_rotl8 (uint8_t x, unsigned int count)	710	=item uint8_t ecb_rotl8 (uint8_t x, unsigned int count)
662		711
663	=item uint16_t ecb_rotl16 (uint16_t x, unsigned int count)	712	=item uint16_t ecb_rotl16 (uint16_t x, unsigned int count)
664		713
665	=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count)	714	=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count)
…		…
679	(C<ecb_rotl>).	728	(C<ecb_rotl>).
680		729
681	Current GCC versions understand these functions and usually compile them	730	Current GCC versions understand these functions and usually compile them
682	to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on	731	to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on
683	x86).	732	x86).
		733
		734	=item T ecb_rotl (T x, unsigned int count) [C++]
		735
		736	=item T ecb_rotr (T x, unsigned int count) [C++]
		737
		738	Overloaded C++ rotl/rotr functions.
		739
		740	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
		741
		742	=back
		743
		744	=head2 HOST ENDIANNESS CONVERSION
		745
		746	=over 4
		747
		748	=item uint_fast16_t ecb_be_u16_to_host (uint_fast16_t v)
		749
		750	=item uint_fast32_t ecb_be_u32_to_host (uint_fast32_t v)
		751
		752	=item uint_fast64_t ecb_be_u64_to_host (uint_fast64_t v)
		753
		754	=item uint_fast16_t ecb_le_u16_to_host (uint_fast16_t v)
		755
		756	=item uint_fast32_t ecb_le_u32_to_host (uint_fast32_t v)
		757
		758	=item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v)
		759
		760	Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order.
		761
		762	The naming convention is C<ecb_>(C<be>\|C<le>)C<_u>C<16\|32\|64>C<_to_host>,
		763	where C<be> and C<le> stand for big endian and little endian, respectively.
		764
		765	=item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v)
		766
		767	=item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v)
		768
		769	=item uint_fast64_t ecb_host_to_be_u64 (uint_fast64_t v)
		770
		771	=item uint_fast16_t ecb_host_to_le_u16 (uint_fast16_t v)
		772
		773	=item uint_fast32_t ecb_host_to_le_u32 (uint_fast32_t v)
		774
		775	=item uint_fast64_t ecb_host_to_le_u64 (uint_fast64_t v)
		776
		777	Like above, but converts I<from> host byte order to the specified
		778	endianness.
		779
		780	=back
		781
		782	In C++ the following additional template functions are supported:
		783
		784	=over 4
		785
		786	=item T ecb_be_to_host (T v)
		787
		788	=item T ecb_le_to_host (T v)
		789
		790	=item T ecb_host_to_be (T v)
		791
		792	=item T ecb_host_to_le (T v)
		793
		794	These functions work like their C counterparts, above, but use templates,
		795	which make them useful in generic code.
		796
		797	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>
		798	(so unlike their C counterparts, there is a version for C<uint8_t>, which
		799	again can be useful in generic code).
		800
		801	=head2 UNALIGNED LOAD/STORE
		802
		803	These function load or store unaligned multi-byte values.
		804
		805	=over 4
		806
		807	=item uint_fast16_t ecb_peek_u16_u (const void *ptr)
		808
		809	=item uint_fast32_t ecb_peek_u32_u (const void *ptr)
		810
		811	=item uint_fast64_t ecb_peek_u64_u (const void *ptr)
		812
		813	These functions load an unaligned, unsigned 16, 32 or 64 bit value from
		814	memory.
		815
		816	=item uint_fast16_t ecb_peek_be_u16_u (const void *ptr)
		817
		818	=item uint_fast32_t ecb_peek_be_u32_u (const void *ptr)
		819
		820	=item uint_fast64_t ecb_peek_be_u64_u (const void *ptr)
		821
		822	=item uint_fast16_t ecb_peek_le_u16_u (const void *ptr)
		823
		824	=item uint_fast32_t ecb_peek_le_u32_u (const void *ptr)
		825
		826	=item uint_fast64_t ecb_peek_le_u64_u (const void *ptr)
		827
		828	Like above, but additionally convert from big endian (C<be>) or little
		829	endian (C<le>) byte order to host byte order while doing so.
		830
		831	=item ecb_poke_u16_u (void *ptr, uint16_t v)
		832
		833	=item ecb_poke_u32_u (void *ptr, uint32_t v)
		834
		835	=item ecb_poke_u64_u (void *ptr, uint64_t v)
		836
		837	These functions store an unaligned, unsigned 16, 32 or 64 bit value to
		838	memory.
		839
		840	=item ecb_poke_be_u16_u (void *ptr, uint_fast16_t v)
		841
		842	=item ecb_poke_be_u32_u (void *ptr, uint_fast32_t v)
		843
		844	=item ecb_poke_be_u64_u (void *ptr, uint_fast64_t v)
		845
		846	=item ecb_poke_le_u16_u (void *ptr, uint_fast16_t v)
		847
		848	=item ecb_poke_le_u32_u (void *ptr, uint_fast32_t v)
		849
		850	=item ecb_poke_le_u64_u (void *ptr, uint_fast64_t v)
		851
		852	Like above, but additionally convert from host byte order to big endian
		853	(C<be>) or little endian (C<le>) byte order while doing so.
		854
		855	=back
		856
		857	In C++ the following additional template functions are supported:
		858
		859	=over 4
		860
		861	=item T ecb_peek<T> (const void *ptr)
		862
		863	=item T ecb_peek_be<T> (const void *ptr)
		864
		865	=item T ecb_peek_le<T> (const void *ptr)
		866
		867	=item T ecb_peek_u<T> (const void *ptr)
		868
		869	=item T ecb_peek_be_u<T> (const void *ptr)
		870
		871	=item T ecb_peek_le_u<T> (const void *ptr)
		872
		873	Similarly to their C counterparts, these functions load an unsigned 8, 16,
		874	32 or 64 bit value from memory, with optional conversion from big/little
		875	endian.
		876
		877	Since the type cannot be deduced, it has to be specified explicitly, e.g.
		878
		879	uint_fast16_t v = ecb_peek<uint16_t> (ptr);
		880
		881	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
		882
		883	Unlike their C counterparts, these functions support 8 bit quantities
		884	(C<uint8_t>) and also have an aligned version (without the C<_u> prefix),
		885	all of which hopefully makes them more useful in generic code.
		886
		887	=item ecb_poke (void *ptr, T v)
		888
		889	=item ecb_poke_be (void *ptr, T v)
		890
		891	=item ecb_poke_le (void *ptr, T v)
		892
		893	=item ecb_poke_u (void *ptr, T v)
		894
		895	=item ecb_poke_be_u (void *ptr, T v)
		896
		897	=item ecb_poke_le_u (void *ptr, T v)
		898
		899	Again, similarly to their C counterparts, these functions store an
		900	unsigned 8, 16, 32 or z64 bit value to memory, with optional conversion to
		901	big/little endian.
		902
		903	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
		904
		905	Unlike their C counterparts, these functions support 8 bit quantities
		906	(C<uint8_t>) and also have an aligned version (without the C<_u> prefix),
		907	all of which hopefully makes them more useful in generic code.
684		908
685	=back	909	=back
686		910
687	=head2 FLOATING POINT FIDDLING	911	=head2 FLOATING POINT FIDDLING
688		912
…		…
760	=item uint16_t ecb_binary32_to_binary16 (uint32_t x)	984	=item uint16_t ecb_binary32_to_binary16 (uint32_t x)
761		985
762	=item uint32_t ecb_binary16_to_binary32 (uint16_t x)	986	=item uint32_t ecb_binary16_to_binary32 (uint16_t x)
763		987
764	Convert a IEEE binary32/single precision to binary16/half format, and vice	988	Convert a IEEE binary32/single precision to binary16/half format, and vice
765	versa, handling all details (round-to-even, subnormals, infinity and NaNs)	989	versa, handling all details (round-to-nearest-even, subnormals, infinity
766	correctly.	990	and NaNs) correctly.
767		991
768	These are functions are available under C<-DECB_NO_LIBM>, since	992	These are functions are available under C<-DECB_NO_LIBM>, since
769	they do not rely on the platform floating point format. The	993	they do not rely on the platform floating point format. The
770	C<ecb_float_to_binary16> and C<ecb_binary16_to_float> functions are	994	C<ecb_float_to_binary16> and C<ecb_binary16_to_float> functions are
771	usually what you want.	995	usually what you want.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing cvsroot/libecb/ecb.pod (file contents): Revision 1.71 by root, Sat Nov 21 16:53:50 2015 UTC vs. Revision 1.84 by root, Mon Jan 20 21:10:16 2020 UTC

Diff Legend

Comparing cvsroot/libecb/ecb.pod (file contents):
Revision 1.71 by root, Sat Nov 21 16:53:50 2015 UTC vs.
Revision 1.84 by root, Mon Jan 20 21:10:16 2020 UTC