ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/libecb/ecb.pod
(Generate patch)

Comparing cvsroot/libecb/ecb.pod (file contents):
Revision 1.27 by root, Wed Jun 1 01:29:36 2011 UTC vs.
Revision 1.32 by sf-exg, Fri Jun 17 15:55:41 2011 UTC

100 return var; 100 return var;
101 #else 101 #else
102 return 0; 102 return 0;
103 #endif 103 #endif
104 } 104 }
105
106=item ecb_inline
107
108This is not actually an attribute, but you use it like one. It expands
109either to C<static inline> or to just C<static>, if inline isn't
110supported. It should be used to declare functions that should be inlined,
111for code size or speed reasons.
112
113Example: inline this function, it surely will reduce codesize.
114
115 ecb_inline int
116 negmul (int a, int b)
117 {
118 return - (a * b);
119 }
105 120
106=item ecb_noinline 121=item ecb_noinline
107 122
108Prevent a function from being inlined - it might be optimised away, but 123Prevent a function from being inlined - it might be optimised away, but
109not inlined into other functions. This is useful if you know your function 124not inlined into other functions. This is useful if you know your function
399 414
400=item int ecb_ctz32 (uint32_t x) 415=item int ecb_ctz32 (uint32_t x)
401 416
402Returns the index of the least significant bit set in C<x> (or 417Returns the index of the least significant bit set in C<x> (or
403equivalently the number of bits set to 0 before the least significant bit 418equivalently the number of bits set to 0 before the least significant bit
404set), starting from 0. If C<x> is 0 the result is undefined. A common use 419set), starting from 0. If C<x> is 0 the result is undefined. For example:
405case is to compute the integer binary logarithm, i.e., C<floor (log2
406(n))>. For example:
407 420
408 ecb_ctz32 (3) = 0 421 ecb_ctz32 (3) = 0
409 ecb_ctz32 (6) = 1 422 ecb_ctz32 (6) = 1
410 423
411=item int ecb_popcount32 (uint32_t x) 424=item int ecb_popcount32 (uint32_t x)
448C<ecb_mod> implements the mathematical modulo operation, which is missing 461C<ecb_mod> implements the mathematical modulo operation, which is missing
449in the language. 462in the language.
450 463
451C<n> must be strictly positive (i.e. C<< >= 1 >>), while C<m> must be 464C<n> must be strictly positive (i.e. C<< >= 1 >>), while C<m> must be
452negatable, that is, both C<m> and C<-m> must be representable in its 465negatable, that is, both C<m> and C<-m> must be representable in its
453type (this typically includes the minimum signed integer value, the same 466type (this typically excludes the minimum signed integer value, the same
454limitation as for C</> and C<%> in C). 467limitation as for C</> and C<%> in C).
455 468
456Current GCC versions compile this into an efficient branchless sequence on 469Current GCC versions compile this into an efficient branchless sequence on
457many systems. 470almost all CPUs.
458 471
459For example, when you want to rotate forward through the members of an 472For example, when you want to rotate forward through the members of an
460array for increasing C<m> (which might be negative), then you should use 473array for increasing C<m> (which might be negative), then you should use
461C<ecb_mod>, as the C<%> operator might give either negative results, or 474C<ecb_mod>, as the C<%> operator might give either negative results, or
462change direction for negative values: 475change direction for negative values:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines