Mercurial > libavutil.hg

comparison integer.h @ 957:e34e8d654ded libavutil

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents 0795a743bda1
children
comparison
equal deleted inserted replaced
956:2894d4c208dc 957:e34e8d654ded
39 39
40 AVInteger av_add_i(AVInteger a, AVInteger b) av_const; 40 AVInteger av_add_i(AVInteger a, AVInteger b) av_const;
41 AVInteger av_sub_i(AVInteger a, AVInteger b) av_const; 41 AVInteger av_sub_i(AVInteger a, AVInteger b) av_const;
42 42
43 /** 43 /**
44 * Returns the rounded-down value of the base 2 logarithm of the given 44 * Return the rounded-down value of the base 2 logarithm of the given
45 * AVInteger. This is simply the index of the most significant bit 45 * AVInteger. This is simply the index of the most significant bit
46 * which is 1, or 0 if all bits are 0. 46 * which is 1, or 0 if all bits are 0.
47 */ 47 */
48 int av_log2_i(AVInteger a) av_const; 48 int av_log2_i(AVInteger a) av_const;
49 AVInteger av_mul_i(AVInteger a, AVInteger b) av_const; 49 AVInteger av_mul_i(AVInteger a, AVInteger b) av_const;
50 50
51 /** 51 /**
52 * Returns 0 if a==b, 1 if a>b and -1 if a<b. 52 * Return 0 if a==b, 1 if a>b and -1 if a<b.
53 */ 53 */
54 int av_cmp_i(AVInteger a, AVInteger b) av_const; 54 int av_cmp_i(AVInteger a, AVInteger b) av_const;
55 55
56 /** 56 /**
57 * bitwise shift 57 * bitwise shift
59 may be negative for shifting left 59 may be negative for shifting left
60 */ 60 */
61 AVInteger av_shr_i(AVInteger a, int s) av_const; 61 AVInteger av_shr_i(AVInteger a, int s) av_const;
62 62
63 /** 63 /**
64 * Returns a % b. 64 * Return a % b.
65 * @param quot a/b will be stored here. 65 * @param quot a/b will be stored here.
66 */ 66 */
67 AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b); 67 AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b);
68 68
69 /** 69 /**
70 * Returns a/b. 70 * Return a/b.
71 */ 71 */
72 AVInteger av_div_i(AVInteger a, AVInteger b) av_const; 72 AVInteger av_div_i(AVInteger a, AVInteger b) av_const;
73 73
74 /** 74 /**
75 * Converts the given int64_t to an AVInteger. 75 * Convert the given int64_t to an AVInteger.
76 */ 76 */
77 AVInteger av_int2i(int64_t a) av_const; 77 AVInteger av_int2i(int64_t a) av_const;
78 78
79 /** 79 /**
80 * Converts the given AVInteger to an int64_t. 80 * Convert the given AVInteger to an int64_t.
81 * If the AVInteger is too large to fit into an int64_t, 81 * If the AVInteger is too large to fit into an int64_t,
82 * then only the least significant 64 bits will be used. 82 * then only the least significant 64 bits will be used.
83 */ 83 */
84 int64_t av_i2int(AVInteger a) av_const; 84 int64_t av_i2int(AVInteger a) av_const;
85 85