Skip to content

Commit 21c98d3

Browse files
Document the assumptions of ssa_exprt
Some assumptions where implicitly made on the argument of ssa_exprt, and they were impossible to deduce from the interface and documentation.
1 parent 1e854f6 commit 21c98d3

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/util/ssa_expr.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,12 @@ class ssa_exprt:public symbol_exprt
1717
{
1818
public:
1919
/// Constructor
20-
/// \param expr: Expression to be converted to SSA symbol
20+
/// \param expr: Expression to be converted to SSA symbol. A valid argument
21+
/// must be one of these:
22+
/// - a symbol_exprt
23+
/// - a member_exprt where the accessed struct would be a valid argument
24+
/// - an index_exprt where the index is a constant and the array would be
25+
/// a valid argument
2126
explicit ssa_exprt(const exprt &expr);
2227

2328
void update_type()

0 commit comments

Comments
 (0)