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

Comparing libecb/ecb.pod (file contents):
Revision 1.35 by root, Fri Jun 17 21:38:31 2011 UTC vs.
Revision 1.58 by root, Thu Oct 16 15:01:54 2014 UTC

…		…
54	only a generic name is used (C<expr>, C<cond>, C<value> and so on), then	54	only a generic name is used (C<expr>, C<cond>, C<value> and so on), then
55	the corresponding function relies on C to implement the correct types, and	55	the corresponding function relies on C to implement the correct types, and
56	is usually implemented as a macro. Specifically, a "bool" in this manual	56	is usually implemented as a macro. Specifically, a "bool" in this manual
57	refers to any kind of boolean value, not a specific type.	57	refers to any kind of boolean value, not a specific type.
58		58
		59	=head2 TYPES / TYPE SUPPORT
		60
		61	ecb.h makes sure that the following types are defined (in the expected way):
		62
		63	int8_t uint8_t int16_t uint16_t
		64	int32_t uint32_t int64_t uint64_t
		65	intptr_t uintptr_t
		66
		67	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
		69	expressions.
		70
		71	For C<ptrdiff_t> and C<size_t> use C<stddef.h>.
		72
		73	=head2 LANGUAGE/COMPILER VERSIONS
		74
		75	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
		77	ensure it's either C<0> or C<1> if you need that).
		78
		79	=over 4
		80
		81	=item ECB_C
		82
		83	True if the implementation defines the C<__STDC__> macro to a true value,
		84	while not claiming to be C++.
		85
		86	=item ECB_C99
		87
		88	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++.
		90
		91	Note that later versions (ECB_C11) remove core features again (for
		92	example, variable length arrays).
		93
		94	=item ECB_C11
		95
		96	True if the implementation claims to be compliant to C11 (ISO/IEC
		97	9899:2011) or any later version, while not claiming to be C++.
		98
		99	=item ECB_CPP
		100
		101	True if the implementation defines the C<__cplusplus__> macro to a true
		102	value, which is typically true for C++ compilers.
		103
		104	=item ECB_CPP11
		105
		106	True if the implementation claims to be compliant to ISO/IEC 14882:2011
		107	(C++11) or any later version.
		108
		109	=item ECB_GCC_VERSION (major, minor)
		110
		111	Expands to a true value (suitable for testing in by the preprocessor)
		112	if the compiler used is GNU C and the version is the given version, or
		113	higher.
		114
		115	This macro tries to return false on compilers that claim to be GCC
		116	compatible but aren't.
		117
		118	=item ECB_EXTERN_C
		119
		120	Expands to C<extern "C"> in C++, and a simple C<extern> in C.
		121
		122	This can be used to declare a single external C function:
		123
		124	ECB_EXTERN_C int printf (const char *format, ...);
		125
		126	=item ECB_EXTERN_C_BEG / ECB_EXTERN_C_END
		127
		128	These two macros can be used to wrap multiple C<extern "C"> definitions -
		129	they expand to nothing in C.
		130
		131	They are most useful in header files:
		132
		133	ECB_EXTERN_C_BEG
		134
		135	int mycfun1 (int x);
		136	int mycfun2 (int x);
		137
		138	ECB_EXTERN_C_END
		139
		140	=item ECB_STDFP
		141
		142	If this evaluates to a true value (suitable for testing in by the
		143	preprocessor), then C<float> and C<double> use IEEE 754 single/binary32
		144	and double/binary64 representations internally I<and> the endianness of
		145	both types match the endianness of C<uint32_t> and C<uint64_t>.
		146
		147	This means you can just copy the bits of a C<float> (or C<double>) to an
		148	C<uint32_t> (or C<uint64_t>) and get the raw IEEE 754 bit representation
		149	without having to think about format or endianness.
		150
		151	This is true for basically all modern platforms, although F<ecb.h> might
		152	not be able to deduce this correctly everywhere and might err on the safe
		153	side.
		154
		155	=item ECB_AMD64, ECB_AMD64_X32
		156
		157	These two macros are defined to C<1> on the x86_64/amd64 ABI and the X32
		158	ABI, respectively, and undefined elsewhere.
		159
		160	The designers of the new X32 ABI for some inexplicable reason decided to
		161	make it look exactly like amd64, even though it's completely incompatible
		162	to that ABI, breaking about every piece of software that assumed that
		163	C<__x86_64> stands for, well, the x86-64 ABI, making these macros
		164	necessary.
		165
		166	=back
		167
