Union type

This article needs additional citations for verification. Please help improve this article by adding citations to reliable sources. Unsourced material may be challenged and removed. Find sources: "Union type" – news · newspapers · books · scholar · JSTOR (August 2009) (Learn how and when to remove this message)

In computer science, a union is a value that may have any of multiple representations or formats within the same area of memory; that consists of a variable that may hold such a data structure. Some programming languages support a union type for such a data type. In other words, a union type specifies the permitted types that may be stored in its instances, e.g., float and integer. In contrast with a record, which could be defined to contain both a float and an integer; a union would hold only one at a time.

A union can be pictured as a chunk of memory that is used to store variables of different data types. Once a new value is assigned to a field, the existing data is overwritten with the new data. The memory area storing the value has no intrinsic type (other than just bytes or words of memory), but the value can be treated as one of several abstract data types, having the type of the value that was last written to the memory area.

In type theory, a union has a sum type; this corresponds to disjoint union in mathematics.

Depending on the language and type, a union value may be used in some operations, such as assignment and comparison for equality, without knowing its specific type. Other operations may require that knowledge, either by some external information, or by the use of a tagged union.

Because of the limitations of their use, untagged unions are generally only provided in untyped languages or in a type-unsafe way (as in C). They have the advantage over simple tagged unions of not requiring space to store a data type tag.

The name "union" stems from the type's formal definition. If a type is considered as the set of all values that that type can take on, a union type is simply the mathematical union of its constituting types, since it can take on any value any of its fields can. Also, because a mathematical union discards duplicates, if more than one field of the union can take on a single common value, it is impossible to tell from the value alone which field was last written.

However, one useful programming function of unions is to map smaller data elements to larger ones for easier manipulation. A data structure consisting, for example, of 4 bytes and a 32-bit integer, can form a union with an unsigned 64-bit integer, and thus be more readily accessed for purposes of comparison etc.

ALGOL 68 has tagged unions, and uses a case clause to distinguish and extract the constituent type at runtime. A union containing another union is treated as the set of all its constituent possibilities, and if the context requires it a union is automatically coerced into the wider union. A union can explicitly contain no value, which can be distinguished at runtime. An example is:

 mode node = union (real, int, string, void);    node n := "abc";    case n in    (real r):   print(("real:", r)),    (int i):    print(("int:", i)),    (string s): print(("string:", s)),    (void):     print(("void:", "EMPTY")),    out         print(("?:", n))  esac 

The syntax of the C/C++ union type and the notion of casts was derived from ALGOL 68, though in an untagged form.^[1]

In C and C++, untagged unions are expressed nearly exactly like structures (structs), except that each data member is located at the same memory address. The data members, as in structures, need not be primitive values, and in fact may be structures or even other unions. C++ (since C++11) also allows for a data member to be any type that has a full-fledged constructor/destructor and/or copy constructor, or a non-trivial copy assignment operator. For example, it is possible to have the standard C++ string as a member of a union.

The primary use of a union is allowing access to a common location by different data types, for example hardware input/output access, bitfield and word sharing, or type punning. Unions can also provide low-level polymorphism. However, there is no checking of types, so it is up to the programmer to be sure that the proper fields are accessed in different contexts. The relevant field of a union variable is typically determined by the state of other variables, possibly in an enclosing struct.

One common C programming idiom uses unions to perform what C++ calls a reinterpret_cast, by assigning to one field of a union and reading from another, as is done in code which depends on the raw representation of the values. A practical example is the method of computing square roots using the IEEE representation. This is not, however, a safe use of unions in general.

Structure and union specifiers have the same form. [ . . . ] The size of a union is sufficient to contain the largest of its members. The value of at most one of the members can be stored in a union object at any time. A pointer to a union object, suitably converted, points to each of its members (or if a member is a bit-field, then to the unit in which it resides), and vice versa.

— ANSI/ISO 9899:1990 (the ANSI C standard) Section 6.5.2.1

In C++, C11, and as a non-standard extension in many compilers, unions can also be anonymous. Their data members do not need to be referenced, are instead accessed directly. They have some restrictions as opposed to traditional unions: in C11, they must be a member of another structure or union,^[2] and in C++, they can not have methods or access specifiers.

Simply omitting the class-name portion of the syntax does not make a union an anonymous union. For a union to qualify as an anonymous union, the declaration must not declare an object. Example:

#include <iostream> #include <cstdint>  int main() {    union {       float f;       uint32_t d; // Assumes float is 32 bits wide    };     f = 3.14f;    std::cout << "Hexadecimal representation of 3.14f:"               << std::hex << d << '\n'; return 0; } 

Anonymous unions are also useful in C struct definitions to provide a sense of namespacing.^[3]

In compilers such as GCC, Clang, and IBM XL C for AIX, a transparent_union attribute is available for union types. Types contained in the union can be converted transparently to the union type itself in a function call, provided that all types have the same size. It is mainly intended for function with multiple parameter interfaces, a use necessitated by early Unix extensions and later re-standardisation.^[4]

In COBOL, union data items are defined in two ways. The first uses the RENAMES (66 level) keyword, which effectively maps a second alphanumeric data item on top of the same memory location as a preceding data item. In the example code below, data item PERSON-REC is defined as a group containing another group and a numeric data item. PERSON-DATA is defined as an alphanumeric data item that renames PERSON-REC, treating the data bytes continued within it as character data.

  01  PERSON-REC.       05  PERSON-NAME.           10  PERSON-NAME-LAST    PIC X(12).           10  PERSON-NAME-FIRST   PIC X(16).           10  PERSON-NAME-MID     PIC X.       05  PERSON-ID               PIC 9(9) PACKED-DECIMAL.      01  PERSON-DATA                 RENAMES PERSON-REC. 

