GCC Middle and Back End API Reference
tree-affine.h
Go to the documentation of this file.
1/* Operations with affine combinations of trees.
2 Copyright (C) 2005-2024 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it
7under the terms of the GNU General Public License as published by the
8Free Software Foundation; either version 3, or (at your option) any
9later version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT
12ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20/* Affine combination of trees. We keep track of at most MAX_AFF_ELTS elements
21 to make things simpler; this is sufficient in most cases. */
22
23#ifndef GCC_TREE_AFFINE_H
24#define GCC_TREE_AFFINE_H
25
26
27#define MAX_AFF_ELTS 8
28
29/* Element of an affine combination. */
30
32{
33public:
34 /* The value of the element. */
36
37 /* Its coefficient in the combination. */
39};
40
42{
43public:
44 /* Type of the result of the combination. */
46
47 /* Constant offset. */
49
50 /* Number of elements of the combination. */
51 unsigned n;
52
53 /* Elements and their coefficients. Type of elements may be different from
54 TYPE, but their sizes must be the same (STRIP_NOPS is applied to the
55 elements).
56
57 The coefficients are always sign extended from the precision of TYPE
58 (regardless of signedness of TYPE). */
60
61 /* Remainder of the expression. Usually NULL, used only if there are more
62 than MAX_AFF_ELTS elements. Type of REST will be either sizetype for
63 TYPE of POINTER_TYPEs or TYPE. */
65};
66
67class name_expansion;
68
75void aff_combination_remove_elt (aff_tree *, unsigned);
88 const poly_widest_int &);
89
90/* Debugging functions. */
91void debug_aff (aff_tree *);
92
93/* Return AFF's type. */
94inline tree
96{
97 return aff->type;
98}
99
100/* Return true if AFF is actually ZERO. */
101inline bool
103{
104 if (!aff)
105 return true;
106
107 if (aff->n == 0 && known_eq (aff->offset, 0))
108 return true;
109
110 return false;
111}
112
113/* Return true if AFF is actually const. */
114inline bool
116{
117 return (aff == NULL || aff->n == 0);
118}
119
120/* Return true iff AFF contains one (negated) singleton variable. Users need
121 to make sure AFF points to a valid combination. */
122inline bool
124{
125 return (aff->n == 1
126 && known_eq (aff->offset, 0)
127 && (aff->elts[0].coef == 1 || aff->elts[0].coef == -1));
128}
129#endif /* GCC_TREE_AFFINE_H */
Definition tree-affine.h:32
tree val
Definition tree-affine.h:35
widest_int coef
Definition tree-affine.h:38
Definition tree-affine.h:42
class aff_comb_elt elts[MAX_AFF_ELTS]
Definition tree-affine.h:59
unsigned n
Definition tree-affine.h:51
tree rest
Definition tree-affine.h:64
tree type
Definition tree-affine.h:45
poly_widest_int offset
Definition tree-affine.h:48
Definition hash-map.h:40
Definition tree-affine.cc:708
union tree_node * tree
Definition coretypes.h:97
#define known_eq(A, B)
#define NULL
Definition system.h:50
void free_affine_expand_cache(hash_map< tree, name_expansion * > **)
Definition tree-affine.cc:873
void tree_to_aff_combination_expand(tree, tree, aff_tree *, hash_map< tree, name_expansion * > **)
Definition tree-affine.cc:851
void aff_combination_add(aff_tree *, aff_tree *)
Definition tree-affine.cc:210
void aff_combination_convert(aff_tree *, tree)
Definition tree-affine.cc:224
void debug_aff(aff_tree *)
Definition tree-affine.cc:1001
void aff_combination_expand(aff_tree *, hash_map< tree, name_expansion * > **)
Definition tree-affine.cc:720
void tree_to_aff_combination(tree, tree, aff_tree *)
Definition tree-affine.cc:388
void aff_combination_mult(aff_tree *, aff_tree *, aff_tree *)
Definition tree-affine.cc:661
void aff_combination_add_elt(aff_tree *, tree, const widest_int &)
Definition tree-affine.cc:140
void unshare_aff_combination(aff_tree *)
Definition tree-affine.cc:576
bool aff_combination_constant_multiple_p(aff_tree *, aff_tree *, poly_widest_int *)
Definition tree-affine.cc:926
void aff_combination_scale(aff_tree *, const widest_int &)
Definition tree-affine.cc:90
bool aff_combination_const_p(aff_tree *aff)
Definition tree-affine.h:115
bool aff_comb_cannot_overlap_p(aff_tree *, const poly_widest_int &, const poly_widest_int &)
Definition tree-affine.cc:1045
bool aff_combination_zero_p(aff_tree *aff)
Definition tree-affine.h:102
void aff_combination_const(aff_tree *, tree, const poly_widest_int &)
Definition tree-affine.cc:69
#define MAX_AFF_ELTS
Definition tree-affine.h:27
void aff_combination_remove_elt(aff_tree *, unsigned)
Definition tree-affine.cc:589
void aff_combination_elt(aff_tree *, tree, tree)
Definition tree-affine.cc:78
tree get_inner_reference_aff(tree, aff_tree *, poly_widest_int *)
Definition tree-affine.cc:1012
tree aff_combination_to_tree(aff_tree *)
Definition tree-affine.cc:526
tree aff_combination_type(aff_tree *aff)
Definition tree-affine.h:95
bool aff_combination_singleton_var_p(aff_tree *aff)
Definition tree-affine.h:123