59	=head2 GCC ATTRIBUTES	168	=head2 GCC ATTRIBUTES
60		169
61	A major part of libecb deals with GCC attributes. These are additional	170	A major part of libecb deals with GCC attributes. These are additional
62	attributes that you can assign to functions, variables and sometimes even	171	attributes that you can assign to functions, variables and sometimes even
63	types - much like C<const> or C<volatile> in C.	172	types - much like C<const> or C<volatile> in C.
…		…
76		185
77	=over 4	186	=over 4
78		187
79	=item ecb_attribute ((attrs...))	188	=item ecb_attribute ((attrs...))
80		189
81	A simple wrapper that expands to C<__attribute__((attrs))> on GCC, and to	190	A simple wrapper that expands to C<__attribute__((attrs))> on GCC 3.1+ and
82	nothing on other compilers, so the effect is that only GCC sees these.	191	Clang 2.8+, and to nothing on other compilers, so the effect is that only
		192	GCC and Clang see these.
83		193
84	Example: use the C<deprecated> attribute on a function.	194	Example: use the C<deprecated> attribute on a function.
85		195
86	ecb_attribute((__deprecated__)) void	196	ecb_attribute((__deprecated__)) void
87	do_not_use_me_anymore (void);	197	do_not_use_me_anymore (void);
…		…
101	#else	211	#else
102	return 0;	212	return 0;
103	#endif	213	#endif
104	}	214	}
105		215
		216	=item ecb_deprecated
		217
		218	Similar to C<ecb_unused>, but marks a function, variable or type as
		219	deprecated. This makes some compilers warn when the type is used.
		220
106	=item ecb_inline	221	=item ecb_inline
107		222
108	This is not actually an attribute, but you use it like one. It expands	223	This is not actually an attribute, but you use it like one. It expands
109	either to C<static inline> or to just C<static>, if inline isn't	224	either to C<static inline> or to just C<static>, if inline isn't
110	supported. It should be used to declare functions that should be inlined,	225	supported. It should be used to declare functions that should be inlined,
…		…
138	}	253	}
139		254
140	In this case, the compiler would probably be smart enough to deduce it on	255	In this case, the compiler would probably be smart enough to deduce it on
141	its own, so this is mainly useful for declarations.	256	its own, so this is mainly useful for declarations.
142		257
		258	=item ecb_restrict
		259
		260	Expands to the C<restrict> keyword or equivalent on compilers that support
		261	them, and to nothing on others. Must be specified on a pointer type or
		262	an array index to indicate that the memory doesn't alias with any other
		263	restricted pointer in the same scope.
		264
		265	Example: multiply a vector, and allow the compiler to parallelise the
		266	loop, because it knows it doesn't overwrite input values.
		267
		268	void
		269	multiply (float *ecb_restrict src,
		270	float *ecb_restrict dst,
		271	int len, float factor)
		272	{
		273	int i;
		274
		275	for (i = 0; i < len; ++i)
		276	dst [i] = src [i] * factor;
		277	}
		278
143	=item ecb_const	279	=item ecb_const
144		280
145	Declares that the function only depends on the values of its arguments,	281	Declares that the function only depends on the values of its arguments,
146	much like a mathematical function. It specifically does not read or write	282	much like a mathematical function. It specifically does not read or write
147	any memory any arguments might point to, global variables, or call any	283	any memory any arguments might point to, global variables, or call any
…		…
207	functions only called in exceptional or rare cases.	343	functions only called in exceptional or rare cases.
208		344
209	=item ecb_artificial	345	=item ecb_artificial
210		346
211	Declares the function as "artificial", in this case meaning that this	347	Declares the function as "artificial", in this case meaning that this
212	function is not really mean to be a function, but more like an accessor	348	function is not really meant to be a function, but more like an accessor
213	- many methods in C++ classes are mere accessor functions, and having a	349	- many methods in C++ classes are mere accessor functions, and having a
214	crash reported in such a method, or single-stepping through them, is not	350	crash reported in such a method, or single-stepping through them, is not
215	usually so helpful, especially when it's inlined to just a few instructions.	351	usually so helpful, especially when it's inlined to just a few instructions.
216		352
217	Marking them as artificial will instruct the debugger about just this,	353	Marking them as artificial will instruct the debugger about just this,
…		…
237		373
238	=head2 OPTIMISATION HINTS	374	=head2 OPTIMISATION HINTS
239		375
240	=over 4	376	=over 4
241		377
242	=item bool ecb_is_constant(expr)	378	=item bool ecb_is_constant (expr)
243		379
244	Returns true iff the expression can be deduced to be a compile-time	380	Returns true iff the expression can be deduced to be a compile-time
245	constant, and false otherwise.	381	constant, and false otherwise.
246		382
247	For example, when you have a C<rndm16> function that returns a 16 bit	383	For example, when you have a C<rndm16> function that returns a 16 bit
…		…
396	After processing the node, (part of) the next node might already be in	532	After processing the node, (part of) the next node might already be in
397	cache.	533	cache.
398		534
399	=back	535	=back
400		536
401	=head2 BIT FIDDLING / BITSTUFFS	537	=head2 BIT FIDDLING / BIT WIZARDRY
402		538
403	=over 4	539	=over 4
404		540
405	=item bool ecb_big_endian ()	541	=item bool ecb_big_endian ()
406		542
…		…
418		554
419	Returns the index of the least significant bit set in C<x> (or	555	Returns the index of the least significant bit set in C<x> (or
420	equivalently the number of bits set to 0 before the least significant bit	556	equivalently the number of bits set to 0 before the least significant bit
421	set), starting from 0. If C<x> is 0 the result is undefined.	557	set), starting from 0. If C<x> is 0 the result is undefined.
422		558
		559	For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>.
		560
