app/testpmd: port info prints dynamically mapped flow types
[dpdk.git] / lib / librte_sched / rte_approx.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef __INCLUDE_RTE_APPROX_H__
35 #define __INCLUDE_RTE_APPROX_H__
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /**
42  * @file
43  * RTE Rational Approximation
44  *
45  * Given a rational number alpha with 0 < alpha < 1 and a precision d, the goal
46  * is to find positive integers p, q such that alpha - d < p/q < alpha + d, and
47  * q is minimal.
48  *
49  ***/
50
51 #include <stdint.h>
52
53 /**
54  * Find best rational approximation
55  *
56  * @param alpha
57  *   Rational number to approximate
58  * @param d
59  *   Precision for the rational approximation
60  * @param p
61  *   Pointer to pre-allocated space where the numerator of the rational
62  *   approximation will be stored when operation is successful
63  * @param q
64  *   Pointer to pre-allocated space where the denominator of the rational
65  *   approximation will be stored when operation is successful
66  * @return
67  *   0 upon success, error code otherwise
68  */
69 int rte_approx(double alpha, double d, uint32_t *p, uint32_t *q);
70
71 #ifdef __cplusplus
72 }
73 #endif
74
75 #endif /* __INCLUDE_RTE_APPROX_H__ */