add some documentation to vrp.h
[libfirm] / include / libfirm / vrp.h
1 /*
2  * Copyright (C) 1995-2009 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Analyse the graph with value range propagation
23  * @author  Jonas Fietz
24  * @version $Id$
25  *
26  */
27 #include "firm_types.h"
28
29 #ifndef VRP_H
30 #define VRP_H
31
32 enum range_types {
33         VRP_UNDEFINED, /* No information could be derived so far */
34         VRP_RANGE, /* bottom and top form a range, including both values */
35         VRP_ANTIRANGE, /* range from bottom to top can not be, but borders might
36                                           be */
37         VRP_VARYING /* information can not be derived */
38 };
39
40 enum range_ops {
41         VRP_NONE, /* range is defined absolute */
42         VRP_ADD, /* range + range_node are the possible values */
43         VRP_SUB /* range - range_node are the possible values */
44 };
45
46 /**
47  * Set vrp data on the graph irg
48  * @param irg graph on which to set vrp data
49  */
50 void set_vrp_data(ir_graph *irg);
51
52 /**
53  * Creates an ir_prog_pass for vrp
54  *
55  * @param name the name of this pass or NULL
56  */
57 ir_graph_pass_t *set_vrp_pass(const char *name);
58
59 /**
60  * Test, if the two nodes can be compared with their vrp information
61  *
62  * @param left: the left node
63  * @param right: the right node
64  *
65  * @return the pn_Cmp, if one can be derived
66  */
67 pn_Cmp vrp_cmp(ir_node *left, ir_node *right);
68
69 #endif