The second way to define a union type is by using the REDEFINES keyword. In the example code below, data item VERS-NUM is defined as a 2-byte binary integer containing a version number. A second data item VERS-BYTES is defined as a two-character alphanumeric variable. Since the second item is redefined over the first item, the two items share the same address in memory, and therefore share the same underlying data bytes. The first item interprets the two data bytes as a binary value, while the second item interprets the bytes as character values.

  01  VERS-INFO.       05  VERS-NUM        PIC S9(4) COMP.       05  VERS-BYTES      PIC X(2)                           REDEFINES VERS-NUM 

In Pascal, there are two ways to create unions. One is the standard way through a variant record. The second is a nonstandard means of declaring a variable as absolute, meaning it is placed at the same memory location as another variable or at an absolute address. While all Pascal compilers support variant records, only some support absolute variables.

For the purposes of this example, the following are all integer types: a byte consists of 8 bits, a word is 16 bits, and an integer is 32 bits.

The following example shows the non-standard absolute form:

var     A: Integer;     B: array[1..4] of Byte absolute A;     C: Integer absolute 0; 

In the first example, each of the elements of the array B maps to one of the specific bytes of the variable A. In the second example, the variable C is assigned to the exact machine address 0.

In the following example, a record has variants, some of which share the same location as others:

type      Shape = (Circle, Square, Triangle);      Dimensions = record         case Figure: Shape of             Circle: (Diameter: real);            Square: (Width: real);            Triangle: (Side: real; Angle1, Angle2: 0..360)         end; 

In PL/I the original term for a union was cell,^[5] which is still accepted as a synonym for union by several compilers. The union declaration is similar to the structure definition, where elements at the same level within the union declaration occupy the same storage. Elements of the union can be any data type, including structures and array.^{[6]: pp192–193} Here vers_num and vers_bytes occupy the same storage locations.

  1  vers_info         union,      5 vers_num        fixed binary,      5 vers_bytes      pic '(2)A'; 

An alternative to a union declaration is the DEFINED attribute, which allows alternative declarations of storage, however the data types of the base and defined variables must match.^{[6]: pp.289–293}

Rust implements both tagged and untagged unions. In Rust, tagged unions are implemented using the enum keyword. Unlike enumerated types in most other languages, enum variants in Rust can contain additional data in the form of a tuple or struct, making them tagged unions rather than simple enumerated types.^[7]

Rust also supports untagged unions using the union keyword. The memory layout of unions in Rust is undefined by default,^[8] but a union with the #[repr(C)] attribute will be laid out in memory exactly like the equivalent union in C.^[9] Reading the fields of a union can only be done within an unsafe function or block, as the compiler cannot guarantee that the data in the union will be valid for the type of the field; if this is not the case, it will result in undefined behavior.^[10]

In C and C++, the syntax is:

union <name> {     <datatype>  <1st variable name>;     <datatype>  <2nd variable name>;     .     .     .     <datatype>  <nth variable name>; } <union variable name>; 

A structure can also be a member of a union, as the following example shows:

union name1 {     struct name2     {           int     a;         float   b;         char    c;     } svar;     int     d; } uvar; 

This example defines a variable uvar as a union (tagged as name1), which contains two members, a structure (tagged as name2) named svar (which in turn contains three members), and an integer variable named d.

Unions may occur within structures and arrays, and vice versa:

struct {       int flags;     char *name;     int utype;     union {         int ival;         float fval;         char *sval;     } u; } symtab[NSYM]; 

The number ival is referred to as symtab[i].u.ival and the first character of string sval by either of *symtab[i].u.sval or symtab[i].u.sval[0].

Union types were introduced in PHP 8.0.^[11] The values are implicitly "tagged" with a type by the language, and may be retrieved by "gettype()".

class Example {     private int|float $foo;      public function squareAndAdd(float|int $bar): int|float     {         return $bar ** 2 + $this->foo;     } } 

Support for typing was introduced in Python 3.5.^[12] The new syntax for union types were introduced in Python 3.10.^[13]

class Example:     foo = 0      def square_and_add(self, bar: int | float) -> int | float:         return bar ** 2 + self.foo 

Union types are supported in TypeScript.^[14] The values are implicitly "tagged" with a type by the language, and may be retrieved using a typeof call for primitive values and an instanceof comparison for complex data types. Types with overlapping usage (e.g. a slice method exists on both strings and arrays, the plus operator works on both strings and numbers) don't need additional narrowing to use these features.

function successor(n: number | bigint): number | bigint {     // types that support the same operations don't need narrowing     return ++n; }  function dependsOnParameter(v: string | Array<string> | number) {     // distinct types need narrowing     if (v instanceof Array) {         // do something     } else if (typeof(v) === "string") {         // do something else     } else {         // has to be a number     } } 

Tagged unions in Rust use the enum keyword, and can contain tuple and struct variants:

enum Foo { 	Bar(i32), 	Baz { x: String, y: i32 }, } 

Untagged unions in Rust use the union keyword:

union Foo { 	bar: i32, 	baz: bool, } 

Reading from the fields of an untagged union results in undefined behavior if the data in the union is not valid as the type of the field, and thus requires an unsafe block:

let x = Foo { bar: 10 }; let y = unsafe { x.bar }; // This will set y to 10, and does not result in undefined behavior. let z = unsafe { x.baz }; // This results in undefined behavior, as the value stored in x is not a valid bool. 

• Kernighan, Brian W.; Ritchie, Dennis M. (1978). The C Programming Language (1st ed.). Prentice Hall. p. 138. ISBN 978-0131101630. Retrieved Jan 23, 2018.

• boost::variant, a type-safe alternative to C++ unions
• MSDN: Classes, Structures & Unions, for examples and syntax
• differences, differences between union & structure
• Difference between struct and union in C++