Skip to content

Commit aecf1c8

Browse files
author
svorenova
committed
Doc std_types cont.
1 parent 3d219c1 commit aecf1c8

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/util/std_types.h

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,7 @@ inline const c_enum_tag_typet &to_c_enum_tag_type(const typet &type)
692692
return static_cast<const c_enum_tag_typet &>(type);
693693
}
694694

695-
/// \copydoc to_enum_tag_type(const typet &)
695+
/// \copydoc to_c_enum_tag_type(const typet &)
696696
inline c_enum_tag_typet &to_c_enum_tag_type(typet &type)
697697
{
698698
PRECONDITION(type.id()==ID_c_enum_tag);
@@ -946,6 +946,8 @@ inline code_typet &to_code_type(typet &type)
946946
}
947947

948948
/// Arrays with given size
949+
///
950+
/// Used for ordinary source-language arrays.
949951
class array_typet:public type_with_subtypet
950952
{
951953
public:
@@ -1525,7 +1527,14 @@ inline const range_typet &to_range_type(const typet &type)
15251527
return static_cast<const range_typet &>(type);
15261528
}
15271529

1528-
/// The C vector type
1530+
/// The vector type
1531+
///
1532+
/// Used to represent the short vectors used by CPU instruction sets such as
1533+
/// MMX, SSE and AVX. They all provide registers that are something like
1534+
/// 8 x int32, for example, and corresponding operations that operate
1535+
/// element-wise on their operand vectors. Compared to \ref array_typet
1536+
/// that has no element-wise operators. Note that `remove_vector.h` removes
1537+
/// this data type by compilation into arrays.
15291538
class vector_typet:public type_with_subtypet
15301539
{
15311540
public:

0 commit comments

Comments
 (0)