Skip to content

Commit f313fdf

Browse files
committed
Add documentation to smallest/largest/zero methods
1 parent cbb1dee commit f313fdf

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/util/std_types.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1176,10 +1176,21 @@ class integer_bitvector_typet : public bitvector_typet
11761176
{
11771177
}
11781178

1179+
/// Return the smallest value that can be represented using this type.
11791180
mp_integer smallest() const;
1181+
/// Return the largest value that can be represented using this type.
11801182
mp_integer largest() const;
1183+
1184+
// If we ever need any of the following three methods in \ref fixedbv_typet or
1185+
// \ref floatbv_typet, we might want to move them to a new class
1186+
// numeric_bitvector_typet, which would be between integer_bitvector_typet and
1187+
// bitvector_typet in the hierarchy.
1188+
1189+
/// Return an expression representing the smallest value of this type.
11811190
constant_exprt smallest_expr() const;
1191+
/// Return an expression representing the zero value of this type.
11821192
constant_exprt zero_expr() const;
1193+
/// Return an expression representing the largest value of this type.
11831194
constant_exprt largest_expr() const;
11841195
};
11851196

0 commit comments

Comments
 (0)