423	For example:	561	For example:
424		562
425	ecb_ctz32 (3) = 0	563	ecb_ctz32 (3) = 0
426	ecb_ctz32 (6) = 1	564	ecb_ctz32 (6) = 1
		565
		566	=item bool ecb_is_pot32 (uint32_t x)
		567
		568	=item bool ecb_is_pot64 (uint32_t x)
		569
		570	Return true iff C<x> is a power of two or C<x == 0>.
		571
		572	For smaller types then C<uint32_t> you can safely use C<ecb_is_pot32>.
427		573
428	=item int ecb_ld32 (uint32_t x)	574	=item int ecb_ld32 (uint32_t x)
429		575
430	=item int ecb_ld64 (uint64_t x)	576	=item int ecb_ld64 (uint64_t x)
431		577
…		…
438	This function is similar to the "count leading zero bits" function, except	584	This function is similar to the "count leading zero bits" function, except
439	that that one returns how many zero bits are "in front" of the number (in	585	that that one returns how many zero bits are "in front" of the number (in
440	the given data type), while C<ecb_ld> returns how many bits the number	586	the given data type), while C<ecb_ld> returns how many bits the number
441	itself requires.	587	itself requires.
442		588
		589	For smaller types than C<uint32_t> you can safely use C<ecb_ld32>.
		590
443	=item int ecb_popcount32 (uint32_t x)	591	=item int ecb_popcount32 (uint32_t x)
444		592
445	=item int ecb_popcount64 (uint64_t x)	593	=item int ecb_popcount64 (uint64_t x)
446		594
447	Returns the number of bits set to 1 in C<x>. For example:	595	Returns the number of bits set to 1 in C<x>.
		596
		597	For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>.
		598
		599	For example:
448		600
449	ecb_popcount32 (7) = 3	601	ecb_popcount32 (7) = 3
450	ecb_popcount32 (255) = 8	602	ecb_popcount32 (255) = 8
		603
		604	=item uint8_t ecb_bitrev8 (uint8_t x)
		605
		606	=item uint16_t ecb_bitrev16 (uint16_t x)
		607
		608	=item uint32_t ecb_bitrev32 (uint32_t x)
		609
		610	Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1
		611	and so on.
		612
		613	Example:
		614
		615	ecb_bitrev8 (0xa7) = 0xea
		616	ecb_bitrev32 (0xffcc4411) = 0x882233ff
451		617
452	=item uint32_t ecb_bswap16 (uint32_t x)	618	=item uint32_t ecb_bswap16 (uint32_t x)
453		619
454	=item uint32_t ecb_bswap32 (uint32_t x)	620	=item uint32_t ecb_bswap32 (uint32_t x)
455		621
…		…
480	(C<ecb_rotl>).	646	(C<ecb_rotl>).
481		647
482	Current GCC versions understand these functions and usually compile them	648	Current GCC versions understand these functions and usually compile them
483	to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on	649	to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on
484	x86).	650	x86).
		651
		652	=back
		653
		654	=head2 FLOATING POINT FIDDLING
		655
		656	=over 4
		657
		658	=item uint32_t ecb_float_to_binary32 (float x) [-UECB_NO_LIBM]
		659
		660	=item uint64_t ecb_double_to_binary64 (double x) [-UECB_NO_LIBM]
		661
		662	These functions each take an argument in the native C<float> or C<double>
		663	type and return the IEEE 754 bit representation of it.
		664
		665	The bit representation is just as IEEE 754 defines it, i.e. the sign bit
		666	will be the most significant bit, followed by exponent and mantissa.
		667
		668	This function should work even when the native floating point format isn't
		669	IEEE compliant, of course at a speed and code size penalty, and of course
		670	also within reasonable limits (it tries to convert NaNs, infinities and
		671	denormals, but will likely convert negative zero to positive zero).
		672
		673	On all modern platforms (where C<ECB_STDFP> is true), the compiler should
		674	be able to optimise away this function completely.
		675
		676	These functions can be helpful when serialising floats to the network - you
		677	can serialise the return value like a normal uint32_t/uint64_t.
		678
		679	Another use for these functions is to manipulate floating point values
		680	directly.
		681
		682	Silly example: toggle the sign bit of a float.
		683
		684	/* On gcc-4.7 on amd64, */
		685	/* this results in a single add instruction to toggle the bit, and 4 extra */
		686	/* instructions to move the float value to an integer register and back. */
		687
		688	x = ecb_binary32_to_float (ecb_float_to_binary32 (x) ^ 0x80000000U)
		689
		690	=item float ecb_binary16_to_float (uint16_t x) [-UECB_NO_LIBM]
		691
		692	=item float ecb_binary32_to_float (uint32_t x) [-UECB_NO_LIBM]
		693
		694	=item double ecb_binary32_to_double (uint64_t x) [-UECB_NO_LIBM]
		695
		696	The reverse operation of the previos function - takes the bit
		697	representation of an IEEE binary16, binary32 or binary64 number and
		698	converts it to the native C<float> or C<double> format.
		699
		700	This function should work even when the native floating point format isn't
		701	IEEE compliant, of course at a speed and code size penalty, and of course
		702	also within reasonable limits (it tries to convert normals and denormals,
		703	and might be lucky for infinities, and with extraordinary luck, also for
		704	negative zero).
		705
		706	On all modern platforms (where C<ECB_STDFP> is true), the compiler should
		707	be able to optimise away this function completely.
485		708
486	=back	709	=back
487		710
488	=head2 ARITHMETIC	711	=head2 ARITHMETIC
489		712
…		…
513	change direction for negative values:	736	change direction for negative values:
514		737
515	for (m = -100; m <= 100; ++m)	738	for (m = -100; m <= 100; ++m)
516	int elem = myarray [ecb_mod (m, ecb_array_length (myarray))];	739	int elem = myarray [ecb_mod (m, ecb_array_length (myarray))];
517		740
		741	=item x = ecb_div_rd (val, div)
		742
		743	=item x = ecb_div_ru (val, div)
		744
		745	Returns C<val> divided by C<div> rounded down or up, respectively.
		746	C<val> and C<div> must have integer types and C<div> must be strictly
		747	positive. Note that these functions are implemented with macros in C
		748	and with function templates in C++.
		749
518	=back	750	=back
519		751
520	=head2 UTILITY	752	=head2 UTILITY
521		753
522	=over 4	754	=over 4
…		…
531	for (i = 0; i < ecb_array_length (primes); i++)	763	for (i = 0; i < ecb_array_length (primes); i++)
532	sum += primes [i];	764	sum += primes [i];
533		765
534	=back	766	=back
535		767
		768	=head2 SYMBOLS GOVERNING COMPILATION OF ECB.H ITSELF
536		769
		770	These symbols need to be defined before including F<ecb.h> the first time.
		771
		772	=over 4
		773
		774	=item ECB_NO_THREADS
		775
		776	If F<ecb.h> is never used from multiple threads, then this symbol can
		777	be defined, in which case memory fences (and similar constructs) are
		778	completely removed, leading to more efficient code and fewer dependencies.
		779
		780	Setting this symbol to a true value implies C<ECB_NO_SMP>.
		781
		782	=item ECB_NO_SMP
		783
		784	The weaker version of C<ECB_NO_THREADS> - if F<ecb.h> is used from
		785	multiple threads, but never concurrently (e.g. if the system the program
		786	runs on has only a single CPU with a single core, no hyperthreading and so
		787	on), then this symbol can be defined, leading to more efficient code and
		788	fewer dependencies.
		789
		790	=item ECB_NO_LIBM
		791
		792	When defined to C<1>, do not export any functions that might introduce
		793	dependencies on the math library (usually called F<-lm>) - these are
		794	marked with [-UECB_NO_LIBM].
		795
		796	=back
		797
		798

Diff Legend

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

Comparing libecb/ecb.pod (file contents): Revision 1.35 by root, Fri Jun 17 21:38:31 2011 UTC vs. Revision 1.58 by root, Thu Oct 16 15:01:54 2014 UTC

Diff Legend

Comparing libecb/ecb.pod (file contents):
Revision 1.35 by root, Fri Jun 17 21:38:31 2011 UTC vs.
Revision 1.58 by root, Thu Oct 16 15:01:54 2014 UTC